id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
doc_168ca006
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides change 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/change-price/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-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/change-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/change-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/change-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/change-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/change-price/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/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/change-price/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/change-price/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/change-price/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/change-price/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/change-price/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/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/change-price/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/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/change-price/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/change-price/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/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/change-price/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/change-price/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/change-price/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/change-price/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/change-price/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/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/change-price/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/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/change-price/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/change-price/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price)\n\nChange the price of an SKU in a cart\n\nThe shopping cart is where the information on the products chosen by the customer while browsing a store is gathered. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThis guide will describe how to change the price of an SKU (item) in a cart by the API.\n\n> ️ Before starting to manually change prices on an item, make sure the [Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-the-manual-price) feature is already enabled in your store.\n\n## Getting and accessing shopping cart information\n\nThe first step is to get the `orderFormId` and access the shopping cart information that you want to change the item price. For more information, access the [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-cart-information-by-id) guide.\n\nBelow is an example of pricing details for items contained in a shopping cart:\n\n`1\n\n\"items\": [ \n\n2\n\n { \n\n3\n\n ... \n\n4\n\n \"price\": 1200000, \n\n5\n\n \"listPrice\": 1200000, \n\n6\n\n \"manualPrice\": null, \n\n7\n\n \"manualPriceAppliedBy\": null, \n\n8\n\n ... \n\n9\n\n } \n\n10\n\n... \n\n11\n\n] \n\n`\n\n> ️ For more information about the meaning of each of the fields available in the shopping cart, access the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Changing the price of a shopping cart item\n\nWith the `orderFormId` information available, you must use the [Change price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/pricechange) endpoint to send the path parameters information through the URL:\n\n* **orderFormId**: value.\n* **itemIndex**: a string indicating the index of the item in the cart. Each cart item is identified by an index, starting with `0`.\n\nSee a URL example below:\n\n`https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/36a1646105f243e1a9012c915631344b/items/0/price`\n\nAdditionally, you need to send the request body containing the new price to be applied to the item:\n\n`1\n\n{\"price\":850000} \n\n`\n\nAfter sending the request, the endpoint will return the response body with the new item price indicated by the `manualPrice` property. The identification of the user responsible for the price change is available in the `manualPriceAppliedBy` property.\n\n`1\n\n\"items\": [ \n\n2\n\n { \n\n3\n\n ... \n\n4\n\n \"price\": 1200000, \n\n5\n\n \"listPrice\": 1200000, \n\n6\n\n \"manualPrice\": 850000, \n\n7\n\n \"manualPriceAppliedBy\": “99e09db4-fc3b-4c8e-a15b-5194516”, \n\n8\n\n ... \n\n9\n\n } \n\n10\n\n... \n\n11\n\n] \n\n`\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 400 - Bad Request\n\n* **Message error example (code CHK0041)**: `\"Índice de item inválido\"` (_invalid item index_). This message indicates that the `itemIndex` used in the request does not exist or is incorrect.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK0041\", \n\n5\n\n \"message\": \"Índice de item inválido\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"8b1c2f39-641a-4ec1-ba91-b8a9d5b1cd19\" \n\n9\n\n} \n\n`\n\n### 403 - Forbidden\n\n* **Message error example (code CHK003)**: `\"Access Denied\"`. The feature **Manual Price** is not activated on your store. See how to enable it on [Enable the Manual Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/enable-the-manual-price).\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"CHK003\", \n\n5\n\n \"message\": \"Access Denied\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"4ae9e8e4-0fd1-469a-99b1-71705cbe036f\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* **Message error example**: `\"The requested URL was not found on the server\"`. Check that the URL data is correct.\n\n`1\n\n<body> \n\n2\n\n <h1>404 Not Found</h1> \n\n3\n\n <p>The requested URL was not found on this server.</p> \n\n4\n\n</body> \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides/change-price.md)\n\n[Update cart items« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price//docs/guides/update-cart-items)[Ignore profile data from cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price//docs/guides/ignore-profile-data)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Getting and accessing shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23getting-and-accessing-shopping-cart-information)\n\n[Changing the price of a shopping cart item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23changing-the-price-of-a-shopping-cart-item)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23400-bad-request)[403 - Forbidden](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23403-forbidden)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23404-not-found)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides/change-price.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting and accessing shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23getting-and-accessing-shopping-cart-information)\n\n[Changing the price of a shopping cart item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23changing-the-price-of-a-shopping-cart-item)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23400-bad-request)[403 - Forbidden](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%23403-forbidden)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-price/docs/guides/change-price%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_b7ffcdd4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides store framework 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/store-framework-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-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/store-framework-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/store-framework-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/store-framework-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/store-framework-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/store-framework-apps/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-apps/updates/release-notes)\n\nStore Framework Apps\n\nReference docs for Store Framework apps.\n\nshopping cart 2 \n\n[BASIC COMPONENTS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/basic-components) \n\nStorefront components indispensable to create an end-to-end experience for your store’s users.\n\n* [Add to cart button ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button)\n* [](https://developers.vtex.com/docs/guides/vtex-add-to-cart-button)[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-breadcrumb)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-breadcrumb)\n* [](https://developers.vtex.com/docs/guides/vtex-breadcrumb)[Footer ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer)\n* [](https://developers.vtex.com/docs/guides/vtex-store-footer)[VTEX Store Components ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components)\n* [](https://developers.vtex.com/docs/guides/vtex-store-components)[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/basic-components)\n\nbasket favorite \n\n[ADVANCED COMPONENTS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/advanced-components) \n\nNative components that enrich the user experience, but are not mandatory for your store operation.\n\n* [Category menu ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu)\n* [](https://developers.vtex.com/docs/guides/vtex-category-menu)[Checkout UI settings ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings)\n* [](https://developers.vtex.com/docs/guides/vtex-checkout-ui-settings)[Iframe ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-iframe)\n* [](https://developers.vtex.com/docs/guides/vtex-iframe)[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/advanced-components)\n\nboard 2 \n\n[LAYOUT APPS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps) \n\nAps responsible for building your store layout according to your business needs.\n\n* [Condition Layout ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-condition-layout)\n* [](https://developers.vtex.com/docs/guides/vtex-condition-layout)[Flex Layout ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-flex-layout)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-flex-layout)\n* [](https://developers.vtex.com/docs/guides/vtex-flex-layout)[Modal Layout ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-modal-layout)\n* [](https://developers.vtex.com/docs/guides/vtex-modal-layout)[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-overlay-layout)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-overlay-layout)\n* [](https://developers.vtex.com/docs/guides/vtex-overlay-layout)[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/layout-apps)\n\nplug 2 \n\n[PIXEL APPS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pixel-apps) \n\nApps that integrate a third-party solution into your store’s website.\n\n* [accessiBe ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-accessibe)\n* [](https://developers.vtex.com/docs/guides/vtex-accessibe)[Google Adwords ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-adwords)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-adwords)\n* [](https://developers.vtex.com/docs/guides/vtex-google-adwords)[Google customer reviews ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-customer-reviews)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-customer-reviews)\n* [](https://developers.vtex.com/docs/guides/vtex-google-customer-reviews)[Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager)\n[ ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-tag-manager)\n* [](https://developers.vtex.com/docs/guides/vtex-google-tag-manager)[See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pixel-apps)\n\n> Need help? Check our [Frequently Asked Questions!](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-framework-apps.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-framework-apps.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_ba86d5af
|
[
{
"role": "system",
"content": "You are a VTEX 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 checkbox 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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-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-checkbox-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-checkbox-field/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-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-checkbox-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-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-checkbox-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-checkbox-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-checkbox-field/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-overview)\n\nCheckboxField\n\nWraps a Checkbox input and its corresponding Label.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/CheckboxField)\n\nThe `CheckboxField` wraps a [Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-checkbox) input and its corresponding [Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label). It allows users to select one option from a set.\n\nExample\n\nCode\n\nDefault\n\nChecked\n\nDisabled\n\nChecked & Partial\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { CheckboxField } 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/CheckboxField/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-checkbox-field-gap | var(--fs-spacing-1) |\n\n---\n\n## Data attributes\n\nYou can target and override `CheckboxField` styles using the following data attributes:\n\n`data-fs-checkbox-field`\n\n---\n\n## Props\n\n| Name | Type | Description | Default | |\n| ------------- | ----------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------- | ------ |\n| **label\\*** | string | The text displayed to identify the input checkbox. | | |\n| **error** | string | The error message is displayed when an error occurs. | | |\n| **alignment** | \"center\" \\| \"top\" | \"bottom\" | Control the vertical alignment of the checkbox in relation to the label (center, top, bottom). | center |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-checkbox-field | |\n| **partial** | false \\| true | Boolean that represents a partial state. | | |\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/checkbox-field.mdx)\n\n[CartItem« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-cart-item)[DiscountBadgeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-discount-badge)\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-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-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/checkbox-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-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23design-tokens)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-checkbox-field/docs/guides/faststore/molecules-checkbox-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_4b4e4894
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides discounts in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/discounts)\n\n[Set a discount using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/set-a-discount-using-the-checkout-api)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/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/discounts/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/discounts)\n\n[Set a discount using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/set-a-discount-using-the-checkout-api)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/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/discounts/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/discounts/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/checkout-api-overview)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts/docs/guides/discounts)\n\nDiscounts\n\nThis section contains articles on managing discounts for items in Checkout. Here you will find the following articles:\n\n* [Set a discount using the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/set-a-discount-using-the-checkout-api)\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/discounts.md)\n\n[Enable an Observation field on the Checkout page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts//docs/guides/enable-an-observation-field-on-the-checkout-page)[Set a discount using the Checkout APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/discounts//docs/guides/set-a-discount-using-the-checkout-api)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/discounts.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_0b6ac093
|
[
{
"role": "system",
"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 seller fulfillment 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-seller-fulfillment/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-seller-fulfillment/docs/api-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-seller-fulfillment/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-seller-fulfillment/docs/storefront-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-seller-fulfillment/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-seller-fulfillment/docs/troubleshooting)\n\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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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-seller-fulfillment/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_082664c2
|
[
{
"role": "system",
"content": "You are a VTEX 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 orders management filters in 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/using-orders-management-filters-in-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-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/using-orders-management-filters-in-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/using-orders-management-filters-in-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/using-orders-management-filters-in-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/using-orders-management-filters-in-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/using-orders-management-filters-in-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/actions-orders)\n\n[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/get-marketplace-data-orders-api)\n\n[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/get-payment-data-mercado-libre-orders-api)\n\n[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/formatting-order-invoicing-time)\n\n[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/using-orders-management-filters-in-api)\n\n[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/adding-a-second-address-to-the-order)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-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/using-orders-management-filters-in-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/using-orders-management-filters-in-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/actions-orders)\n\n[Fetching marketplace information with the Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/get-marketplace-data-orders-api)\n\n[Fetching payment details from a Mercado Libre order with Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/get-payment-data-mercado-libre-orders-api)\n\n[Formatting order invoicing time via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/formatting-order-invoicing-time)\n\n[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/using-orders-management-filters-in-api)\n\n[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/adding-a-second-address-to-the-order)\n\nSubscriptions\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-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/using-orders-management-filters-in-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/using-orders-management-filters-in-api/docs/guides)\n\nOrders\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/actions-orders)\n\n[Using VTEX Admin filters on orders via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api/docs/guides/using-orders-management-filters-in-api)\n\nUsing VTEX Admin filters on orders via API\n\nThis article explains how to use the VTEX Admin Order Management filters via the [List orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/listorders) API:\n\n**GET** \\- `https://{accountName}.{environment}.com.br/api/oms/pvt/orders`\n\nTo apply VTEX Admin filters via API, follow the steps below:\n\n1. Access your VTEX Admin in **Orders > Order Management > All Orders**.\n2. Click on the filters icon.\n\n\n\n1. Select the filter you want to apply and click `Confirm`. You can combine multiple filters.\n\n\n\n1. After selecting the filters, copy the URL generated in your browser.\n2. Using an [URL decoder](https://read.calvincode.net/reader?url=http://meyerweb.com/eric/tools/dencoder/) tool, decode the URL so that It will look like the following example:\n\n\n\n1. Copy only the URL extension after the question mark `?`. \n> For example: `orderBy=creationDate,desc&page=1&f_creationDate=creationDate:[2022-10-01T03:00:00.000Z TO 2022-11-01T02:59:59.999Z]&f_status=$$ALL_VALUES$$`\n2. In your browser, insert the API [List orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/listorders) path (`https://{accountName}.{environment}.com.br/api/oms/pvt/orders`) followed by the URL excerpt from last step. \n> For example: `https://{accountName}.{environment}.com.br/api/oms/pvt/orders?orderBy=creationDate,desc&page=1&f_creationDate=creationDate:[2022-10-01T03:00:00.000Z TO 2022-11-01T02:59:59.999Z]&f_status=$$ALL_VALUES$$`\n3. Click on `Enter`.\n\n> You can use pagination and determine the number of orders per page by adding the parameters `_&page=1&per_page=15_` at the end of your URL. The `page=1` means accessing the first page, and `per_page=15` means 15 orders on each page. You can change it as you wish, up to the limit of 30 pages.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Orders/actions-orders/using-orders-management-filters-in-api.md)\n\n[Formatting order invoicing time via API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api//docs/guides/formatting-order-invoicing-time)[Adding a second address for invoicing an orderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-orders-management-filters-in-api//docs/guides/adding-a-second-address-to-the-order)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Orders/actions-orders/using-orders-management-filters-in-api.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_acd282c9
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides updating sku specifications with catalog 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/updating-sku-specifications-with-catalog-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-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/updating-sku-specifications-with-catalog-api/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/catalog-integration)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/updating-sku-specifications-with-catalog-api)\n\nUpdating SKU Specifications with Catalog API\n\nIn our Catalog, [specifications](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP%23) are created in the category level. Products and SKUs inherit their specifications from the category they are placed in and all its parent categories. This may lead to some confusion when using our API to create and update SKUs.\n\nIn this article, we share a few tips to help you update an [SKU Specification](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP%23sku-specifications).\n\n### SKU and its Specification\n\nFirst, you need to select an SKU and its Specification to update. If you don’t know the Specifications of the SKU, use the [Get SKU Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/specification) endpoint. It will retrieve all Specifications indexed on the SKU.\n\nIn the example below, we show what the response would look like if your SKU had two specifications to fill in:\n\n* Color (`\"FieldId\": 271`)\n* Size (`\"FieldId\": 40`)\n\nIf needed, you would be able to get more information about each specification using the [Get Specification Field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/specification/fieldGet/-fieldId-) endpoint.\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"Id\": 472, \n\n4\n\n \"SkuId\": 17784, \n\n5\n\n \"FieldId\": 271, \n\n6\n\n \"FieldValueId\": null, \n\n7\n\n \"Text\": \"\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"Id\": 528, \n\n11\n\n \"SkuId\": 17784, \n\n12\n\n \"FieldId\": 40, \n\n13\n\n \"FieldValueId\": 147, \n\n14\n\n \"Text\": \"L\" \n\n15\n\n } \n\n16\n\n] \n\n`\n\n> Notice that the response body from this endpoint is an array but you can’t update all at once. You can update only one SKU Specification at a time.\n\n### Knowing the `FieldValueId`\n\nAfter selecting the one Specification to update, use the [Get Specifications Values By Field Id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/specification/fieldvalue/-fieldId-) endpoint. It allows you to know all the possible values from this Specification as you can only update the `FieldValueId` from an SKU Specification.\n\nIn the example below, we show what the response would look like if your specification had three possible values:\n\n* S (`\"FieldValueId\": 144`)\n* M (`\"FieldValueId\": 145`)\n* L (`\"FieldValueId\": 146`)\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"FieldValueId\": 144, \n\n4\n\n \"Value\": \"S\", \n\n5\n\n \"IsActive\": true, \n\n6\n\n \"Position\": 1 \n\n7\n\n }, \n\n8\n\n { \n\n9\n\n \"FieldValueId\": 145, \n\n10\n\n \"Value\": \"M\", \n\n11\n\n \"IsActive\": true, \n\n12\n\n \"Position\": 2 \n\n13\n\n }, \n\n14\n\n { \n\n15\n\n \"FieldValueId\": 147, \n\n16\n\n \"Value\": \"L\", \n\n17\n\n \"IsActive\": true, \n\n18\n\n \"Position\": 3 \n\n19\n\n } \n\n20\n\n] \n\n`\n\n### Updating the SKU Specification `FieldValueId`\n\nFinally, use the [Update SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-/specification) endpoint to change the `FieldValueId` from the SKU Specification to the desired new value.\n\n> SKU Specifications can only have the `FieldType` as `5`(Combo) or `6`(Radio). You cannot change the `Text` field without updating the `FieldValueId`. After this update, the `Text` field will be automatically modified.\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/updating-sku-specifications-with-catalog-api.md)\n\n[SKU specifications« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api//docs/guides/sku-specifications)[SKUsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api//docs/guides/skus)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[SKU and its Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/updating-sku-specifications-with-catalog-api%23sku-and-its-specification)\n\n[Knowing the FieldValueId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/updating-sku-specifications-with-catalog-api%23knowing-the-fieldvalueid)[Updating the SKU Specification FieldValueId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/updating-sku-specifications-with-catalog-api%23updating-the-sku-specification-fieldvalueid)\n\nWas this helpful?\n\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/updating-sku-specifications-with-catalog-api.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[SKU and its Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/updating-sku-specifications-with-catalog-api%23sku-and-its-specification)\n\n[Knowing the FieldValueId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/updating-sku-specifications-with-catalog-api%23knowing-the-fieldvalueid)[Updating the SKU Specification FieldValueId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/updating-sku-specifications-with-catalog-api/docs/guides/updating-sku-specifications-with-catalog-api%23updating-the-sku-specification-fieldvalueid)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b05b93a2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides add client profile in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart)\n\nAdding customer profile information to the cart\n\nThe shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThis guide will describe how to add customer profile information to the shopping cart via API.\n\n## Getting shopping cart information\n\nThe first step is to get the `orderFormId` of the shopping cart to which you want to add the customer preferences information. For more information, read the [Getting cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id) guide.\n\n## Adding customer profile information to the shopping cart\n\nTo add customer profile information to the shopping cart, use the [Add client profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/attachments/clientProfileData) endpoint. In this request, you must send the `orderFormId` through the URL address, as shown in the example below:\n\n`https://{accountName}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/attachments/clientProfileData`\n\nAdditionally, you need to send the request body containing the following customer information:\n\n* **Required**: \n * `email`: Customer email address. \n * `firstName`: Customer first name. \n * `lastName`: Customer last name. \n * `documentType`: Type of document provided by the customer (e.g., CPF in Brazil, SSN in the U.S.). \n * `document`: Document number provided by the customer.\n* **Recommended (optional)**: \n * `phone`: Customer phone number.\n* **If the client is a legal entity**: \n * `corporateName`: Company name. \n * `tradeName`: Trade name. \n * `corporateDocument`: Corporate document. \n * `stateInscription`: State document number. \n * `corporatePhone`: Business phone number. \n * `isCorporate`: `True`.\n\nAfter sending the request, the endpoint will return the response body containing the client information in the shopping cart, as in the example below:\n\n`1\n\n... \n\n2\n\n\"clientProfileData\": { \n\n3\n\n \"email\": \"customer@examplemail.com\", \n\n4\n\n \"firstName\": \"first-name\", \n\n5\n\n \"lastName\": \"last-name\", \n\n6\n\n \"document\": \"123456789\", \n\n7\n\n \"documentType\": \"cpf\", \n\n8\n\n \"phone\": \"+55110988887777\", \n\n9\n\n \"corporateName\": \"company-name\", \n\n10\n\n \"tradeName\": \"trade-name\", \n\n11\n\n \"corporateDocument\": \"12345678000100\", \n\n12\n\n \"stateInscription\": \"12345678\", \n\n13\n\n \"corporatePhone\": \"+551100988887777\", \n\n14\n\n \"isCorporate\": false, \n\n15\n\n \"profileCompleteOnLoading\": false, \n\n16\n\n \"profileErrorOnLoading\": false, \n\n17\n\n \"customerClass\": null \n\n18\n\n } \n\n19\n\n... \n\n`\n\n> ️ For more information on each field available in the shopping cart, see the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 400 - Bad Request\n\n* **Message error example (code ORD002)**: `\"Invalid order form\"`. The `orderFormId` information is not valid.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD002\", \n\n5\n\n \"message\": \"Invalid order form\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \n\n9\n\n} \n\n`\n\n* **Message error example (code ORD007)**: `\"The email field in the customer profile attachment is invalid\"`: This message indicates that the `email` used in the request does not exist or is incorrect.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD007\", \n\n5\n\n \"message\": \"The email field in the customer profile attachment is invalid\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"37fcbaf6-9245-46b2-8735-f5fb304d1ac2\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* **Message error example**: `\"The requested URL was not found on the server\"`: Check if the URL is correct.\n\n`1\n\n<body> \n\n2\n\n <h1>404 Not Found</h1> \n\n3\n\n <p>The requested URL was not found on this server.</p> \n\n4\n\n</body> \n\n`\n\nContributors\n\n1\n\n[](https://github.com/GeorgeLimaDev)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-quick-start-guides/add-customer-profile-information-to-the-cart.md)\n\n[Getting a customer profile by email« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile//docs/guides/getting-a-customer-profile-by-email)[Add shipping address and select delivery optionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile//docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\nContributors\n\n1\n\n[](https://github.com/GeorgeLimaDev)\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding customer profile information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23adding-customer-profile-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23404-not-found)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-quick-start-guides/add-customer-profile-information-to-the-cart.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding customer profile information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23adding-customer-profile-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile/docs/guides/add-customer-profile-information-to-the-cart%23404-not-found)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d279055d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides erp integration import products in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides)\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-guide)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products)\n\nImport products\n\nIn this step, you will send all product information from your ERP or PIM to VTEX.\n\n> While this article provides the basic flow of integration, we recommend you check the implementation details provided on our [Product integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products) and [SKU integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus), as well as the links in each **Learn more** section below.\n\n## Before you begin\n\nBefore importing all your products and SKUs to VTEX it is very important to think about how you plan to display variations in your shelves and product pages. In some cases, it might be useful to split similar SKUs into different products, in others you might want to group them under the same product.\n\nIn VTEX, a **Product** is the abstract catalog unit that is displayed to buyers when they browse your store. An **SKU**, on the other hand, is the concrete catalog unit that is held in stock and represents the different variations (color, size and anything else) buyers can choose from.\n\nIn other words, Products are displayed on shelves, while SKUs are displayed on product pages.\n\nAnother factor that needs to be taken into account is the selection of images to represent your catalog. High quality images might make a product more appealing, but their size may also negatively impact page loading time. Planning and organizing your product assets is extremely important.\n\nFinally, **Trade Policies** are used in VTEX to differentiate the catalog, prices and logistics settings for each sales channel connected to your store. In general you will add all your products to the main trade policy (used by your store) and optionally include other trade policies to expose specific products to other marketplaces.\n\nAgain, it is all about offering a great navigation experience to buyers, with fast page loading, detailed product pages and amazing visuals. If you would like a conceptual overview of our Catalog, check out the [beginner track](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3rA2tTpIoEXdv2nzC27zxR) in our Help Center.\n\n## Import product\n\nVTEX provides three different ways to register products in the catalog:\n\n1. API Integration: Read our [Catalog getting started guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview) for an overview of the integration flow. Find the collection with all available methods on [Catalog API Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview).\n2. Spreadsheet: \n * Google Drive Import: Import the catalog from a single Google Drive file. See the [Google Drive Import app details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x). \n * Classic Method: Import the catalog using multiple files (Product, SKU, Specification, Image).\n3. Manual input: Load Catalog data manually on VTEX Admin, as described in our [Catalog 101 track](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/1ROhz3Y7mfSMmCO1I1GxEL).\n\nIn order to import your products, it is possible that you have to use more than one method, depending on how the data is structured and what types of software are used in your operation. Usually, a combination of [API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview) and [Google Drive Import app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-drive-import@0.x) works best. Below you can see some of the use cases and choose the processes that best fit your needs.\n\n> It is worth noting that product information in ERPs is often not suitable to be used and displayed in an ecommerce. Because of that it needs to go through an enrichment process, which may include restructuring categories and creating more descriptive and appealing description texts, for example.\n\n### Scenarios and examples\n\nSee below some product import flow examples given backend scenarios that differ in information availability.\n\n#### Backend provides basic information\n\nInformation availability:\n\n* Name (possibly not ecommerce friendly)\n* Reference code\n* Brand\n* No category\n\nProduct import steps:\n\n1. Backend sends new product/sku to VTEX associated with a [mock category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23category-migration-from-erps) called **Integration**. \n> If brands are not available, you may do the same, creating a mock brand called **Integration**, for products to be enriched later.\n2. Store team uses the [Google Sheets method](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/google-import) or Admin to manually enrich the imported catalog information, assigning the correct categories to each product in the **Integration** category. \n> Make sure the **Integration** category is inactive, so that the incomplete products are not displayed in the store.\n\n#### Backend provides categories\n\nInformation availability:\n\n* Name (possibly not ecommerce friendly)\n* Reference code\n* Brand\n* Category\n* SKU dimensions\n* Image\n* Price\n* Inventory\n\nProduct import steps:\n\n1. Backend [sends new product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products) or [SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus) to VTEX.\n2. Backend [sends product image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images).\n3. Backend [sends price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices).\n4. Backend [sends inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-inventory).\n\n#### Backend provides enriched information\n\nInformation availability:\n\n* Name (possibly not ecommerce friendly)\n* Reference code\n* Brand\n* Category\n* SKU dimensions\n* Product and SKU specifications\n* Image\n* Price\n* Inventory\n\nProduct import steps:\n\n1. ERP [sends new product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products) or [SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus) to VTEX.\n2. ERP [sends product images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/images).\n3. ERP or PIM sends the product or SKU [specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications).\n4. ERP [sends price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices).\n5. ERP [sends inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-inventory).\n\nThese are just a couple of convenient examples, it may be the case that you run all your catalog integration and updates with the Google sheet import method. In order to set up the best method for your store, see some more details below.\n\n#### Google Sheets import\n\nSome characteristics that may indicate that Google Sheets import is your best option:\n\n* Your operation does not have a large and/or experienced technical team.\n* Your selection of products and SKUs do not change often.\n\n#### API product import\n\nTo add a product to a category in your catalog, you should use the [Create Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/product) endpoint in the Catalog API.\n\nYou can use the [Get Product by Id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/product/-productId-) endpoint or visit the _Products > Catalog > Products and SKUs_ section of your Admin panel to check on your progress.\n\n> After importing any product be sure to save the `id` returned by VTEX. You are going to need it whenever you want to make changes to that specific product. If you have internal product codes, such as REFIDs, make sure to save each `id` associated with the corresponding REFID in your data base.\n\n> See more details on our [Product integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products).\n\n## Import Product Specifications\n\nTo fill in the product specifications for a product in your catalog, you should use the [Create Product Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/product/-productId-/specification) endpoint in the Catalog API.\n\nYou can use the [Get Product Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/-productId-/specification) endpoint to check on your progress. Alternatively, you can find the Product Specifications for the Product you're interested in by following the steps below:\n\n1. Open the _Products > Catalog > Products and SKUs_ section of your Admin panel;\n2. Find the Product you are working on by using search/filters or scrolling down the list;\n3. In the _Edit_ column, click on the _Update_ button corresponding to that product;\n4. Click on the _Specifications_ tab to open the corresponding panel;\n5. You should now be able to see the Product Specifications you filled in for that Product.\n\n> See more details on our [Product specification integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/product-specifications).\n\n## Add Product to Trade Policy\n\nAll products need to be linked to the main trade policy in order to be displayed in your VTEX store. You may also link products to other trade policies you create to expose them in other sales channels, such as external marketplaces.\n\nTo add a Product to a Trade Policy, you should use the [Associate Product with Trade Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/product/-productId-/salespolicy/-tradepolicyId-) endpoint in the Catalog API. To undo that action, use the [Remove Product from Trade Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/product/-productId-/salespolicy/-tradepolicyId-) endpoint.\n\nYou can use the **Get Trade Policies Linked to Product** endpoint to check on your progress. Alternatively, you can enable/disable trade policies for the Product you're interested in by following the steps below:\n\n1. Open the _Products > Catalog > Products and SKUs_ section of your Admin panel;\n2. Find the Product you are working on by using search/filters or scrolling down the list;\n3. In the _Edit_ column, click on the _Update_ button corresponding to that product;\n4. You should now be able to see the Trade Policies you linked to that Product.\n\n> The ID of the main trade policy is always 1, but you can use the [Get Sales Channel List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/saleschannel/list) endpoint in the Catalog API to get more information on the trade policies that are available in your store. To enable a new trade policy, follow the instructions provided in our [Help Center article](https://read.calvincode.net/reader?url=https://help.vtex.com/faq/how-to-configure-a-new-trade-policy--frequentlyAskedQuestions%5F700?locale=en).\n\n## Import SKU\n\nTo add an SKU to a Product in your catalog, you should use the [Create SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit) endpoint in the Catalog API.\n\nYou can use the [Get SKU list by Product Id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitByProductId/-productId-) endpoint or visit the _Products > Catalog > Products and SKUs_ section of your Admin panel to check on your progress.\n\n> See more details on our [SKU integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus).\n\n## Import SKU Specifications\n\nTo fill in the SKU specifications for an SKU in your catalog, you should use the [Create SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/specification) endpoint in the Catalog API.\n\nYou can use the [Get SKU Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/specification) endpoint to check on your progress. Alternatively, you can find the SKU Specifications for the SKU you're interested in by following the steps below:\n\n1. Open the _Products > Catalog > Products and SKUs_ section of your Admin panel;\n2. Find the Product that includes the SKU you are working on in the Product list;\n3. In the _Edit_ column, click on the dropdown button and select _Sku_;\n4. Find the SKU you are working on in the SKU list;\n5. In the _Edit_ column, click on the _Change_ button;\n6. Click on the _Specifications_ tab to open the corresponding panel;\n7. You should now be able to see the SKU Specifications you filled in for that SKU.\n\n> See more details on our [SKU specifications integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sku-specifications).\n\n## Import SKU Image\n\nAn image is needed in order to activate an SKU. To add an image to an SKU, you should use the [Create SKU File](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file) endpoint in the Catalog API.\n\nYou can use the [Get SKU File](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/file) endpoint to check on your progress. Alternatively, you can find the SKU Images for the SKU you're interested in by following the steps below:\n\n1. Open the _Products > Catalog > Products and SKUs_ section of your Admin panel;\n2. Find the Product that includes the SKU you are working on in the Product list;\n3. In the _Edit_ column, click on the dropdown button and select _Sku_;\n4. Find the SKU you are working on in the SKU list;\n5. In the _Edit_ column, click on the _Change_ button;\n6. Click on the _Images_ tab to open the corresponding panel;\n7. You should now be able to see the SKU Images you added to that SKU.\n\n> See more details on our [Catalog images integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products).\n\n## Wrapping up\n\nIf you have done things correctly, you should have imported all your products and their information to your catalog. This includes the Products, Product Specifications, SKUs, SKU Specifications and Images.\n\n> When registering products through ERP in a store's catalog, you may notice that the integration might not work at first. Instead, the API might return a `Timeout` error. Sometimes the answer lies in a simple system issue, regardless of whether or not the integration was correctly configured. In other cases, the error occurs because of a coding problem. No matter the scenario, `Timeout` is a way for the system to inform the user that command took more time than expected to complete the required task. Even though it is considered an \"error\", getting a `Timeout` is foreseen within the integration flow. Because of this, the code should envision retries. If this happens, repeat the product registration process normally. If, even by doing so, the problem still persists, seek the assistance of our support team to evaluate the situation.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/erp-integration-import-products.md)\n\n[Set up order integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products//docs/guides/erp-integration-set-up-order-integration)[Set up order processingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products//docs/guides/erp-integration-set-up-order-processing)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23before-you-begin)\n\n[Import product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-product)\n\n[Scenarios and examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23scenarios-and-examples)\n\n[Import Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-product-specifications)\n\n[Add Product to Trade Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23add-product-to-trade-policy)\n\n[Import SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-sku)\n\n[Import SKU Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-sku-specifications)\n\n[Import SKU Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-sku-image)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23wrapping-up)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/erp-integration-import-products.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23before-you-begin)\n\n[Import product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-product)\n\n[Scenarios and examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23scenarios-and-examples)\n\n[Import Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-product-specifications)\n\n[Add Product to Trade Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23add-product-to-trade-policy)\n\n[Import SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-sku)\n\n[Import SKU Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-sku-specifications)\n\n[Import SKU Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23import-sku-image)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products/docs/guides/erp-integration-import-products%23wrapping-up)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e268f402
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX store components 3.178.5 ProductPrice app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/vtex-io-apps)\n\nProduct Price\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\n\n\n> Warning\n> \n> **The Product Price block has been deprecated in favor of the [Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-price) app**. Although support for this block is still granted, we strongly recommend you to update your store theme with the Product Price's blocks in order to keep up with the component's evolution.\n\nThe `product-price` component is responsible for **displaying the price** of a given product.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-price` block to any child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"product-price\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `product-price` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"product-price\": { \n\n2\n\n \"props\": { \n\n3\n\n \"showSavings\": true, \n\n4\n\n \"showListPrice\": false \n\n5\n\n } \n\n6\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------------------- | ------- | ---------------------------------------------------------------------------------------- | ------------- |\n| blockClass | String | The set value functions as a customization identifier for any CSS specified in the block | null |\n| labelListPrice | String | Product list price label | null |\n| labelSellingPrice | String | Product selling price label | null |\n| sellingPrices | Array | Product list of selling prices | \\[\\] |\n| showInstallments | Boolean | Set visibility of installments | false |\n| showLabels | Boolean | Set visibility of labels | true |\n| showListPrice | Boolean | Set visibility of list price | true |\n| showListPriceRange | Boolean | Set visibility of list price range | false |\n| showSavings | Boolean | Set visibility of savings | false |\n| showSellingPriceRange | Boolean | Set visibility of selling price range | 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| price\\_className |\n| price\\_installment |\n| price\\_installmentContainer |\n| price\\_interestRate |\n| price\\_listPrice |\n| price\\_listPriceContainer |\n| price\\_listPriceLabel |\n| price\\_listPriceRange |\n| price\\_loader |\n| price\\_savings |\n| price\\_savingsContainer |\n| price\\_sellingPrice |\n| price\\_sellingPriceContainer |\n| price\\_sellingPriceLabel |\n| price\\_sellingPriceRange |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/apps/vtex.store-components@3.178.5/ProductPrice%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/apps/vtex.store-components@3.178.5/ProductPrice%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductPrice/docs/apps/vtex.store-components@3.178.5/ProductPrice%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_93cd5645
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides cross border custom urls 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/cross-border-custom-urls-1/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-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/cross-border-custom-urls-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/cross-border-custom-urls-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/cross-border-custom-urls-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/cross-border-custom-urls-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/cross-border-custom-urls-1/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/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/cross-border-custom-urls-1/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/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/cross-border-custom-urls-1/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/cross-border-custom-urls-1/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/checking-your-stores-binding-id)\n\n[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\n[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/cross-border-custom-urls-1)\n\n[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)\n\n[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/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/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/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/cross-border-custom-urls-1/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/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/cross-border-custom-urls-1/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/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/cross-border-custom-urls-1/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/cross-border-custom-urls-1/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/checking-your-stores-binding-id)\n\n[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)\n\n[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/cross-border-custom-urls-1)\n\n[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)\n\n[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/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/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/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/cross-border-custom-urls-1/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/cross-border-custom-urls-1)\n\nCross-border store content internationalization\n\nIf you're familiar with the [multidomain](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-multi-store-multi-domain--tutorials%5F510?locale=en) concept, you know that, in VTEX, an account with multiple bindings, and different sales channels for each one of its local stores characterizes a cross-border store.\n\nHowever, each one of these local stores can also have the necessity for translations into multiple languages. For example, a Canadian store binding may need a French or an English version of its website.\n\nAs each store of a VTEX account in a multidomain environment is independent, content internationalization, as presented in the [Multi-Language stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-multi-language-stores) guide, is handled mostly the same way as for a VTEX account with a single store.\n\nMoreover, cross-border stores that share the same catalog can also have their catalog URLs translated into other languages. In the following section, we present this feature.\n\n## Translatable URLs\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/rewriter) is the VTEX IO app responsible for managing product, search, and navigation routes - client-side defined routes related to VTEX IO custom paths and pre-defined templates, such as [department](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store/blob/master/store/routes.json%23L27), [brand](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store/blob/master/store/routes.json%23L21), and [category](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store/blob/master/store/routes.json%23L33) routes.\n\n> To learn more about Routes in VTEX IO, please follow [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-routes).\n\nThe main objective of this app is to make it possible to render requested pages based on shorter rewritten URLs. For example, a route such as `http://{storename}.com/_v/segment/routing/vtex.store@2.x/product/3/blouse/p` can be understood by its canonical `http://{storename}.com/blouse/p`.\n\nNotice that the canonical path is a unique string that contains the route's shortest absolute path. Its usage allows not only more friendly URLs but also better SEO ranking.\n\nHence, whenever a request is made in any VTEX IO website, the requested URL is decomposed into parameters, which are interpreted by the Rewriter app and forwarded to the proper rendering pipeline.\n\nSince every route stored in the Rewriter app carries additional related data, such as the respective `binding` in which it is available, the way VTEX IO handles routing allows setting personalized URLs for each local store.\n\nThat means cross-border stores can also have their catalog URLs translated into other languages. For example, a cross-border store that operates in the USA and Argentina, sharing the same catalog, could have two different slugs for the same product: one in English and the other in Spanish.\n\nHence, a product registered under the `yellow-dress` slug, for example, as in `http://{storename}.com/us/yellow-dress/p`, could have its slug translated to `vestido-amarillo`, as in `http://{storename}.com/ar/vestido-amarillo/p`.\n\n> Keep in mind that catalog URLs translations are accepted for each `binding`, not for a single multi-language store.\n\n> To learn how to translate a catalog URL, please follow this [guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-internationalization).\n\nBy sending the desired URL translation via the right GraphQL mutation to the Catalog API, an alias of the main route is automatically created in the Rewriter app.\n\nThese aliases are stored in the `resolveAs` field of its related internal route.\n\nHence, considering the previous example, the route `/yellow-dress` in the Argentine binding would have an alias route `/vestido-amarillo` stored in its `resolveAs` field.\n\nBesides internal routes, the Rewriter app also manages redirects, which are custom paths a route should also resolve to. Therefore, redirects can also be part of your store's internationalization strategy.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-cross-border-stores/cross-border-custom-urls-1.md)\n\n[Creating robots files for cross-border stores« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1//docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)[Managing landing pages in cross-border storesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1//docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Translatable URLs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/cross-border-custom-urls-1%23translatable-urls)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-cross-border-stores/cross-border-custom-urls-1.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Translatable URLs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1/docs/guides/cross-border-custom-urls-1%23translatable-urls)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d5138f91
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides master data 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/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/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/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/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/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/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/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/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/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/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/master-data-v1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/master-data-v1/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/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/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/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/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/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/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/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/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/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/master-data-v1/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v1/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v1/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v1/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v1/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v1/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/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/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/master-data-v1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/master-data-v1/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/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/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/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/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/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/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/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/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/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/master-data-v1/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v1/docs/guides/master-data)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v1/docs/guides/master-data-v1)\n\nMaster Data v1\n\nLearn how to use Master Data v1 with these step-by-step guides.\n\n[Querying documents in Master Data v1Learn how queries in VTEX Master Data v1 workSee more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1)[Search and scroll API queriesLearn the main differences between search and scroll endpoints.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/extracting-data-from-master-data-with-search-and-scroll)[Setting Up Newsletter opt-in with Master Data v1Learn how to configure newsletter subscriptions with Master Data v1.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1)[Uploading files to Master Data v1Learn how to upload files to Master Data v1.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/uploading-files-to-master-data-v1)\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/master-data-v1.md)\n\n[Setting up an auto increment field in Master Data v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v1//docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)[Querying documents in Master Data v1Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-v1//docs/guides/querying-documents-in-master-data-v1)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v1/master-data-v1.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_ce2c2393
|
[
{
"role": "system",
"content": "You are a VTEX 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 faststore api 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/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-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/faststore-api-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-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/faststore-api-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-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/faststore-api-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/faststore-api-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-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/faststore-api-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/faststore-api-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-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/faststore-api-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-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/faststore-api-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/faststore-api-overview)\n\n[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-queries)\n\n[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-mutations)\n\n[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-objects)\n\n[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-inputs)\n\n[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-enums)\n\n[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-scalars)\n\n[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-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/faststore-api-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/faststore-api-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/faststore-api-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore)\n\nFastStore API\n\nFastStore API is an interface between your ecommerce platform and your store's frontend. It uses **[GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/)**, a query language for APIs and a runtime for fulfilling queries, to deliver structured data from everyday ecommerce tasks to frontend components.\n\nThe FastStore API allows you to obtain all the information you need for a given page, and customize your query to get exactly the data you need. With the FastStore API, you can:\n\n* Retrieve product information.\n* Add items to the cart.\n* Apply promotions to products.\n* Filter search results.\n\nAlso, thanks to a type-safe GraphQL protocol, the FastStore API allows developers to retrieve only the strongly typed data needed for building robust and responsive solutions. In practice, developers can integrate the FastStore API with the [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/) data layers and consume it on frontend components to create stores.\n\nData Layer\n\nData Source\n\nSource data\n\nSource data\n\nSource data\n\nQuery data\n\nFastStore Core\n\nCMS API \n Headless CMS\n\nFastStore API \n Ecommerce Platform\n\nStatic Data \n YAML, JSON, CSV\n\nReact Components\n\n> To learn more about GraphQL and its main concepts, visit the official [GraphQL website](https://read.calvincode.net/reader?url=https://graphql.org/).\n\n## Going beyond\n\nFor advanced use cases, it is also possible to use the [API extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview) feature to enhance your GraphQL schema, accommodating custom data requirements and retrieving data not natively available. Following these best practices helps to maintain your site's performance at optimal levels.\n\n* **[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-api-schema):** Extend VTEX and third-party APIs to customize how your store manages and processes data.\n* **[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments):** Extend GraphQL queries using fragments in FastStore API extension to add custom fields to predefined queries.\n* **[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-consuming-api-extensions):** Consume FastStore API extension data with custom components, such as [Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) and [Override components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overriding-components-and-props%23override-native-components-props).\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/faststore-api/overview.mdx)\n\n[Implementing Live Shopping for FastStore previous versions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions)[QueriesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-queries)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Going beyond](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/faststore-api-overview%23going-beyond)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/faststore-api/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Going beyond](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/faststore-api-overview%23going-beyond)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_7b6510b6
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides master data introduction in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data)\n\nMaster Data\n\nMaster Data is a native key-document database with a powerful search engine to enable users to store, search, expand and personalize their data. Master Data is a distributed database solution with low latency access, which enables the implementation of stores all around the world. To enable this level of access and other features, Master Data has some requirements on how it works, which are explained by some of the articles of this section.\n\n## What you will find in this section?\n\nThe table below shows each subsection with a small description of their respective contents.\n\n| Subsection | Description |\n| ----------------------------------------------------- | -------------------------------------------------------- |\n| [How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-how-it-works) | Fundamentals of Master Data. |\n| [Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-v2-guides) | Master Data tutorials for different purposes. |\n| [Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/getting-started-1) | Basic how-to guides to get you started with Master Data. |\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.md)\n\n[Checkout error codes« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction//docs/guides/checkout-error-codes)[Understanding Master DataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction//docs/guides/understanding-master-data)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[What you will find in this section?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data%23what-you-will-find-in-this-section)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you will find in this section?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data%23what-you-will-find-in-this-section)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_6e07ed67
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex b2b organizations in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/updates/release-notes)\n\nB2B Organizations\n\n> ️ The **B2B Organizations** app is part of the VTEX [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) solution: a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships. We recommend using it alongside the other apps in this suite to ensure that all features work as expected.\n\nIn the B2B model, sales goals go beyond achieving a high conversion rate. They include simplifying the relationship between companies, reducing costs, and increasing performance by delivering the best possible shopping experience to customers.\n\nB2B commerce relations are usually complex and often require a customized service. In this scenario, it is common to group various users from the same company under an organization and define custom payment methods, product selections, and prices for each customer. These tasks are part of the daily routine in B2B commerce.\n\nThe **B2B Organizations** app enables you to group B2B users into organizations. You can assign specific payment methods, price tables, and product collections to each organization, allowing all organization users to share the same commercial conditions. Additionally, each organization can be further segmented into one or more cost centers, each with its own shipping addresses.\n\n## Before you begin\n\nFirst, make sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed in your computer.\n\nPlease note that when you install the B2B Organizations app, the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions) will also be installed as a dependency app. This is because Storefront Permissions allows you to assign specific storefront roles to B2B users within an organization. This is particularly useful for organizations with multiple users who have different responsibilities, such as placing orders, approving orders, or managing organization users. Read the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions) app documentation to learn more about the available roles and how to customize their permissions.\n\nIf you want to manage roles and permissions in the VTEX Admin, you must install [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui) as well.\n\n## Installation\n\nYou can install the **B2B Organizations** app by running the command `vtex install vtex.b2b-organizations` in your terminal, using [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\n## User widget configuration\n\nTo enable the [user widget](#user-widget) in your storefront, this app provides a `b2b-user-widget` block that you can add to the account store theme. We recommend adding it to the store header, as shown below.\n\n \n\nFollow the instructions below to display the user widget.\n\n1. Open your store theme app repository in your local files.\n2. In the `manifest.json` file, under `dependencies`, add `\"vtex.b2b-organizations\": \"1.x\"`: \n`1 \n\"dependencies\": { \n2 \n \"vtex.b2b-organizations\": \"1.x\" \n3 \n }, \n`\n3. Within your store's theme `store` \\> `blocks` \\> `header` folder, edit the `header.jsonc` file, placing the `b2b-user-widget` block in the desired location, as exemplified below. \nWe recommend placing it on the top row of the store header. Note that the `b2b-user-widget` block does not accept any props. \n`1 \n\"header-layout.desktop\": { \n2 \n \"children\": [ \n3 \n \"flex-layout.row#0-desktop\", \n4 \n \"flex-layout.row#1-desktop\", \n5 \n \"flex-layout.row#2-desktop\", \n6 \n \"flex-layout.row#3-desktop\", \n7 \n \"sticky-layout#4-desktop\" \n8 \n ] \n9 \n }, \n10 \n \n11 \n \"flex-layout.row#0-desktop\": { \n12 \n \"children\": [\"b2b-user-widget\"], \n13 \n \"props\": { \n14 \n \"fullWidth\": true \n15 \n } \n16 \n }, \n`\n4. Publish and install the modified store theme. Read our documentation on [Making your theme content public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public) for more information.\n\n## Configuration\n\nThis is the store header for only one associated organization: \n\nThis is the store header for more than one associated organization:\n\n \n\n### `b2b-user-widget`\n\n| Prop name | Type | Description | Default value |\n| ------------ | ------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- |\n| showDropdown | boolean | Controls whether the dropdown menu is displayed when multiple organizations are associated with the same email address. | true |\n\n## Customization\n\nTo apply CSS customizations to this and other apps, follow the instructions in [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\nCSS handles are available for the **Organization Request Form** component and the **User Widget** component.\n\n| **CSS handles** |\n| ------------------------------- |\n| newOrganizationContainer |\n| newOrganizationInput |\n| newOrganizationAddressForm |\n| newOrganizationButtonsContainer |\n| newOrganizationButtonSubmit |\n| userWidgetContainer |\n| userWidgetRow |\n| userWidgetItem |\n| userWidgetButton |\n| userWidgetImpersonationItem |\n| userWidgetImpersonationButton |\n| userWidgetImpersonationError |\n\n## How the app works\n\nThe **B2B Organizations** app adds the following functionalities and components to your VTEX store, which are divided into three categories: VTEX Admin, Master Data v2, and Storefront features.\n\n| Public | Category | Location | Feature |\n| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------- |\n| B2B store admin | [VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23vtex-admin) | Organization Requests page | Reviews organization requests. |\n| Organizations page | Manages organizations. | | |\n| Organization Details page | Manages cost centers associated with organizations. | | |\n| Manages collections associated with organizations. | | | |\n| Manages payment terms associated with organizations. | | | |\n| Manages price tables associated with organizations. | | | |\n| Manages organization users. | | | |\n| Message Center Templates page | Manages email templates for the B2B Organizations app. | | |\n| B2B store admin or developers | [Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23master-data-v2) | Master Data API v2 | Retrieves and edits information related to organization requests, organizations, and cost centers stored in Master Data v2. |\n| B2B customer (organization user) with required permissions | [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23storefront) | Storefront form | Requests a new organization. |\n| My Organization | Manages organizations. | | |\n| Manages cost centers | | | |\n| Manages users. | | | |\n| Impersonates users. | | | |\n| Storefront navigation | User widget | | |\n\n> This app can also be used together with [B2B Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote), allowing order quotes to be managed at the organization level. Please read our B2B Quotes documentation for more details.\n\n### VTEX Admin\n\nAfter installing and configuring the **B2B Organizations** app, you can find its VTEX Admin capabilities accessing **Account Settings > B2B Organizations & Cost Centers**.\n\n#### Organization Requests\n\nTo request the creation of an organization, B2B customers must complete the [Request New Organization form](#request-new-organization).\n\nOnce the customer completes this step, B2B store admins can review the organization request by navigating to **VTEX Admin** \\> **Account Settings** \\> **B2B Organizations & Cost Centers** \\> **Organization Requests** (or by accessing `/admin/b2b-organizations/requests`).\n\nOn this page, admins can view a list of all the organization requests placed in their store.\n\n \n\nEach organization within the system can be assigned one of the following statuses: **pending**, **approved** or **declined**. Pending requests are the ones awaiting review.\n\nTo review a request, follow these steps:\n\n1. Click a request from the table or click  \\> `View`.\n2. Leave a comment in the **Add note** field, if necessary.\n3. Click `Approve` or `Decline`.\n \n\nUpon approval, the request status will change to **Approved**, and the organization will be created. Notifications will be sent via email to both the [Organization Admin and the Sales Admins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions%23available-storefront-roles) to inform them of the approval. You can learn more about this notification in the [Email templates](#email-templates) section. In addition, the user designated as the Organization Admin will be granted access to the [My Organization](#my-organization) tab on the **My Account** page of your storefront.\n\nIf the organization request is declined, the request status will be changed to **Declined**, and the organization will not be created. The user assigned as the Organization Admin will receive an email notification informing this outcome. For further information about this notification, please refer to the [Email templates](#email-templates) section.\n\n#### Organizations\n\nThe **Organizations** page displays a list of all the organizations created in your store and their respective statuses. It also allows store admins to:\n\n* [Add organizations](#add-organization).\n* Access the [Organization details](#organization-details) page, which includes organization data, cost centers, collections, payment terms, price tables, and users.\n\nTo access the page, go to **Account Settings** \\> **B2B Organizations & Cost Centers** \\> **Organizations** in the VTEX Admin (or access `/admin/b2b-organizations/organizations`).\n\n \n\nYou can click `Refetch` to refresh the organization list on this page and retrieve information about recently created organizations.\n\nTo find a specific organization, you can use the search bar to search by name or apply filters based on the organization status.\n\nEach organization can have one of the following statuses:\n\n* **Active**: The organization has been approved by the store admins and is currently active.\n* **On hold**: The organization is currently paused, which means its users are temporarily unable to complete purchases.\n* **Inactive**: The organization has been deactivated by the store admins, so users will not be able to log in.\n\n##### Adding organization\n\nTo manually create a new organization on the **Organizations** page, please follow these steps:\n\n1. Click the `New` button.\n2. Fill in the required information about the new organization, as illustrated in the image below. \n * **Name of organization:** Name of the organization you want to create. \n * **Name of cost center:** Name of the initial cost center associated with the organization. \n * **Country:** Country where the cost center is located. \n * **Postal code:** Postal code of the cost center address. \n * **Address Line 1:** Main address information, including the street number and street name where the cost center is located. \n * **Address Line 2:** Optional field for additional address information. \n * **City:** City where the cost center is located. This field will be completed automatically based on the postal code informed. \n * **State:** State where the cost center is located. This field will be completed automatically based on the postal code informed. \n * **Receiver:** Name of the person who will receive the orders at the specified address.\n3. Click `Add`.\n \n\n> After creating the organization, you can add additional cost centers and addresses. The process for doing so is explained in the next section of this documentation.\n\n#### Organization Details\n\nOn the **Organizations Details** page, you can view and edit the following information of an existing organization:\n\n* [Organization name and status](#organization-name-and-status)\n* [Cost centers](#cost-centers)\n* [Collections](#collections)\n* [Payment terms](#payment-terms)\n* [Price tables](#price-tables)\n* [Users](#users)\n\nYou can access this page by going to **Account Settings** \\> **B2B Organizations & Cost Centers** \\> **Organizations** in the VTEX Admin and clicking the organization whose details you want to view, or  \\> `View`.\n\n> Note that assigning collections, payment terms, and price tables to an organization is optional. If these are not assigned, users belonging to the organization will see the store default catalog, have access to all payment methods, and view the store default pricing.\n\n##### Organization name and status\n\nIn the top section of the page, you will find the following information:\n\n* **Organization Name:** Name of the organization. You can edit this information.\n* **Status:** Status of the organization. You can set it to **Active**, **On Hold** or **Inactive** by selecting from a list.\n* **Created:** Date when the organization was created.\n \n\n##### Cost Centers\n\nIn the **Cost Centers** section, you can view all cost centers associated with the organization. VTEX Admin users can view and manage cost centers for any organization.\n\n \n\n> Each organization must have at least one cost center.\n\nBy default, each cost center allows the [payment terms](#payment-terms) that have been assigned to the parent organization. However, **Organization Admin** users can enable or disable individual payment terms at the cost center level. For more information on managing cost centers, please refer to the [Managing Cost Centers](#manage-cost-centers) section.\n\nTo create a new cost center, follow the steps below.\n\n1. Click the `New` button.\n2. Enter the required information about the new cost center, as illustrated in the image below. \n * **Name:** Name of the cost center. \n * **Country:** Country where the cost center is located. \n * **Postal code:** Postal code of the cost center address. \n * **Address Line 1:** Main address information, including the street number and street name where the cost center is located. \n * **Address Line 2:** Optional field for additional address information. \n * **City:** City where the cost center is located. This field will be completed automatically based on the postal code informed. \n * **State:** State where the cost center is located. This field will be completed automatically based on the postal code informed. \n * **Receiver:** Name of the person who will receive the orders at the specified address.\n3. Click `Add`.\n \n\n##### Cost Center Details\n\nYou can view or edit the details of an existing cost center by clicking on it on the **Organization Details** page.\n\nThis will lead you to the **Cost Center Details** page, where you can:\n\n* View or edit the cost center **Name** and **Addresses**.\n* View or edit the cost center **Business Document**.\n* Add a new shipping address associated with the cost center.\n* Delete the cost center.\n \n\nThe **Business Document field** is optional and can be utilized to store business identifiers such as Tax ID, VAT ID, CNPJ, or similar identification numbers. If a Business Document is specified in a user's cost center, it will be automatically applied as the `corporateDocument` in the user's profile. Additionally, this business document will be attached to any orders placed by the user.\n\n> Please note that the shipping addresses assigned to a cost center will only be accessible to users belonging to that specific cost center during the checkout process if you have installed [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings). Other addresses will not be available. Therefore, each cost center must have at least one shipping address.\n\nTo edit or delete an existing address, click  next to it and select **Edit** or **Delete**.\n\nTo add a new shipping address for a cost center, follow these instructions:\n\n1. Click `Add new address`.\n2. Enter the required information for the new address. \n * **Country:** Country where the cost center is located. \n * **Postal code:** Postal code of the cost center's address. \n * **Address Line 1:** Main address information, including the street number and street name where the cost center is located. \n * **Address Line 2:** Optional field for additional address information. \n * **City:** City where the cost center is located. This field will be completed automatically based on the postal code informed. \n * **State:** State where the cost center is located. This field will be completed automatically based on the postal code informed. \n * **Receiver:** Name of the person who will receive the orders at the specified address.\n3. Click `Add`.\n\nMake sure to click `Save` in the top right of the **Cost Center Details** page to save any changes made.\n\nIf you want to delete the cost center, click `Delete` instead.\n\n##### Collections\n\n> You must use the **Collections Beta** solution to be able to associate collections with organizations using **B2B Organizations**. Read our article on [Creating Collections Beta](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye) for more information.\n\nThis section allows you to manage the [product collections](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye) assigned to the organization, which determines the assortment of products visible to organization users in the storefront.\n\nTo add a collection, select the collection you want to add from the **Available** list and click `Add to org`.\n\nTo remove a collection, select the collection you want to remove from the **Assigned to organization** list and click `Remove from org`.\n\n \n\n##### Payment Terms\n\nIn this section, you can choose which [payment conditions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-configure-payment-conditions--tutorials%5F455?%26utm%5Fsource=autocomplete) are assigned to the organization, which determines which payment options are available to organization users during checkout.\n\nNote that the available payment options can be further customized per cost center by the **Organization Admin**. See the [Managing Cost Centers](#manage-cost-centers) section for more information.\n\nTo add a payment term, select the option you want to add from the **Available** list and click `Add to org`.\n\nTo remove a payment term, select the option you want to remove from the **Assigned to organization** list and click `Remove from org`.\n\n \n\n> To customize the checkout according to each organization user role, you need to install and configure [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings).\n\n##### Price Tables\n\nThis section allows you to choose which [price tables](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-price-tables--58YmY2Iwggyw4WeSCGg24S) are assigned to the organization. The prices displayed to organization users in the storefront are determined by the selected price tables.\n\nTo add a price table, select the option you want to add from the **Available** list and click `Add to org`.\n\nTo remove a price table, select the option you want to remove from the **Assigned to organization** list and click `Remove from org`.\n\n \n\n##### Users\n\nThis section displays a list of users associated with the organization, showing their **Email**, **Role** in the organization, and the **Cost Center** they are associated with.\n\n \n\nTo add a new user to the organization, follow these steps:\n\n1. In the **Users** list, click the `New` button.\n2. Enter the user information, as illustrated below. \n * **Name:** Full name of the user. \n * **Email:** Email address of the user. \n * **Cost Center:** Cost center the user will be associated with. \n * **Role:** Role the user will have in the storefront. See more details on the available roles in the [Storefront Permissions documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions%23available-storefront-roles).\n3. Click `Add`.\n \n\nOnce you add a new user to the organization, a customer account will be created if an account does not already exist in your store for the provided email address.\n\nTo edit or remove an existing user, follow these steps:\n\n1. Click the user you want to edit or delete in the **Users** list.\n2. Edit the desired information. \nYou can change the user's **Cost Center** and their **Role**. \nIf you want to remove the user from the organization, click `Remove user` and skip the next step.\n3. To apply your changes, click `Save`.\n \n\nIf a user is removed from an organization, their account will continue to exist in the store, but they will no longer be associated with an organization, cost center, or B2B role. Thus, they will lose access to the details of their organization on the **My Organization** page. Instead, they will have the option to [request the creation of a new organization](#request-new-organization), if necessary.\n\n> As an optional feature, you can install the [Admin Customers](https://read.calvincode.net/reader?url=https://github.com/vtex/admin-customers) app for additional customer management capabilities on the VTEX Admin.\n\n#### Email templates\n\nThe **B2B Organizations** app provides a set of four email templates to be sent to B2B organization users, which are triggered automatically based on specific changes:\n\n| **Template name** | **Recipient** | **Trigger** |\n| ------------------------------- | -------------------------------------- | ------------------------------------------- |\n| **Organization Approved** | Users with the Organization Admin role | The organization request has been approved. |\n| **Organization Created** | Users with a Sales Admin role | The organization has been created. |\n| **Organization Declined** | Users with the Organization Admin role | The organization request has been declined. |\n| **Organization Status Changed** | Users with the Organization Admin role | The organization status has changed. |\n\nIf you want to view or edit these templates, follow the steps below.\n\n1. In the VTEX Admin, go to **Customer > Message center > Templates**.\n2. Type `organization` in the search bar.\n3. Click the template you want to view or edit.\n4. Make the desired changes in the template. For detailed instructions on editing **Message Center** templates, refer to our documentation on [How to Create and Edit Transactional Email Templates.](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/335JZKUYgvYlGOJgvJYxRO)\n5. Click `Save`.\n \n\n### Master Data v2\n\nThe **B2B Organizations** app stores information about organization requests, organizations, and cost centers in [Master Data v2](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/master-data-v2--3JJ1mlzuo88w22gO0gy0QS).\n\nThis means that store admins or developers can retrieve this information via the [Master Data API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23overview) by using their **data entity name** as the value for the `data_entity_name` parameter.\n\nYou can see the data entity names in the table below.\n\n| **Data entity names** |\n| ---------------------- |\n| organization\\_requests |\n| organizations |\n| cost\\_centers |\n\n### Storefront\n\nStorefront capabilities, in turn, are accessible to B2B customers who visit a supplier store, provided that they are logged in and have the required permissions.\n\nThe following sections describe what your customer can do in your storefront after you have finished setting up the B2B Organizations app.\n\n#### Requesting a new organization\n\nIf a B2B user is not currently associated with any organization, they have the option to request the creation of a new buyer organization in your store by completing the **Request New Organization** form. They can follow the steps below to do so.\n\n1. Access the store website.\n2. Click **My Account** \\> **My Organization**.\n3. Provide the required information, as shown in the image below. \n * **Organization Name:** Name of the organization. \n * **User to become Organization Admin:** Section where you must provide information about the first user of the organization, who will be assigned as the Organization Admin. \n * **First Name:** First name of the Organization Admin user. \n * **Last Name:** Last name of the Organization Admin user. \n * **Email Address:** Email address of the Organization Admin user. \n * **Default Cost Center:** Section where you must provide information about the first cost center associated with the organization. \n * **Cost Center Name:** Name of the cost center. \n * **Business Document:** Optional field for a business document such as a Tax ID, Company registration number, etc. \n * **Country:** Country where the cost center is located. \n * **Postal code:** Postal code of the cost center's address. \n * **Address Line 1:** Main address information, including the street number and street name where the cost center is located. \n * **Address Line 2:** Optional field for additional address information. \n * **City:** City where the cost center is located. This field will be completed automatically based on the postal code informed. \n * **State:** State where the cost center is located. This field will be completed automatically based on the postal code informed. \n * **Receiver:** Name of the person who will receive the orders at the specified address.\n4. Click `Submit`.\n \n\nAfter submitting the form, the request will be sent to a queue for review by the B2B store administrator. See the [Organization Requests](#organization-requests) section for more information.\n\nThe user designated as the **Organization Admin** for the new organization will receive an email notification when the request has been approved or declined by the store admin. Learn more about this notification in the [Email templates](#email-templates) section.\n\n#### My Organization\n\nUsers designated as the **Organization Admin** or **Sales Admin** can manage their organization's details in the storefront on the **My Organization** page.\n\nUsers with the **Organization Buyer** or **Organization Approver** roles can also view a read-only version of this page.\n\nTo access **My Organization**, follow the instructions below.\n\n1. Access the storefront and log in.\n2. Click `Hello, {name}`.\n3. Click **My Account**.\n4. Go to **My Organization** on the sidebar. You will see the page below.\n \n\nOn this page, the user with the **Organization Admin** or **Sales Admin** roles can do the following:\n\n* [Manage Cost Centers](#manage-cost-centers)\n* [Manage Users](#manage-users)\n\n##### Managing cost centers\n\nStorefront users who have the **Organization Admin** or **Sales Admin** role can navigate to the Cost Centers section on the My Organization page to view the cost centers associated with their organization.\n\nTo add a new cost center, they should go to **My Account > My Organization**, where they will have access to the same options as described in the [Cost Centers](#cost-centers) section. They can view or edit the details of an existing cost center by clicking on it, similar to the process described in the [Cost Center Details](#cost-center-details) section.\n\n**Organization Admins** can also view and/or edit the **Business Document** associated with each cost center, as described in [Cost Center Details](#cost-center-details).\n\nIn addition, **Organization Admins** can enable specific payment terms for a cost center by using the switch button to activate or deactivate the payment terms assigned to the organization, as shown below.\n\n> This section will only be available on the **My Organization** page if [payment terms](#payment-terms) have been previously assigned to the organization by the VTEX Admin users.\n\n \n\n##### Managing users\n\n**Organization Admin** or **Sales Admin** storefront users can also view and manage the users of their organization in the **Users** section of the **My Organization**. To access this section, they can go to **My Account > My Organization**, where they will have access to the same options described in the [Users](#users) section of this documentation.\n\nUsers with the **Organization Admin** role can add, edit, or remove users with any of the following roles: **Organization Admin**, **Organization Approver**, and **Organization Buyer**.\n\nUsers with the **Sales Admin** role may add, edit, or remove users with any of the following roles: **Sales Admin**, **Sales Manager**, and **Sales Representative**.\n\n###### Impersonating users\n\nIn telesales, assisted sales, or customer support scenarios where the B2B customer needs help from a salesperson to navigate the store or place orders, it is common to use impersonation.\n\nIn the **B2B Organizations** app, users with a profile with at least one of the permissions **impersonate-users-all**, **impersonate-users-organization**, or **impersonate-users-costcenter** will be able to impersonate another user. These permissions are available in the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions) and can be added to the user's profile using the [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui).\n\nWhen impersonation is activated, it temporarily applies the email, organization, and cost center of the impersonated user to the storefront session. This allows impersonating users to do the following:\n\n* Browse the store and view prices, products, shipping addresses, and payment methods as the impersonated user would see them.\n* Take actions on behalf of the impersonated user, such as placing orders.\n* Use the regular permissions of the impersonated user.\n\nTo use impersonation, users with **Sales** roles or the **Organization Admin** role must follow the steps below.\n\n1. In the **Users** section of [My Organization](#my-organization), click  in the row of the user they want to impersonate.\n2. Click **Impersonate User**.\n \n\n> It is not possible to impersonate emails with Sales roles.\n\n#### User widget\n\nTo give storefront users visibility into their currently assigned organization, cost center, and role, this app provides a user widget that can be added to the account store theme:\n\n \n\n> To display the user widget, you must follow the instructions in the [User widget configuration](#user-widget-configuration) section.\n\nIf users click `Manage organization`, they can access the **My Organization** page directly.\n\nIn case impersonation is currently active, this block will also show the email of the user being impersonated, as well as the `Stop impersonation` button:\n\n\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-b2b-organizations.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23installation)\n\n[User widget configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23user-widget-configuration)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23configuration)\n\n[b2b-user-widget](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23b2b-user-widget)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23customization)\n\n[How the app works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23how-the-app-works)\n\n[VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23vtex-admin)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23master-data-v2)[Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23storefront)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/vtex-b2b-suite/vtex-b2b-organizations.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23before-you-begin)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23installation)\n\n[User widget configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23user-widget-configuration)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23configuration)\n\n[b2b-user-widget](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23b2b-user-widget)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23customization)\n\n[How the app works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23how-the-app-works)\n\n[VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23vtex-admin)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23master-data-v2)[Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23storefront)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_78827e9a
|
[
{
"role": "system",
"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 messages graphql api app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)\n\n[Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)\n\n[Messages GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/guides/functional-apps)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)\n\nMessages GraphQL API\n\n[vtex.messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages)\n\nVersion: 1.71.0\n\nLatest version: 1.71.0\n\nThis article serves as a comprehensive reference for the GraphQL API provided by the [Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages). This API enables the internationalization of messages in various store contexts, such as Catalog, Intelligent Search, and VTEX IO apps. For more details about how this API is used, see the [Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-overwriting-the-messages-app) article.\n\n## Schema overview\n\n### Query\n\nlanguages\n\ntranslations\n\nuserTranslations\n\nlistV2\n\nLanguages\n\nsupported \\[String!\\]!\n\ndefault String!\n\nTranslation\n\nlang String!\n\ntranslation String!\n\nMessageListV2\n\nsrcLang String!\n\ngroupContext String\n\ncontext String\n\ntranslations \\[Translation!\\]!\n\nQuery\n\nlanguages Languages!\n\nauthorize Boolean!\n\ntranslate(args TranslateArgs!) : \\[String\\]!\n\ntranslateWithDependencies(args TranslateWithDependenciesArgs!) : \\[String\\]!\n\nuserTranslations(args IndexedMessages!) : \\[MessageListV2\\]!\n\nlistV2(args ListArgsV2!) : \\[MessageListV2!\\]!\n\n| Field | (argument) | Type | Description |\n| ----------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **languages** | [Languages](#languages)! | Returns the store's default locale and the list of supported languages. These values are defined in the **Default Language** and **Supported Languages** settings in the [Messages app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). | |\n| **translate** | \\[String\\]! | Endpoint that retrieves a list of translated messages from a specific locale in Catalog. | |\n| args | [TranslateArgs](#translateargs)! | Input for translation requests. | |\n| **translateWithDependencies** | \\[String\\]! | Retrieves a list of translated messages from a specific locale in a VTEX IO app. The response is a list of MessageListV2, where each element contains a list of messages. | |\n| args | [TranslateWithDependenciesArgs](#translatewithdependenciesargs)! | Input for translation requests. Similar to TranslateArgs but requires dependency information. | |\n| **userTranslations** | \\[[MessageListV2](#messagelistv2)\\]! | Retrieves user translations. The response is a list of MessageListV2, where each element contains a list of messages from a specific source (CMS, an app, etc.). | |\n| args | [IndexedMessages](#indexedmessages)! | Group of messages by their source language. | |\n| **listV2** | \\[[MessageListV2](#messagelistv2)!\\]! | Retrieves a subset of all messages stored in VBase. The range argument defines the beginning and the end of the retrieved list. The response is a list of MessageListV2, where each element has a list of messages from a specific source (CMS, an app, etc.). | |\n| args | [ListArgsV2](#listargsv2)! | Argument used for message pagination. | |\n| **authorize** | Boolean! | Handles authorization for requests outside IO using a two-factor [authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens). It works with the **Two Factor URL** [app setting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). | |\n\n### Mutation\n\nMutation\n\nsaveV2(args SaveArgsV2!) : Boolean!\n\n| Field | (argument) | Type | Description |\n| ---------- | -------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **saveV2** | Boolean! | Creates or updates custom messages for the specified locale. This applies to translations for Catalog, Intelligent Search, and installed apps. | |\n| args | [SaveArgsV2](#saveargsv2)! | Input of messages to be saved. | |\n\n## Schema description\n\n> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).\n\n### Languages\n\n| Field | Type | Description |\n| ------------- | ------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **supported** | \\[String!\\]! | A list of languages the store supports. Each language is defined by its locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. If the request to the Messages app has a target language that isn't supported, it will translate to the default language, which is defined by **Supported Languages** in the [app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). |\n| **default** | String! | The default fallback language for the store, defined by its locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. If the value is \\*, all languages will be supported. This is defined by **Default Language** in the [app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages%23settings). |\n\n[Query](#query) 🔼\n\n### MessageListV2\n\n| Field | Type | Description |\n| ---------------- | --------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **srcLang** | String! | Locale code of the message list source content in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. |\n| **groupContext** | String | Groups related translations based on their context.Apps: automaticV2.CMS: CMS.Undefined: null. |\n| **context** | String | Defines the context for the translation. For example:Catalog: ID of the product/brand/category you want to translate, found in the Admin under **Product** \\> **Catalog**.Apps: The name of the app in which the message is being overwritten.Intelligent Search: intelligentSearchFacets, which defines the context of VTEX Intelligent Search. |\n| **translations** | \\[[Translation](#translation)!\\]! | List of messages in the context. |\n\n[Query](#query) 🔼\n\n[IndexedMessages](#indexedmessages) 🔽\n\n### Translation\n\n| Field | Type | Description |\n| --------------- | ------- | ---------------------------------------------------------------------------------------------------------------------- |\n| **lang** | String! | Message locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. |\n| **translation** | String! | The translated message string. |\n\n[MessageListV2](#messagelistv2) 🔼\n\n### IndexedMessages\n\n| Field | Type | Description |\n| ------------ | --------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------- |\n| **from** | String! | Source message locale code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. |\n| **messages** | \\[[MessageInputV2](#messageinputv2)!\\]! | List of messages to check translations. Each item in the list is a message in MessageInputV2 format. |\n\n[Query](#query) 🔼\n\n[TranslateArgs](#translateargs) 🔽\n\n[TranslateWithDependenciesArgs](#translatewithdependenciesargs) 🔽\n\n### ListArgsV2\n\n| Field | Type | Description |\n| --------- | -------------------------------- | --------------------------------------------------------- |\n| **range** | [MessagesRange](#messagesrange)! | Range indicating the first and last messages in the list. |\n\n[Query](#query) 🔼\n\n### MessageInputV2\n\n| Field | Type | Description |\n| ------------ | --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **content** | String! | Source message string. |\n| **context** | String | Provides context for the message. For example:Catalog: ID of the product/brand/category you want to check the translation, found in the Admin under Product > Catalog.Apps: The name of the app in which the message has been overwritten. |\n| **behavior** | [Behavior](#behavior) | Defines the translation source. The available options are USER\\_ONLY, USER\\_AND\\_APP, and FULL. |\n\n[IndexedMessages](#indexedmessages) 🔼\n\n### MessageSaveInputV2\n\n| Field | Type | Description |\n| ----------------- | ------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **srcLang** | String! | Store's locale default code in [ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php). Example: en-US. In the VTEX Intelligent Search context, this variable must be the store's binding default. |\n| **srcMessage** | String! | The source message based on its context:Catalog: Source message string.Apps: The ID of your message string declared in the app's messages folder.Intelligent Search: Source message string. Check the list below for the possible values of this variable and their definitions.Category 1: Department.Category 2: Category.Category 3: Subcategory.Price: Price.Promotion: Promotion.New Release: New release.Location: Location.Brand: Brand. |\n| **targetMessage** | String! | Catalog: Translated message string.Apps: Translated message string.Intelligent Search: Translated message string. |\n| **groupContext** | String | Groups related translations based on their context.Apps: automaticV2.CMS: CMS.Undefined: null. |\n| **context** | String | Catalog: ID of the product/brand/category you want to translate, found in the Admin under **Product** \\> **Catalog**.Apps: The name of the app in which the message is being overwritten.Intelligent Search: intelligentSearchFacets, which defines the context of VTEX Intelligent Search. |\n\n[SaveArgsV2](#saveargsv2) 🔽\n\n### MessagesRange\n\n| Field | Type | Description |\n| -------- | ---- | ----------------------------------- |\n| **from** | Int! | Position of the first list element. |\n| **to** | Int! | Position of the last list element. |\n\n[ListArgsV2](#listargsv2) 🔼\n\n### SaveArgsV2\n\n| Field | Type | Description |\n| ------------- | ----------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |\n| **to** | String! | Target locale code ([ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php), for example: en-US) for the translation. |\n| **messages** | \\[[MessageSaveInputV2](#messagesaveinputv2)!\\]! | List of messages to be translated. |\n| **fireEvent** | Boolean | If true, the request triggers an event. Default: false. |\n\n[Mutation](#mutation) 🔼\n\n### TranslateArgs\n\n| Field | Type | Description |\n| ----------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **indexedByFrom** | \\[[IndexedMessages](#indexedmessages)!\\]! | List of IndexedMessages. Each item in the list has a locale and a corresponding list of messages. |\n| **to** | String! | Target locale code ([ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php), for example: en-US) for the translation. |\n| **depTree** | String | The dependency tree in the format \"\\[{\"id\": \"{context}\"}\\]\". Example: \"\\[{\"id\": \"[vtex.store-components@3.x](mailto:vtex.store-components@3.x)\"}\\]\". |\n| **encoding** | [Encoding](#encoding) | The encoding format for messages sent to the automatic translation service. The available formats are ICU and HANDLEBARS. |\n\n[Query](#query) 🔼\n\n### TranslateWithDependenciesArgs\n\n| Field | Type | Description |\n| ----------------- | ----------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **indexedByFrom** | \\[[IndexedMessages](#indexedmessages)!\\]! | List of IndexedMessages. Each item in the list has a locale and a corresponding list of messages. |\n| **to** | String! | Target locale code ([ISO 639-1 format](https://read.calvincode.net/reader?url=https://www.loc.gov/standards/iso639-2/php/code%5Flist.php), for example: en-US) for the translation. |\n| **depTree** | String! | The dependency tree in the format \"\\[{\"id\": \"{context}\"}\\]\". Example: \"\\[{\"id\": \"[vtex.store-components@3.x](mailto:vtex.store-components@3.x)\"}\\]\". |\n| **encoding** | [Encoding](#encoding) | The encoding format for messages sent to the automatic translation service. The available formats are ICU and HANDLEBARS. |\n\n[Query](#query) 🔼\n\n### Behavior\n\n| Value | Description |\n| ------------------ | ---------------------------------------------------------------------------------------- |\n| **USER\\_ONLY** | Only uses translations defined by users, ignoring app and automatic translations. |\n| **USER\\_AND\\_APP** | Uses both user-defined and app-defined translations, but ignores automatic translations. |\n| **FULL** | Uses all available translation sources. |\n\n[MessageInputV2](#messageinputv2) 🔼\n\n### Encoding\n\n| Value | Description |\n| -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| **ICU** | Use for messages to be encoded in [ICU (International Components for Unicode) format](https://read.calvincode.net/reader?url=https://unicode-org.github.io/icu/userguide/format%5Fparse/messages) through the [ICU MessageFormat Parser](https://read.calvincode.net/reader?url=https://formatjs.github.io/docs/icu-messageformat-parser). |\n| **HANDLEBARS** | Use for messages to be encoded in [Handlebars format](https://read.calvincode.net/reader?url=https://handlebarsjs.com/guide/%23installation). |\n\n[TranslateArgs](#translateargs) 🔼\n\n[TranslateWithDependenciesArgs](#translatewithdependenciesargs) 🔼\n\n[Messages« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)[Product ContextNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.product-context)\n\nSee also\n\n[Vtex.messagesVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23schema-description)\n\n[Languages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23languages)[MessageListV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23messagelistv2)[Translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23translation)[IndexedMessages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23indexedmessages)[ListArgsV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23listargsv2)[MessageInputV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23messageinputv2)[MessageSaveInputV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23messagesaveinputv2)[MessagesRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23messagesrange)[SaveArgsV2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23saveargsv2)[TranslateArgs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23translateargs)[TranslateWithDependenciesArgs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23translatewithdependenciesargs)[Behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23behavior)[Encoding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.messages/messages-graphql-api/docs/apps/vtex.messages/messages-graphql-api%23encoding)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_676f2d63
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides google tag manager in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\n[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\n[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\nConfiguring Analytics (Google Tag Manager)\n\nDiscover how to manage Analytics on Store Framework using the Google Tag Manager app.\n\nTo manage Analytics on [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework), you need to install the [Google Tag Manager (GTM) app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager), which is a first-party solution that integrates your VTEX account with [Google Tag Manager](https://read.calvincode.net/reader?url=https://tagmanager.google.com), a JavaScript and HTML tag management system provided by Google for tracking user browsing.\n\nThe app allows you to manage website tags without accessing the store source code, allowing you to add, edit, or remove tags easily, and provides user browsing tracking for Google Analytics.\n\n> This app is only available for stores built with [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework). For stores built with Legacy CMS Portal, see [Configuring Google Tag Manager](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-setup-google-analytics-in-vtex-store--G2P0rmSrEiqCcmUMyUUwG%23configuring-google-tag-manager).\n\n\n\n[Installing Google Tag ManagerLearn how to install the Google Tag Manager app in your VTEX store.Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)[Setting up Google Tag ManagerSet up the Google Tag Manager app with variables, triggers, and tags.Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-configuring-analytics-google-tag-manager.md)\n\n[Using events to trigger side effects on store components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager//docs/guides/vtex-io-documentation-using-events-to-trigger-side-effects-on-store-components)[Installing Google Tag ManagerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-tag-manager//docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-configuring-analytics-google-tag-manager.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_21751b69
|
[
{
"role": "system",
"content": "You are a VTEX 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 setting up google analytics search tracking in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/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-setting-up-google-analytics-search-tracking/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/updates/release-notes)\n\nSetting up Google Analytics search tracking\n\n## Introduction\n\nThe charts and graphs generated by Google Analytics’ search tracking help retailers analyze user queries, measuring the store’s main searched terms.\n\nTo add this tracking tool, you’ll need to ensure that your Analytics is properly configured to translate search URLs into relevant data on user behavior.\n\nFollow the steps below and configure your store’s tracking.\n\n## Instructions\n\n1. Accessing Google Analytics in the desired account, click on **Admin** (gear button) in the lower left corner of your screen.\n2. Access **View Settings**.\n3. Enable **Site search Tracking** and fill out the **Query parameter** field with `_q,rest`.\n4. Enable **Site search categories** and fill out the **Category parameter** field with `_c`.\n\n\n\n1. Click on **Save**.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/managing-seo/vtex-io-documentation-setting-up-google-analytics-search-tracking.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking%23introduction)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking%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/managing-seo/vtex-io-documentation-setting-up-google-analytics-search-tracking.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Introduction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking%23introduction)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking%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_d81a4e29
|
[
{
"role": "system",
"content": "You are a VTEX 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 receive order notifications on vtex io in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Receiving Catalog Changes on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-catalog-changes-on-vtex-io)\n\n[Receiving Order Notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io)\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-service)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Receiving Catalog Changes on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-catalog-changes-on-vtex-io)\n\n[Receiving Order Notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io)\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/service-path-patterns)\n\n[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\n[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-developing-service-configuration-apps)\n\n[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/node-builder-7x-migration-guide)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/app-development-guides)\n\nHandling events\n\n[Receiving Order Notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io)\n\nReceiving Order Notifications\n\nLearn how to receive real-time order status notifications\n\nThis guide explains how to receive real-time order status notifications from VTEX using the `vtex.orders-broadcast` app and a sample listener application. By following these steps, you’ll be able to set up a workspace, configure the broadcast app, and start receiving notifications when orders are placed in your store.\n\n## Before you begin\n\n* A VTEX IO account with [workspace permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace).\n* [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed.\n* Basic familiarity with linking apps on VTEX IO.\n\n## Instructions\n\n1. Choose a workspace on your account that you'll work on. Let's suppose we're using the workspace `oms`.\n2. Clone the [Orders Feed Example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/orders-feed-example) repository to your local environment: \n`1 \ngit clone https://github.com/vtex-apps/orders-feed-example \n`\n3. In your browser, open the Orders Broadcast configuration page: `https://{accountName}.myvtex.com/admin/apps/vtex.orders-broadcast/setup`\n4. Change the `Target Workspace` variable to the name of the workspace you have created previously.\n5. Now you can link the `vtex.orders-feed-example` app in your desired workspace and receive order status updates.\n6. Now, if you finish an order on the account's Store, you'll see the notifications pop up on the console. You can start your development by extracting the listener code from the cloned app and adding it to your application.\n\n> For more information about customizing the listener, check the [example app's README](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/orders-feed-example/blob/master/docs/README.md)\n\nExample running on account `cliqueretire` and workspace `lucis`:\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/Getting-Started/back-end-development-guides/how-to-receive-order-notifications-on-vtex-io.md)\n\n[Receiving Catalog Changes on VTEX IO« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io//docs/guides/how-to-receive-catalog-changes-on-vtex-io)[Path patternsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io//docs/guides/service-path-patterns)\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/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io%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/Getting-Started/back-end-development-guides/how-to-receive-order-notifications-on-vtex-io.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-receive-order-notifications-on-vtex-io/docs/guides/how-to-receive-order-notifications-on-vtex-io%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_57d1eed6
|
[
{
"role": "system",
"content": "You are a VTEX 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 best practices for associating a custom page with a content type in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/api-reference)\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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/storefront-development)\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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/troubleshooting)\n\n[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-best-practices-for-associating-a-custom-page-with-a-content-type/updates/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/updates/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/store-framework)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/store-framework-routing)\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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\nBest practices for associating a custom page with a content type\n\nConfigure URLs effectively when associating custom pages with content types.\n\n[Custom landing pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page) are usually associated with specific store URLs. However, in some situations, it is helpful to associate a page template with a **content type** instead. Content types indicate the purpose of a page, such as Product Listing Pages (PLPs) and Product Detail Pages (PDPs).\n\nCreating your own content types can simplify website content management. For example, you can create a content type named \"Store Finder\" for the web pages that display the cities where your store is located. To associate the assets of these pages with the Store Finder content type, you must set an ID value for Store Finder and use it as a variable in your route paths.\n\nFollow the guidelines below to manage your website content more efficiently and ensure that your assets remain correctly associated with them, even when URLs change.\n\n## Before you begin\n\nEnsure you have created a new page following the guide [Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-new-custom-page).\n\n## URL guidelines\n\nTo associate a custom landing page with a content type, note the following when creating your URL:\n\n### Setting up content type parameters\n\n* Any URL parameter named `{entity}_id` is identified as a content type. For example, `finder_id` creates the `${finder}` content type. \n> For the URL definition, adding the content type identifier is not enough. You must also attach `_id` next to it. For example, if you create a URL like `/store/:category`, the content will be tied to that URL since there is no parameter that can be interpreted as a content type. Thus, if you access _Storefront > Site Editor_ and update the content for `/store/bakery`, the content related to any page matching `/store/:category` will also be updated.\n* The page URL can have only one parameter to indicate a content type.\n* The page URL can have only one parameter ending with `_id`.\n* Any additional variable parameters in the URL are ignored when matching content. For example, if you create the route `/store/:category/:{entity}_id`, the same content will be delivered for `/store/bakery/1` and `/store/beverages/1` as they both relate to the `{$entity}` content type.\n\n### Handling URL changes\n\nIf you change your URL, the assets will remain associated with the content type, not the specific URL.\n\nFor example, if you create a page with the URL `/store/:store_id`, where `store_id` represents the `${store}` content type, and later change it to `/store-finder/:store_id`, the assets will still be accessible at the new URL, as both URLs relate to the `${store}` content type.\n\n### Dos and Don'ts\n\n| ✅ Do | Explanation |\n| -------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| /store/:{entity}\\_id | The URL uses a content type parameter (ending with \\_id), allowing the system to identify the content type. For example: If {entity} is a finder, this URL would link to the ${finder} content type. |\n\n| ❌ Don'ts | Explanation |\n| ---------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| /store/:{entity} | The URL is wrong because it lacks the required \\_id suffix. Without \\_id, the system cannot identify it as a content type, which means no assets will be associated with this URL. |\n| /store/:category/:{entity}\\_id | While this URL includes a valid content type parameter, additional variable parameters (like :category) are ignored when determining content association. This can lead to unexpected content being delivered. |\n| /store/:{entity}\\_id/{entity2}\\_id | The URL is not allowed because it has two parameters ending with \\_id. To maintain clarity in the content association, a URL can only have one content type parameter ending with \\_id. |\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-best-practices-for-associating-a-custom-page-with-a-content-type.md)\n\n[Adding custom headers to your Store Framework store« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type//docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)[Customizing your 404 pageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type//docs/guides/vtex-io-documentation-customizing-your-404-page)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23before-you-begin)\n\n[URL guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23url-guidelines)\n\n[Setting up content type parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23setting-up-content-type-parameters)[Handling URL changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23handling-url-changes)[Dos and Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23dos-and-donts)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/pages/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type.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-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23before-you-begin)\n\n[URL guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23url-guidelines)\n\n[Setting up content type parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23setting-up-content-type-parameters)[Handling URL changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23handling-url-changes)[Dos and Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type%23dos-and-donts)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_2d4dc246
|
[
{
"role": "system",
"content": "You are a VTEX 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 styles 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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-builder/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-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-styles-builder/docs/guides/vtex-io-documentation-builders)\n\n[Styles Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/guides/vtex-io-documentation-styles-builder)\n\nStyles builder\n\nLearn how to use the VTEX IO Styles builder.\n\nThe `styles` builder helps you set a cohesive style for all components within your Store Theme app. During the app-building process, the `styles` builder interprets the `styles/style.json` file using [Tachyons](https://read.calvincode.net/reader?url=https://tachyons.io/) to generate your storefront’s CSS.\n\nUsing this builder, you avoid having to customize each component on different pages, as you set a standard style.\n\n## Folder structure\n\nAn app that uses the `styles` builder has a folder named `/styles` in its root directory. The directory structure may vary depending on the specific project settings.\n\nBelow is the folder structure of this builder:\n\n`1\n\nstyles \n\n2\n\n ┣ 📄 style.json \n\n`\n\nThe `style.json` file contains information relevant to styling, such as type scales, spacing, colors, typography, and other style-related settings.\n\n## Usage\n\nIf you are developing a Store Theme with VTEX IO and Store Framework from the [Store Theme boilerplate](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme), the `styles` builder is installed automatically, and the `/styles` folder is created in the directory root.\n\n> To learn more about app development using this builder, see the [Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-definingstyles) guide.\n\n## Use case examples\n\nAn app using the `styles` builder has a folder named `/styles` in its root directory and the `style.json` file in it. The directory structure may vary depending on specific project settings.\n\nThe basic structure of a `/styles` folder is composed of the following files, as you can see in the [Store Theme app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme) repository:\n\n`1\n\nstyles \n\n2\n\n ┣ 📂 configs \n\n3\n\n ┗ 📄 style.json \n\n4\n\n ┣ 📂 css \n\n`\n\n* Within the `style.json` file, there is a set of values and configurations to be used to guide styling decisions.\n* The `css` folder contains the CSS files, which, in turn, can be organized into different folders.\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-styles-builder.md)\n\n[Store Builder« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder//docs/guides/vtex-io-documentation-store-builder)[DependenciesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder//docs/guides/vtex-io-documentation-dependencies)\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-styles-builder/docs/guides/vtex-io-documentation-styles-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/guides/vtex-io-documentation-styles-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/guides/vtex-io-documentation-styles-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-styles-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-styles-builder/docs/guides/vtex-io-documentation-styles-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/guides/vtex-io-documentation-styles-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-styles-builder/docs/guides/vtex-io-documentation-styles-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_3c9fe6a9
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides hide anonymous customer option in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/how-to-customize-vtex-sales-app)\n\n[Change VTEX Sales App language](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/change-vtex-sales-app-language)\n\n[Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/hide-anonymous-customer-option)\n\n[Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\n[Enable the Observation field in the order screen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/enable-the-remarks-field-in-the-order-screen)\n\n[Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/sales-associate-code)\n\n[Enable cart transfer and capture between devices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/force-stock-availability)\n\n[Add extra text to the order summary print](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/add-extra-text-to-the-order-print)\n\n[Hide Print order and Reprint receipt buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/hide-print-order-and-reprint-receipt-buttons)\n\n[Enable partial cancellation for Debit or Credit Direct sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/hide-cancellation-buttons)\n\n[Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/allow-manual-prices-on-vtex-sales-app)\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/how-to-customize-vtex-sales-app)\n\n[Change VTEX Sales App language](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/change-vtex-sales-app-language)\n\n[Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/hide-anonymous-customer-option)\n\n[Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\n[Enable the Observation field in the order screen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/enable-the-remarks-field-in-the-order-screen)\n\n[Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/sales-associate-code)\n\n[Enable cart transfer and capture between devices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/force-stock-availability)\n\n[Add extra text to the order summary print](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/add-extra-text-to-the-order-print)\n\n[Hide Print order and Reprint receipt buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/hide-print-order-and-reprint-receipt-buttons)\n\n[Enable partial cancellation for Debit or Credit Direct sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/hide-cancellation-buttons)\n\n[Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/allow-manual-prices-on-vtex-sales-app)\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides)\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/how-to-customize-vtex-sales-app)\n\n[Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/hide-anonymous-customer-option)\n\nHide anonymous customer option\n\nBy default, inStore shows the option to continue as an anonymous customer in the **[New order page](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-sales-app-using-the-app--4BYzQIwyOHvnmnCYQgLzdr/2l56Bc2V1Xjv93JddsdEMi)**. If you want to hide this option, you can change its display by editing the `checkout-instore-custom.css` file. Check out the [How to customize VTEX Sales App guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/how-to-customize-vtex-sales-app%23css-customizations) for further information on how to access this file.\n\n## Edit the `checkout-instore-custom.css` file\n\nTo customize the display of the container with the `Continue as anonymous` button, you must declare the following IDs and properties in the `checkout-instore-custom.css` file.\n\nIn the **UI display** column below, you can see how the element you can hide is rendered in VTEX Sales App’s UI. You can click on each image to enlarge it.\n\n`` 1\n\n{ \n\n2\n\n\"data\": { \n\n3\n\n\"h-0\": \"CSS ID selector name\", \n\n4\n\n\"h-1\": \"Description\", \n\n5\n\n\"h-2\": \"UI display\", \n\n6\n\n\"0-0\": \"`customer-anonymous-container`\", \n\n7\n\n\"0-1\": \"The ID selector you can use to style the `Continue as anonymous` button. This button enables you to place an order on VTEX Sales App without identifying the customer.\", \n\n8\n\n\"0-2\": \"\" \n\n9\n\n}, \n\n10\n\n\"cols\": 3, \n\n11\n\n\"rows\": 1 \n\n12\n\n} \n\n ``\n\nIf you want to hide this element, you must use its ID selector and declare the display property with the value set as none in the `checkout-instore-custom.css` file, as exemplified below.\n\n`1\n\n#customer-anonymous-container { \n\n2\n\n display: none; \n\n3\n\n} \n\n`\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Sales-App/how-to-customize-vtex-sales-app/hide-anonymous-customer-option.md)\n\n[Change VTEX Sales App language« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option//docs/guides/change-vtex-sales-app-language)[Define payment methods displayed on VTEX Sales AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option//docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Edit the checkout-instore-custom.css file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/hide-anonymous-customer-option%23edit-the-checkout-instore-customcss-file)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Sales-App/how-to-customize-vtex-sales-app/hide-anonymous-customer-option.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Edit the checkout-instore-custom.css file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/hide-anonymous-customer-option/docs/guides/hide-anonymous-customer-option%23edit-the-checkout-instore-customcss-file)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e8d83766
|
[
{
"role": "system",
"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 quantity 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-quantity/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-quantity/docs/api-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-quantity/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-quantity/docs/storefront-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-quantity/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-quantity/docs/troubleshooting)\n\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-quantity/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-quantity/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/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-quantity/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-quantity/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/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-quantity/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/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-quantity/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-quantity/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-quantity/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/guides/basic-components)\n\nProduct Quantity\n\nOfficial extension\n\nVersion: 1.10.0\n\nLatest version: 1.10.0\n\n[](#contributors-)\n\nThe Product Quantity allows users to a add a chosen amount of the displayed product in their cart.\n\n\n\n## Configuration\n\n1. Add the Product Quantity app to your dependencies in the theme's `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.product-quantity\": \"1.x\" \n\n3\n\n } \n\n`\n\nYou are now able to use all blocks that are exported by the Product Quantity app. Check out the full list below:\n\n| Block name | Description |\n| ------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| product-quantity | Displays a quantity selector on the product details page. This block must be declared in the theme's store.product page template. |\n| product-summary-quantity | Displays a quantity selector on [Product Summary](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/all/vtex.product-summary/)'s blocks. This block must be declared as a children of the product-summary.shelf block. |\n\n1. According to your desired scenario, add the `product-quantity`/`product-summary-quantity` blocks to your theme. For example:\n\n`1\n\n \"flex-layout.col#product-price\": { \n\n2\n\n \"props\": { \n\n3\n\n \"preventVerticalStretch\": true, \n\n4\n\n \"rowGap\": 0 \n\n5\n\n }, \n\n6\n\n \"children\": [ \n\n7\n\n \"product-name\", \n\n8\n\n \"product-price#product-details\", \n\n9\n\n \"product-separator\", \n\n10\n\n+ \"product-quantity\", \n\n11\n\n \"sku-selector\", \n\n12\n\n \"flex-layout.row#buy-button\", \n\n13\n\n \"availability-subscriber\", \n\n14\n\n \"shipping-simulator\", \n\n15\n\n \"share\" \n\n16\n\n ] \n\n17\n\n }, \n\n18\n\n \"product-quantity\": { \n\n19\n\n \"props\": { \n\n20\n\n \"warningQuantityThreshold\": 9999999, \n\n21\n\n \"showUnit\": true \n\n22\n\n } \n\n23\n\n }, \n\n`\n\n_In the example above a Product Details Page is built using Flex Layout and the `product-quantity` block._\n\n### `product-quantity` and `product-summary-quantity` props\n\n| Prop name | Type | Description | Default Value |\n| ------------------------ | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------- |\n| warningQuantityThreshold | number | Displays the quantity of remaining items in stock if the available quantity is less than or equal to the value given to this property. | 0 (the quantity is not displayed) |\n| showUnit | boolean | Whether the unit of measurement should be displayed (true) or not (false). | true |\n| size | enum | Preset size values for font-size and padding. You can check these value measures by accessing the [VTEX Styleguide](https://read.calvincode.net/reader?url=https://styleguide.vtex.com/%23/Components/Forms/NumericStepper). Possible values are: small, regular, and large. | small |\n| showLabel | boolean | Whether a label should be displayed (true) or not (false). | true |\n| selectorType | enum | Defines how the quantity selector should initially behave. Possible values are: stepper (displays an input field where the quantity can be directly defined, in addition to side buttons to increase or decrease the value) and dropdown (shows a list of predefined-quantity options. In case the last quantity option is selected by users, the component is replaced with an input). | stepper |\n| quantitySelectorStep | enum | Defines how the number of products that have unitMultiplier will works. Possible values are: singleUnit (the quantity will be not affected with the unitMultiplier) and unitMultiplier (the quantity will be affected with the unitMultiplier). | unitMultiplier |\n\n## Customization\n\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| availableQuantityContainer |\n| quantitySelectorContainer |\n| quantitySelectorDropdownContainer |\n| quantitySelectorDropdownMobileContainer |\n| quantitySelectorInputContainer |\n| quantitySelectorInputMobileContainer |\n| quantitySelectorStepper |\n| quantitySelectorTitle |\n| summaryContainer |\n\n[Product Price« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-price)[Product SpecificationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-specifications)\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-quantity/docs/apps/vtex.product-quantity%23configuration)\n\n[product-quantity and product-summary-quantity props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-quantity%23product-quantity-and-product-summary-quantity-props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-quantity/docs/apps/vtex.product-quantity%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_9847bba2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation creating an interface for your app settings in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-managing-application-logs)\n\n[Running IO scripts in non-IO VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)\n\n[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n[Managing application logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-managing-application-logs)\n\n[Running IO scripts in non-IO VTEX stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)\n\n[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/app-development)\n\nDevelopment guides\n\n[Creating an interface for your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)\n\nCreating an interface for your app settings\n\nLearn how to create a user interface for your app and fetch data from it.\n\nWhen developing a [VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app), you can create an interface for accepting custom user settings. The app settings interface allows you to retrieve data provided by the user and enable or modify an app's behavior based on it. The configuration possibilities depend on the type of data collected by the interface and the intended use.\n\nThis guide outlines the process of creating such an interface and using the data input by users within your app.\n\n## Usage example\n\nThe app settings interface displays configuration forms for installed apps in the [App Store](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/extensions-hub--AW7klkYMh557y5IUOgzco/2LDRvGujYsumxi7IlE7CEJ). This interface is defined via the `settingsSchema` field on [manifest.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest), where you declare the schema of your app’s configuration.\n\nBelow is an example of the Google Tag Manager app interface and its corresponding `settingsSchema` configuration:\n\n| Interface | settingsSchema |\n| ------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n|  | manifest.json1 \"settingsSchema\": {2 \"title\": \"Google Tag Manager\",3 \"type\": \"object\",4 \"bindingBounded\": true,5 \"properties\": {6 \"gtmId\": {7 \"title\": \"Google Tag Manager\",8 \"description\": \"Enter the ID (GTM-XXXX) from your Google Tag Manager\",9 \"type\": \"string\"10 },11 \"allowCustomHtmlTags\": {12 \"title\": \"Allow Custom HTML tags\",13 \"description\": \"Beware that using Custom HTML tags can drastically impact the store's performance\",14 \"type\": \"boolean\"15 },16 \"sendGA4Events\": {17 \"title\": \"Send Google Analytics 4 Events\",18 \"description\": \"When this setting is active, also send the GA4 version of the events\",19 \"type\": \"boolean\"20 }21 }22 }, |\n\nAfter building your app's settings interface, you need to consume the data provided by the app’s user. Consider the Google Tag Manager example above, retrieving the GTM ID.\n\nBased on the given example, below are the instructions for creating an interface for your app and retrieving the data to use within the app.\n\n## Instructions\n\n### Step 1 - Creating the settings interface\n\nTo create the app settings interface, define the `settingsSchema` object in its `manifest.json` file.\n\nThis object declares a JSON Schema with the fields that meet your business needs. See the [JSON Schema documentation](https://read.calvincode.net/reader?url=http://json-schema.org/understanding-json-schema/) to correctly build the `settingsSchema` field.\n\n> The JSON Schema offers a predefined model that outlines how the settings should be formatted in your app. Note that, depending on the JSON Schema specification, the types accepted within a property include: `string`, `number`, `integer`, `boolean`, `object`, `array`, or `null`. You can also use arrays of types (for example, `[string, number]`) to indicate that the property accepts multiple types.\n\nConsidering the example of the Google Tag Manager interface previously presented, the `settingsSchema` object was configured as follows:\n\n`1\n\n \"settingsSchema\": { \n\n2\n\n \"title\": \"Google Tag Manager\", \n\n3\n\n \"type\": \"object\", \n\n4\n\n \"bindingBounded\": true, \n\n5\n\n \"properties\": { \n\n6\n\n \"gtmId\": { \n\n7\n\n \"title\": \"Google Tag Manager\", \n\n8\n\n \"description\": \"Enter the ID (GTM-XXXX) from your Google Tag Manager\", \n\n9\n\n \"type\": \"string\" \n\n10\n\n }, \n\n11\n\n \"allowCustomHtmlTags\": { \n\n12\n\n \"title\": \"Allow Custom HTML tags\", \n\n13\n\n \"description\": \"Beware that using Custom HTML tags can drastically impact the store's performance\", \n\n14\n\n \"type\": \"boolean\" \n\n15\n\n }, \n\n16\n\n \"sendGA4Events\": { \n\n17\n\n \"title\": \"Send Google Analytics 4 Events\", \n\n18\n\n \"description\": \"When this setting is active, also send the GA4 version of the events\", \n\n19\n\n \"type\": \"boolean\" \n\n20\n\n } \n\n21\n\n } \n\n22\n\n }, \n\n`\n\nThis code defines a schema for the settings UI that interacts with the Google Tag Manager app. The configured fields are described below:\n\n* `title`: App name displayed in the app settings interface. We recommend using the same app name configured in the [title field of the manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest%23title).\n* `type`: JSON Schema type (this must always be set as `object`).\n* `description` (optional): Description of the `settingsSchema` field.\n* `access` (optional): Defines the visibility of the app’s settings. When set to `public`, the settings become accessible through the `publicSettingsForApp` query. If omitted, the query will not return any data.\n* `properties`: Key-value pairs that define the fields that will be displayed to the app users, with their own definition within this object. Each defined key accepts the following `properties`: `title`, `description`, and `type`.\n* `gtmId`: String-type property that represents the Google Tag Manager ID. In the settings UI, this property is shown as a text box.\n* `allowCustomHtmlTags`: Boolean-type property that determines whether custom HTML tags are allowed. In the settings UI, this property is displayed as a checkbox.\n* `sendGA4Events`: Boolean-type property that indicates whether to send Google Analytics 4 events. In the settings UI, this property is displayed as a checkbox.\n\n> Setting `access` field to `public` makes **all configuration data publicly accessible**. Use this option only if you are certain that no sensitive information is stored in the app's settings.\n\n### Step 2 - Retrieving and consuming the app settings data\n\nIn your app’s code, you can retrieve the app settings in two ways:\n\n* [Frontend apps](#frontend-apps): Use a GraphQL query to fetch app settings.\n* [Backend apps](#backend-apps): Use the `getAppSettings` method from the `ctx.clients.apps` client.\n\nBelow is an example of each case.\n\n> Make sure your app has the required permissions to communicate with the frontend or backend app. Without proper permissions, your store won’t be able to share data with the solution. Learn more in [Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies).\n\n#### Frontend apps\n\n1. In the `manifest.json` file, add the `vtex.apps-graphql@3.x` within the `dependencies` field.\n2. In the `react` directory, create a new folder named `queries`.\n3. Create a new `graphql` file (for example, `AppSettings.graphql`) and query the settings options as in the following example.\n\n`1\n\nquery getSettings { \n\n2\n\n publicSettingsForApp(app: \"{vendor}.{app.name}\", version: \"0.x\") \n\n3\n\n @context(provider: \"vtex.apps-graphql\") { \n\n4\n\n message \n\n5\n\n } \n\n6\n\n} \n\n`\n\n> Replace `vendor`, `app.name`, and `0.x` with values based on your scenario. In the case of the Google Tag Manager app, the `app` value is `vtex.google-tag-manager`, and the `version` value is `1.x`.\n\nThe example above is a GraphQL query that fetches the data of a specific app declared in the arguments of `publicSettingsForApp` field: the app and its version. The configured fields are described below:\n\n* `@context(provider: \"vtex.apps-graphql\")`: The context for the query. In this case, it must be configured as \"vtex.apps-graphql\".\n* `message`: The message field to be included in the query result, which is a field within the `publicSettingsForApp` object. The message may vary depending on the app's settingsSchema.\n\nThis query will return an object like the one below:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"publicSettingsForApp\": { \n\n4\n\n \"message\": \"{\\\"gtmId\\\": \\\"GTM-1234\\\"}\" \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\n1. Open the `tsx` file of the React component that will consume this information and import the GraphQL query:\n\n`1\n\nimport AppSettings from './queries/AppSettings.graphql' \n\n`\n\n1. Parse and use the defined query value (for example, `AppSettings`) based on your needs. See the example below:\n\n`` 1\n\n const { data: appSettingsData } = useQuery(AppSettings, { \n\n2\n\n variables: { version: process.env.VTEX_APP_VERSION }, \n\n3\n\n ssr: false, \n\n4\n\n }); \n\n5\n\n \n6\n\n useEffect(() => { \n\n7\n\n if (appSettingsData) { \n\n8\n\n const { gtmId } = JSON.parse(appSettingsData.publicSettingsForApp?.message || '{}'); \n\n9\n\n if (gtmId) { \n\n10\n\n window.dataLayer = window.dataLayer || []; \n\n11\n\n window.dataLayer.push({ 'gtm.start': new Date().getTime(), event: 'gtm.js' }); \n\n12\n\n const script = document.createElement('script'); \n\n13\n\n script.src = `https://www.googletagmanager.com/gtm.js?id=$\\{gtmId\\}`; \n\n14\n\n document.head.appendChild(script); \n\n15\n\n } \n\n16\n\n } \n\n17\n\n }, [appSettingsData]); \n\n ``\n\nThe code above interacts with an API through a GraphQL query, which is managed by the `useQuery` hook, to fetch the app settings. When the data is retrieved, a `useEffect` hook parses the settings, extracts the `gtmId`, and dynamically initializes GTM by injecting its script into the document if the `gtmId` is available.\n\n#### Backend apps\n\n1. Open your `node` app in any code editor of your choice.\n2. Declare a new function (for example, `getConfig`) and use the `getAppSettings` method from the `apps` client to retrieve and return the app settings data. See the example below:\n\n`1\n\nexport const getConfig = async (_: any, __: any, ctx: Context) => { \n\n2\n\n const { \n\n3\n\n clients: { apps }, \n\n4\n\n vtex: { logger }, \n\n5\n\n } = ctx; \n\n6\n\n \n7\n\n const appId = process.env.VTEX_APP_ID; \n\n8\n\n \n9\n\n try { \n\n10\n\n const settings = await apps.getAppSettings(appId); \n\n11\n\n return settings; \n\n12\n\n } catch (error) { \n\n13\n\n logger.error({ \n\n14\n\n message: 'getConfig-getAppSettings-error', \n\n15\n\n error, \n\n16\n\n }); \n\n17\n\n } \n\n18\n\n}; \n\n`\n\nThe `getConfig` function returns a promise as it fetches the app settings and handles errors. It retrieves an app ID from environment variables, uses it to request settings, and logs any errors.\n\n1. Import the defined function and consume it based on your needs. For example, you can use it in a resolver, middleware, or any other part of your backend app.\n\nContributors\n\n3\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/RezenDeveloper)\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/Getting-Started/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-creating-an-interface-for-your-app-settings.md)\n\n[Running IO scripts in non-IO VTEX stores« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings//docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)[Node appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings//docs/guides/app-development-guides)\n\nContributors\n\n3\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/RezenDeveloper)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Usage example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23usage-example)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23instructions)\n\n[Step 1 - Creating the settings interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23step-1-creating-the-settings-interface)[Step 2 - Retrieving and consuming the app settings data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23step-2-retrieving-and-consuming-the-app-settings-data)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-creating-an-interface-for-your-app-settings.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23usage-example)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23instructions)\n\n[Step 1 - Creating the settings interface](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23step-1-creating-the-settings-interface)[Step 2 - Retrieving and consuming the app settings data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings/docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings%23step-2-retrieving-and-consuming-the-app-settings-data)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_57bb0929
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides enabling an access control list acl in b2b suite in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/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/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides)\n\nB2B Suite\n\nB2B Organizations\n\n[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite)\n\nEnabling an access control list ACL in B2B Suite\n\nThe **Access Control List (ACL)** feature in B2B Suite allows you to restrict access to resources such as **buyer organizations**, **cost centers**, and **members** in the VTEX Admin. You need to set up specific permissions to allow the users to view or manage these resources.\n\nIf a user doesn't have the required permissions, they won't be able to access the **Buyer organizations** section in the VTEX Admin.\n\n## Required permissions\n\nTo allow access to the apps related to B2B Organizations in the VTEX Admin, you need to add the following roles:\n\n| Permission Name | Description |\n| ----------------------------- | ------------------------------------------------------------------------------ |\n| **buyer\\_organization\\_view** | Allows viewing organizations, cost centers, and users. |\n| **buyer\\_organization\\_edit** | Allows creating, editing, and deleting organizations, cost centers, and users. |\n\nThese permissions are available under the **Buyer organizations/Management** resource. Follow the steps below to access this resource:\n\n1. Access the VTEX Admin.\n2. In the upper right corner, click the icon with your initial.\n3. Click **Account settings**.\n4. Click **User roles**.\n\n## Updating B2B Suite apps\n\nTo enable the ACL feature, follow the steps below:\n\n1. Open the terminal [Using VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage).\n2. Run the commands below to update the B2B Suite apps.\n\n`1\n\nvtex install vtex.storefront-permissions@3.1.0 --force \n\n2\n\nvtex install vtex.b2b-organizations-graphql@2.0.1 --force \n\n3\n\nvtex install vtex.b2b-quotes-graphql@4.0.1 --force \n\n4\n\nvtex install vtex.b2b-orders-history@2.0.1 \n\n5\n\nvtex install vtex.storefront-permissions-ui@3.0.1 \n\n6\n\nvtex install vtex.b2b-organizations@3.0.1 \n\n7\n\nvtex install vtex.b2b-quotes@3.0.1 \n\n8\n\nvtex install vtex.storefront-permissions-components@2.0.1 \n\n9\n\nvtex install vtex.b2b-admin-customers@2.0.1 \n\n10\n\nvtex install vtex.b2b-my-account@2.0.0 \n\n11\n\nvtex install vtex.b2b-checkout-settings@3.0.1 --force \n\n12\n\nvtex install vtex.b2bstore@5.0.0 \n\n13\n\nvtex install vtex.b2b-suite@2.0.0 \n\n`\n\n> If any of the apps above are not installed in your store, update only the ones you have.\n\n1. Run the command below to check if there are any dependencies on older versions.\n\n`1\n\nvtex deps list | grep <app-name-without-version> \n\n`\n\n1. If there are any apps with an older version, update them as described in step 2.\n\n> To revert to a previous version, reinstall the earlier versions of each app.\n\n## Updating custom apps with ACL support\n\nIf your account uses custom apps that depend on the **b2b-organizations-graphql** or **storefront-permissions** apps, you need to update the `manifest.json` file to include the permission policies.\n\nThe `manifest.json` file is located at the root of the app repository. Open the file in a code editor and add the following policies in the `policies` section:\n\n`1\n\n\"policies\": [ \n\n2\n\n { \n\n3\n\n \"name\": \"buyer_organization_view\" \n\n4\n\n }, \n\n5\n\n { \n\n6\n\n \"name\": \"buyer_organization_edit\" \n\n7\n\n } \n\n8\n\n] \n\n`\n\nAfter saving the file, publish the app again to apply the changes.\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/b2b-organizations/enabling-an-access-control-list-acl-in-b2b-suite.md)\n\n[How to configure tradeName to use in the organization search field« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite//docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)[How to customize VTEX Sales AppNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite//docs/guides/how-to-customize-vtex-sales-app)\n\nContributors\n\n1\n\n[](https://github.com/geisecosta)\n\nON THIS PAGE\n\n[Required permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23required-permissions)\n\n[Updating B2B Suite apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23updating-b2b-suite-apps)\n\n[Updating custom apps with ACL support](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23updating-custom-apps-with-acl-support)\n\nWas this helpful?\n\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/b2b-organizations/enabling-an-access-control-list-acl-in-b2b-suite.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Required permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23required-permissions)\n\n[Updating B2B Suite apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23updating-b2b-suite-apps)\n\n[Updating custom apps with ACL support](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite/docs/guides/enabling-an-access-control-list-acl-in-b2b-suite%23updating-custom-apps-with-acl-support)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_cea2367e
|
[
{
"role": "system",
"content": "You are a VTEX 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 1 onboarding starting the project in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-overview)\n\n2\\. Starting a new FastStore project\n\nCreate and set up your FastStore project with WebOps.\n\nIn this step, you'll use the [FastStore WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) to create your FastStore project, connect it to GitHub, and deploy a live preview.\n\nThis establishes your project’s source of truth and CI/CD path — the foundation for all later steps in this track.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Created your FastStore project with basic configuration (project name, SEO tags, GTM, catalog)\n* Connected your project to a GitHub repository for version control\n* Set up the Headless CMS integration for content management\n* Deployed your project and generated a live preview of your storefront\n\nYour project will be accessible at `https://{accountName}.vtex.app/` and ready for local development in the next step.\n\n## Getting to know the WebOps app\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) is the **control plane** for FastStore projects. It manages every stage of your storefront’s lifecycle, from creation to deployment, and integrates with your GitHub repository and VTEX account to facilitate collaboration and automation.\n\n\n\nWebOps connects your storefront code (GitHub) with your VTEX infrastructure, enabling a branch-based workflow for development and production. Keep the following in mind:\n\n* **Environment requirement:** WebOps operates exclusively in the production environment. Install it only in your account’s `master` environment.\n* **Development workflow:** FastStore uses a [Git branching model](https://read.calvincode.net/reader?url=https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-branches) for development and testing: \n * The app is installed in the `master` environment of your VTEX account. \n * Development and testing occur on Git branches. \n * Approved changes are merged into the repository’s `main` branch and automatically deployed to production.\n\n> Unlike [VTEX IO workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace), FastStore uses a Git-based branching workflow.\n\n## Before you begin\n\n### Check permissions\n\nTo start a FastStore project, users must have the **Owner (Admin Super)** [role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc%23roles).\n\n### Create your store catalog\n\nCreate a catalog to populate and test your store. It should include essential components such as product listing pages, search, product details, and checkout. Developing without a catalog may result in incomplete testing, data integration issues, and rework later.\n\nFor more information, refer to the [Catalog documentation](https://read.calvincode.net/reader?url=https://help.vtex.com/docs/tracks/catalog).\n\n### Have a GitHub account\n\nTo complete the FastStore WebOps onboarding, you’ll need a GitHub account to host your project. You can use either a [personal account](https://read.calvincode.net/reader?url=https://docs.github.com/en/account-and-profile/setting-up-and-managing-your-personal-account-on-github) or a [GitHub organization](https://read.calvincode.net/reader?url=https://docs.github.com/en/organizations/collaborating-with-groups-in-organizations/about-organizations). \nIf you use a GitHub organization, ensure you have **admin access** to it.\n\n## Step 1: Setting up the project\n\n1. Open the VTEX Admin and access **Storefront > FastStore WebOps**.\n2. Click `Start Project`.\n3. In the **Setup & Create Project** page, configure the following options for your store:\n\n### Project\n\nChoose the option that best fits your project's purpose. This helps us understand what you're trying to achieve with FastStore and improve your experience.\n\n| Field | Description |\n| --------------------------------------------------------- | ------------------------------------------------------------ |\n| **Project name** | Enter your FastStore project's name, e.g., Marcio Car store. |\n| **Which option best describes the goal of your project?** | Choose the option that best fits your project’s purpose. |\n\n### SEO Tags\n\n| Field | Description |\n| ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Title Tag** | Enter a keyword-optimized title for your store. For example: Buy Online with the Best Game Store - GameStore. In this example, we used the length limit of around 50-60 characters to ensure it is fully displayed in search results without being truncated. |\n| **Description Tag** | Enter a brief description of your store, for example, Shop online at GameStore, the best game store for PC, Xbox, PS4 and Headphones. Explore our wide selection and buy your favorite games today! |\n| **Title Template** | Enter a page title that helps search engines and users better understand the content of your store. For example, The best game store - GameStore. |\n| **Site Author** | Enter the name of the agency or person responsible for the development of the storefront. |\n\n### Google Tag Manager\n\n| Field | Description |\n| ---------- | ------------------------------------------------------------------------------------------------------------------------------------------ |\n| **GTM ID** | Enter the Google Tag Manager ID (GTM ID) associated with the GTM container responsible for managing and organizing the tags of your store. |\n\n### Catalog\n\n| Field | Description |\n| ----------- | ------------------------------------------------------ |\n| **Catalog** | Choose which catalog your store should be linked with. |\n\n### Terms of use\n\nIf you already have content created in the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview), be aware that it will be automatically deleted during FastStore WebOps onboarding to avoid content duplication.\n\nTo proceed, please confirm that you understand by checking the Terms of use box.\n\nAfter setting up the basic configuration for your store and reviewing it, click `Continue` to proceed to the next page.\n\n## Step 2: Setting up integrations\n\nOn this page, you will set up the native Headless CMS integration and connect to a GitHub organization.\n\n### CMS Integration\n\nConfigure the native [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) integration and connect to GitHub.\n\n### Git Provider\n\nConnect with a GitHub personal account or organization of your choice to host the source code of your FastStore project.\n\n> If you choose to install the app in a GitHub organization, make sure you have admin access to an organization.\n\nTo connect to the FastStore WebOps app, follow these steps:\n\n1. Click `Connect with GitHub`. A new browser tab will open on the side for you to integrate the app with GitHub. \n> If you are not logged in to your GitHub account, in the new tab, you will be asked to log in. Then, you can continue to the next step.\n2. Once you are logged in to your GitHub account, choose the organization or your personal account you want to install the app. You will be redirected to the **Settings** page on GitHub. \n> Once you define the GitHub organization, you cannot change it later.\n3. In **Repository access**, choose one of the following options: **All repositories from the organization** or **Only select repositories**.\n4. Click `Install`.\n\nThe following successful message will appear on the page:\n\n`1\n\nSuccess! You can now close this page and proceed with the onboarding process. \n\n`\n\nAfter seeing the success message, close the browser tab and continue the onboarding process in the VTEX Admin.\n\n1. Now that the app is integrated with GitHub, select which repository you want to start the project: \n * **New repository:** Create a repository from scratch, in this option, you only need to type a name for the repository, and after clicking `Create`, it will create the repository for you. \n * **Existing repository:** Select an existing repository from the organization to start the project.\n2. Click `Create`. The deployment process will begin, and once it is complete, you will be redirected to the [Deploy Summary](#step-3--deploying-the-project) page.\n\n## Step 3: Deploying the project\n\nAfter completing the setup for your store, the deployment process will begin. This process involves creating a GitHub repository and a default domain for your project. Once the deployment process is complete, you should see the following:\n\n\n\n| Option | Description |\n| ------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Your Repository** | Access the store's GitHub repository and start setting up and customizing your store. |\n| **Documentation** | Access the FastStore Portal Documentation. |\n| **Customization** | Access the documentation on how to customize your store. |\n| **View Dashboard** | Access the Dashboard with the current status of your store, including its domains, deployed versions, store preview, and Lighthouse scores. For more information, please refer to the [Dashboard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-dashboard) guide. |\n\n> If repository creation fails and no live preview is generated, click **Retry** to redeploy.\n\n## Next step\n\nNow that your store is up and running with a live preview, set up your local development environment: [3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/2-starting-the-project.mdx)\n\n[1\\. Setting up your environment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-1-setting-up-your-environment)[3\\. Running the project locallyNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\nContributors\n\n2\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23what-youll-accomplish)\n\n[Getting to know the WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23getting-to-know-the-webops-app)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23before-you-begin)\n\n[Check permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23check-permissions)[Create your store catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23create-your-store-catalog)[Have a GitHub account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23have-a-github-account)\n\n[Step 1: Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-1-setting-up-the-project)\n\n[Project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23project)[SEO Tags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23seo-tags)[Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23google-tag-manager)[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23catalog)[Terms of use](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23terms-of-use)\n\n[Step 2: Setting up integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-2-setting-up-integrations)\n\n[CMS Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23cms-integration)[Git Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23git-provider)\n\n[Step 3: Deploying the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-3-deploying-the-project)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23next-step)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/2-starting-the-project.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23what-youll-accomplish)\n\n[Getting to know the WebOps app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23getting-to-know-the-webops-app)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23before-you-begin)\n\n[Check permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23check-permissions)[Create your store catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23create-your-store-catalog)[Have a GitHub account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23have-a-github-account)\n\n[Step 1: Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-1-setting-up-the-project)\n\n[Project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23project)[SEO Tags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23seo-tags)[Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23google-tag-manager)[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23catalog)[Terms of use](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23terms-of-use)\n\n[Step 2: Setting up integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-2-setting-up-integrations)\n\n[CMS Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23cms-integration)[Git Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23git-provider)\n\n[Step 3: Deploying the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23step-3-deploying-the-project)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project/docs/guides/faststore/getting-started-2-starting-the-project%23next-step)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_fba9e627
|
[
{
"role": "system",
"content": "You are a VTEX 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 ads events in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/ads-events)\n\n[Understanding ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events)\n\n[Ads events notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/ads-events-notification)\n\n[Impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/impressions)\n\n[Views](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/views)\n\n[Clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/clicks)\n\n[Conversion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/conversion)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/ads-events)\n\n[Understanding ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events)\n\n[Ads events notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/ads-events-notification)\n\n[Impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/impressions)\n\n[Views](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/views)\n\n[Clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/clicks)\n\n[Conversion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/conversion)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/getting-started-with-vtex-ads-api)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/ads-events)\n\n[Understanding ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events)\n\nUnderstanding ads events\n\nLearn how ad events are tracked, identified, and deduplicated to ensure accurate campaign measurement—covering sessions, user identification, conversion windows, and attribution rules.\n\n## User and session identification\n\nAll Beacon requests require specific information to accurately identify and attribute events to users and their corresponding conversions. For this purpose, we use two key concepts:\n\n### `session_id`\n\nThe `session_id` is the user's session identifier. It has a limited lifespan and helps us determine when a user transitions from an anonymous to an identified state. It also allows us to understand how many sessions a user goes through before converting.\n\nThe `session_id` is **mandatory** in all cases—even for short-lived sessions. For example, in an offline point-of-sale (POS) conversion, you can generate a random value. For web sessions, the value should match the current user session ID.\n\n### `user_id`\n\nThe `user_id` is the unique identifier for a customer within your platform. It must remain consistent across all user touchpoints and sales channels.\n\nThis consistency enables us to track users who interact with an ad in one channel (e.g., online) and convert in another (e.g., offline).\n\nThe `user_id` can be sent with all events, but it is **required** only for conversion events, as this is the point where the customer must be identified.\n\n## Event count and deduplication\n\n**Impression**, **view**, and **click** events are **deduplicated** per user, per device, per ad. The table below summarizes how each type of event is deduplicated to ensure accurate tracking and prevent double counting:\n\n| Event type | Deduplication window | Explanation |\n| -------------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Impression** | 1 minute | Multiple impressions of the same ad within 1 minute are counted only once. |\n| **Click** | 1 hour | Repeated clicks on the same ad within 1 hour are counted only once. |\n| **Conversion** | 30 days (per order\\_id) | Conversion events are always counted regardless of session or device and they don't follow deduplication rules applied to impressions and clicks. Conversion events are deduplicated based on the order\\_id within a 30-day window. If a conversion with the same order\\_id is received again during this period, it will not be counted again. |\n\n### Example 1: Same session\n\nA user clicks on an ad at 12:00 PM on day 1 and clicks on it three more times later that day. Only the first click will be counted.\n\nOn day 2, if the same user clicks on the same ad again **before 12:00 PM** (still within the same session), no new click is counted. After 12:00 PM, a new click is counted.\n\n### Example 2: Session change\n\nIf the user changes sessions, a new event will always be counted, regardless of the time since the last interaction.\n\n> **Conversion events are always counted**, whether or not the session has changed.\n\n## Conversion window\n\nThe conversion window (or attribution window) defines the time frame during which a user's conversion can be attributed to an ad interaction.\n\nWe currently use two main attribution models based on ad type:\n\n### Product ads\n\n* **Conversion window**: 7 days\n* **Trigger**: User clicks on a product ad\n\nTracking begins only when the user clicks on a product ad. Views alone do not initiate tracking. From the moment of the click, the ad is monitored for 7 days.\n\n### Display or video ads\n\n* **Conversion window**: 14 days\n* **Trigger**: User views the ad\n\nAs soon as a user views a display or video ad, tracking begins and continues for 14 days. If the user makes a purchase during this period, the conversion is attributed to the ad.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/ads-events/understanding-ads-events.md)\n\n[Ads events« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events//docs/guides/ads-events)[Ads events notificationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events//docs/guides/ads-events-notification)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[User and session identification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23user-and-session-identification)\n\n[session\\_id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23sessionid)[user\\_id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23userid)\n\n[Event count and deduplication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23event-count-and-deduplication)\n\n[Example 1: Same session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23example-1-same-session)[Example 2: Session change](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23example-2-session-change)\n\n[Conversion window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23conversion-window)\n\n[Product ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23product-ads)[Display or video ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23display-or-video-ads)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/ads-events/understanding-ads-events.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[User and session identification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23user-and-session-identification)\n\n[session\\_id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23sessionid)[user\\_id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23userid)\n\n[Event count and deduplication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23event-count-and-deduplication)\n\n[Example 1: Same session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23example-1-same-session)[Example 2: Session change](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23example-2-session-change)\n\n[Conversion window](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23conversion-window)\n\n[Product ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23product-ads)[Display or video ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/understanding-ads-events/docs/guides/understanding-ads-events%23display-or-video-ads)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_be0a8203
|
[
{
"role": "system",
"content": "You are a VTEX 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 label in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-label/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-label/docs/api-reference)\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-label/docs/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-label/docs/storefront-development)\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-label/docs/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-label/docs/troubleshooting)\n\n[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-label/updates/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-label/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-label/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/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-label/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/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-label/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/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-label/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-label/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-label/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-label/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/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-label/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-label/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/updates/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-label/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-label/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/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-label/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/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-label/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/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-label/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-label/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-label/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-label/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/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-label/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-label/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-label/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-overview)\n\nLabel\n\nLabels describe the meaning of input fields.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/Label)\n\nThe `Label` component provides accessible text descriptions for form controls, helping users understand the purpose and expected input of each field. Typical use cases include:\n\n* Describing the purpose of input fields (e.g., `Email Address`, `Password`, or `Phone Number`).\n* Associating descriptive text with form elements for improved accessibility.\n* Providing context for user interactions in forms and surveys.\n\nExample\n\nCode\n\nLabel\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Label } 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/Label/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### Label with Input\n\nLabels are commonly used to describe input fields. Use the `htmlFor` attribute to associate the label with the [Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input) component.\n\nExample\n\nCode\n\nEmail Address\n\n### Label with custom attributes\n\nYou can pass additional HTML attributes to customize the label behavior.\n\nExample\n\nCode\n\nPassword\n\n---\n\n## Data attributes\n\nYou can target and override `Label` styles using the following data attributes:\n\n`data-fs-label`\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-label |\n\n---\n\n## Best practices\n\n### ✅ Dos\n\n* Use clear and concise text that accurately describes the expected input. Be specific about what information is required.\n* Ensure labels remain visible at all times and are not replaced by placeholders.\n* Keep label text short and to the point, avoiding unnecessary words.\n\n### ❌ Don'ts\n\n* Don't use placeholder text as a substitute for labels, as placeholders disappear when users start typing.\n* Don't hide labels visually while keeping them only for screen readers.\n* Don't use vague or generic text like \"Enter value\" or \"Field\".\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/label.mdx)\n\n[Input« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-input)[LinkNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-link)\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-label/docs/guides/faststore/atoms-label%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23examples)\n\n[Label with Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23label-with-input)[Label with custom attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23label-with-custom-attributes)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23props)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23best-practices)\n\n[✅ Dos](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23-donts)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/label.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-label/docs/guides/faststore/atoms-label%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23examples)\n\n[Label with Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23label-with-input)[Label with custom attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23label-with-custom-attributes)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23props)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23best-practices)\n\n[✅ Dos](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label/docs/guides/faststore/atoms-label%23-donts)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e1473cf5
|
[
{
"role": "system",
"content": "You are a VTEX 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 internationalizing product prices in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-internationalizing-product-prices/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-internationalizing-product-prices/docs/api-reference)\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-internationalizing-product-prices/docs/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-internationalizing-product-prices/docs/storefront-development)\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-internationalizing-product-prices/docs/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-internationalizing-product-prices/docs/troubleshooting)\n\n[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-internationalizing-product-prices/updates/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-internationalizing-product-prices/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-internationalizing-product-prices/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/updates/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-internationalizing-product-prices/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-internationalizing-product-prices/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/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-internationalizing-product-prices/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/store-framework)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\nInternationalizing product prices\n\nEnsure seamless global shopping experiences by adopting ISO currency codes for international users.\n\nAs you expand your business globally, it becomes essential to properly internationalize your website's content to cater to users from different locales. One crucial aspect of internationalization is to ensure that users can easily understand product prices and make purchases without confusion caused by misleading currency conversions. To accomplish this, we will adopt the following approach: for international users, we will display prices according to the ISO standard of the currency code (e.g., `USD`), while for local users, we will use the country-specific commonly used currency symbol (e.g., `$`). This flexibility in displaying product prices will help create a user-friendly shopping experience for both local and international users.\n\n## Before you begin\n\nBefore you start the internationalization process, it's essential to understand [trade policies](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV). Trade policies contain configurations for catalog, pricing, promotions, logistics, customer segmentation, and payments for different sales strategies. If your store operates in multiple sales channels with varying settings, you need to [create a new trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-a-trade-policy--563tbcL0TYKEKeOY4IAgAE) for each unique setup. Thus, before proceeding with this guide, ensure you have set up different trade policies that align with your store's operational requirements.\n\n## Instructions\n\n1. Access the Admin.\n2. Go to **Store Settings > Channels > Trade Policies**.\n3. Find the specific trade policy to which you want to apply the international pricing configurations and click the `Edit` button.\n4. In the `Currency Code` field, select the currency code corresponding to the currency of the sales channel that uses this trade policy.\n5. In the `Locale` field, select the locale where the sales channel is located.\n6. Click `Save`.\n\n> The `Currency Decimal Places` field is optional and should be used only when you want to overwrite the number of decimal places defined by the ISO standards.\n\nOnce you save your changes, your store will automatically recognize when a user's locale differs from the one set in the `Locale` field and display prices accordingly.\n\n> The saved configuration will only apply to the selected trade policy. To replicate these configurations across all trade policies in your store, you must fill out the fields in each trade policy and save the changes.\n\nFinally, let's take the following example. Imagine a retailer based in the United States with the following configurations:\n\n* `Locale` field value: `United States (en-US)`\n* `Currency Code` value: `US Dollar (USD)`\n\nThe outcome for different user groups will be as follows:\n\n* **Local users (from the USA):** When a user's locale matches the `Locale` field (`United States (en-US)`), the currency symbol displayed for prices will be the commonly used symbol for the United States Dollar, which is `$`.\n* **International users (outside the USA):** When a user's locale does not match the `Locale` field, the store will display product prices using the currency code specified in the `Currency Code` field, which is `USD`.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-multi-language-stores/vtex-io-documentation-internationalizing-product-prices.md)\n\n[Handling internationalization« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices//docs/guides/vtex-io-multi-language-stores)[Disabling automatic translationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices//docs/guides/vtex-io-documentation-disabling-automatic-translation)\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-internationalizing-product-prices/docs/guides/vtex-io-documentation-internationalizing-product-prices%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-documentation-internationalizing-product-prices%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/vtex-io-multi-language-stores/vtex-io-documentation-internationalizing-product-prices.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-internationalizing-product-prices/docs/guides/vtex-io-documentation-internationalizing-product-prices%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-internationalizing-product-prices/docs/guides/vtex-io-documentation-internationalizing-product-prices%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_b4dd8329
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides interacting with master data v1 through vtex io services in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/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/interacting-with-master-data-v1-through-vtex-io-services/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/master-data)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/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/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services)\n\nInteracting with Master Data v1 through VTEX IO services\n\nSetting up a service in VTEX IO to interact with Master Data v1.\n\nThis guide provides step-by-step instructions on how to create a VTEX IO [service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io) to interact with [Master Data v1](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw). This solution is recommended if you need to update Master Data v1 field values based on a trigger or whenever adding or updating a document.\n\nDiscover how to effectively leverage Master Data capabilities through your service in the upcoming sections.\n\n## Before you begin\n\nMake sure you meet the technical requirements to complete this project:\n\n* Experience developing in [Typescript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/) language.\n* Having [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed.\n\n## Step 1: Initializing the project\n\nTo begin setting up your service to interact with Master Data v1 on VTEX IO, follow these steps to initialize your project using the service-example template:\n\n1. Open the terminal.\n2. Type the command `vtex init`.\n3. Select the `service-example` template.\n4. Enter a folder name or use the default name, which is the same as the selected template.\n\n## Step 2: Setting up policies\n\nConfigure permissions for your application to access Master Data by following the steps below:\n\n1. Open the project folder in your preferred code editor.\n2. Open the `manifest.json` file located at the root of the project.\n3. Add the following structure to the `policies` section: \n`1 \n{ \n2 \n \"name\": \"outbound-access\", \n3 \n \"attrs\": { \n4 \n \"host\": \"api.vtex.com\", \n5 \n \"path\": \"/dataentities/*\" \n6 \n } \n7 \n}, \n8 \n{ \n9 \n \"name\": \"ADMIN_DS\" \n10 \n} \n`\n\n## Step 3: Creating a client\n\nCreate a client class in TypeScript to extend the functionality of `MasterData` from the `@vtex/api` module:\n\n1. Inside the `node` folder, create a `clients` folder if it does not exist.\n2. Create a Typescript file in the `clients` folder. In this example, the file will be named `md.ts`.\n3. Create a class that extends from the `MasterData` class from the `@vtex/api` module. \n`1 \nimport { MasterData } from '@vtex/api' \n2 \nexport default class MD extends MasterData {} \n`\n4. Modify the class to include the constructor and headers: \nIn this class, we will call the `constructor` and, within it, the `super` method, passing the `context` and `options` received in the `constructor` class. \n`1 \nimport { IOContext, InstanceOptions, MasterData } from '@vtex/api' \n2 \n \n3 \nexport default class MD extends MasterData { \n4 \n constructor(context: IOContext, options?: InstanceOptions) { \n5 \n super(context, { \n6 \n ...options, \n7 \n headers: { \n8 \n {{app-key}} \n9 \n {{app-token}} \n10 \n }, \n11 \n }) \n12 \n } \n13 \n} \n` \nIn this class, we will have access to several methods extended from the **Master Data** class, including: \n| Method name | Description | \n| --------------------------------- | --------------------------------------------------------------------------------------------------- | \n| getDocument | Retrieves a document by its ID for a given data entity, with specified fields. | \n| createDocument | Creates a new document in the specified data entity. | \n| createOrUpdateEntireDocument | Creates or updates an entire document in the specified data entity. | \n| createOrUpdatePartialDocument | Partially creates or updates a document in the specified data entity. | \n| updateEntireDocument | Updates an entire document by its ID for a given data entity. | \n| updatePartialDocument | Partially updates a document by its ID for a given data entity. | \n| searchDocuments | Searches for documents in the specified data entity, with various search parameters and pagination. | \n| searchDocumentsWithPaginationInfo | Searches for documents and returns data with pagination information. | \n| scrollDocuments | Scrolls through documents in the specified data entity with various search parameters. | \n| deleteDocument | Deletes a document by its ID for a given data entity. |\n5. Add the desired method. The example below uses the `getDocument` method: \n`1 \npublic getDocumentById( \n2 \n dataEntity: string, \n3 \n id: string, \n4 \n fields: string[] \n5 \n): Promise<any> { \n6 \n return this.getDocument({ dataEntity, id, fields }) \n7 \n} \n`\n\n## Step 4: Registering the Client\n\nAfter creating our Client class, you need to register it in the `index.ts` file within the same `clients` folder:\n\n1. Open the `index.ts` file in the `clients` folder.\n2. Import the new client (e.g., `MD`) and add it to the `Clients` class, as exemplified below: \n`1 \nimport { IOClients } from '@vtex/api' \n2 \nimport MD from './md' \n3 \n \n4 \n// Extend the default IOClients implementation with our own custom clients \n5 \nexport class Clients extends IOClients { \n6 \n public get MD() { \n7 \n return this.getOrSet('MD', MD) \n8 \n } \n9 \n} \n`\n\n## Step 5: Creating the middleware\n\nImplement a middleware function to handle interactions between your service and Master Data, executing the method we created and returning the response based on the context:\n\n1. Inside the `node` folder, create a `middlewares` folder if it does not exist.\n2. Create a file named `masterdataMiddleware.ts` in the `middlewares` folder.\n3. Add your TypeScript code to `masterdataMiddleware.ts`. \nFollowing the example in the previous sections to illustrate this step, in this middleware, we will return the call to the method created to a variable and then add this variable to the context body. The method expects to receive an _entity_, a _document ID_, and an _array_ of fields to be returned in the response. \n`1 \nexport async function masterdataMiddleware( \n2 \n ctx: Context, \n3 \n next: () => Promise<any> \n4 \n) { \n5 \n const { \n6 \n clients: { MD }, \n7 \n } = ctx \n8 \n \n9 \n const response = await MD.getDocumentById( \n10 \n 'CL', \n11 \n '0807f150-68bb-11Ec-82ac-12fdbe358f3f', \n12 \n ['id', 'email'] \n13 \n ) \n14 \n \n15 \n ctx.status = 200 \n16 \n \n17 \n ctx.body = { \n18 \n response, \n19 \n } \n20 \n \n21 \n await next() \n22 \n} \n`\n\n## Step 6: Configuring the route\n\nConfigure a dedicated route in your service that will be accessed through your store's endpoint:\n\n1. Open the `service.json` file in the `node` folder.\n2. In the `routes` section, define the `routes` object as shown below. In this example, we will define the `path` as `/_v/md/get-document` and make this route public. \n`1 \n\"routes\": { \n2 \n \"masterdata\": { \n3 \n \"path\": \"/_v/md/get-document\", \n4 \n \"public\": true \n5 \n } \n6 \n} \n`\n3. Open the `index.ts` file in the `node` folder. \nIn this file, you will see a new instance of service created. You will register your route within the `routes` object.\n4. Register the route within the `routes` object. \n`1 \n masterdata: method({ \n2 \n GET: [masterdataMiddleware], \n3 \n }), \n`\n\n> The `masterdata` attribute is the route ID created in the `service.json` file.\n\nThe `masterdata` attribute receives a function containing an object where we can pass various middleware mappings. In this case, we will use the HTTP method **GET**, which receives an _array_ where we must declare the middleware created in previous sections.\n\n## Step 7: Running the project\n\nFinalize setup by linking your project to a development workspace and testing the configured service routes:\n\n1. In the terminal, navigate to the root of the project.\n2. Run the command `vtex link`. \nAfter linking, you should see the following message: \n`1 \n**info:** *Available service routes: https://{{workspace}}--{{accountName}}.myvtex.com/{{path}} \n`\n3. Access the service route from the previous step in your browser. \nFollowing the example of a service to retrieve a document, you should see a response with the fields defined in the middleware: \n`1 \n{ \n2 \n \"response\": { \n3 \n \"id\": \"0807f150-68bb-11Ec-82ac-12fdbe358f3f\", \n4 \n \"email\": \"john@mail.com\" \n5 \n } \n6 \n} \n`\n\n## Conclusion\n\nThese instructions enable you to configure clients, middleware, and routes to set up a VTEX IO service for interacting with Master Data v1\\. Note that there are various methods and configurations beyond this guide to further customize and optimize your integration with VTEX IO and Master Data.\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/interacting-with-master-data-v1-through-vtex-io-services.md)\n\n[Uploading files to Master Data v1« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services//docs/guides/uploading-files-to-master-data-v1)[Configuration GuidesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services//docs/guides/payments-configuration-guides)\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/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23before-you-begin)\n\n[Step 1: Initializing the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-1-initializing-the-project)\n\n[Step 2: Setting up policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-2-setting-up-policies)\n\n[Step 3: Creating a client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-3-creating-a-client)\n\n[Step 4: Registering the Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-4-registering-the-client)\n\n[Step 5: Creating the middleware](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-5-creating-the-middleware)\n\n[Step 6: Configuring the route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-6-configuring-the-route)\n\n[Step 7: Running the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-7-running-the-project)\n\n[Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23conclusion)\n\nWas this helpful?\n\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/interacting-with-master-data-v1-through-vtex-io-services.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/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23before-you-begin)\n\n[Step 1: Initializing the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-1-initializing-the-project)\n\n[Step 2: Setting up policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-2-setting-up-policies)\n\n[Step 3: Creating a client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-3-creating-a-client)\n\n[Step 4: Registering the Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-4-registering-the-client)\n\n[Step 5: Creating the middleware](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-5-creating-the-middleware)\n\n[Step 6: Configuring the route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-6-configuring-the-route)\n\n[Step 7: Running the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23step-7-running-the-project)\n\n[Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/interacting-with-master-data-v1-through-vtex-io-services/docs/guides/interacting-with-master-data-v1-through-vtex-io-services%23conclusion)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_597b3d0f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation creating a black friday page from template in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/store-framework-building-pages)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\nCreating a Black Friday page from template\n\nYou may want to create custom landing pages for big events, such as Black Friday and Cyber Monday, to compose your marketing strategy.\n\nWith that in mind, we created a landing page template for Black Friday following VTEX recommended practices to help your store maximize profits and conversions.\n\nThis guide will show you how to implement the Black Friday landing page template.\n\n> You can also base on this template to create a new or refreshed homepage for your store website.\n\n\n\n## Instructions\n\n### Step 1 - Downloading the template files\n\nDownload the template files available here: [black-friday-template-files 2021.zip](https://read.calvincode.net/reader?url=https://drive.google.com/file/d/1sNOehohokdx-GLsvjdr9tRxhm42NWZKy/view). Within it, you'll find the following folders:\n\n* `/assets` \\- Sample banners.\n* `/store/blocks/custom-template-blackfriday-lp` \\- json blocks.\n* `/style/css/custom-template-blackfriday-lp` \\- Custom page styles.\n\n### Step 2 - Integrating the template files with the Store Theme\n\n1. Open your Store Theme project using the code editor of your choice.\n2. Open your project's `manifest.json` file and declare the `\"assets\": \"0.x\"` builder on the `builders` list:\n\n`1\n\n\"builders\": { \n\n2\n\n+ \"assets\": \"0.x\", \n\n3\n\n \"styles\": \"2.x\", \n\n4\n\n \"store\": \"0.x\", \n\n5\n\n \"sitemap\": \"0.x\" \n\n6\n\n} \n\n`\n\n1. Copy and paste the code you previously downloaded into the corresponding folders of your Store Theme project.\n\n> If you are running \"styles\": \"1.x\", you must copy and paste the CSS code within its corresponding CSS files since this version doesn't allow subfolders for CSS.\n\n1. Check the code comments within the `/store/blocks/custom-template-blackfriday-lp/custom-template-blackfriday-lp.jsonc` file and add your pre-existing shelves accordingly.\n\n\n\n1. Using the terminal, run `vtex link` on your project folder.\n2. Go back to your code and customize the template as you wish.\n\n### Step 3 - Implementing the page at your store\n\n1. On your browser, open the Admin and go to **Storefront > Pages**.\n2. Click on **Create new** to create a new page.\n3. Edit the page title and URL as you wish. At the Templates section, select the `\"store.custom#blackfriday-lp\"` template.\n\nNote that the `\"store.custom#blackfriday-lp\"` template is set to be a custom page by default. If you want to apply this template as your main home page, you must first set`\"store.home#blackfriday-lp\"` on the `/custom-template-blackfriday-lp.jsonc` template file.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-creating-a-black-friday-page-from-template.md)\n\n[Building a search results page with multiple layouts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template//docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)[Creating a custom search results pageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template//docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template%23instructions)\n\n[Step 1 - Downloading the template files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template%23step-1-downloading-the-template-files)[Step 2 - Integrating the template files with the Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template%23step-2-integrating-the-template-files-with-the-store-theme)[Step 3 - Implementing the page at your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template%23step-3-implementing-the-page-at-your-store)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-creating-a-black-friday-page-from-template.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template%23instructions)\n\n[Step 1 - Downloading the template files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template%23step-1-downloading-the-template-files)[Step 2 - Integrating the template files with the Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template%23step-2-integrating-the-template-files-with-the-store-theme)[Step 3 - Implementing the page at your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template%23step-3-implementing-the-page-at-your-store)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e5ee5be7
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides profile system in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system)\n\n[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/working-with-schemas-in-the-profile-system)\n\n[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\n[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/data-protection-plus)\n\n[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/pii-data-architecture-specifications)\n\n[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/data-residency)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system)\n\n[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/working-with-schemas-in-the-profile-system)\n\n[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)\n\n[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides)\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/data-protection-plus)\n\n[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system)\n\nProfile System integration\n\n> [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus) is in closed beta phase, only available in select regions. \n> \n> This feature is part of [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/contact/).\n\nThe **Profile System** is VTEX's single source of truth regarding shoppers' profile data for stores using [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus). Other modules, such as **Checkout** and **Order Management**, can request data from the **Profile System** when necessary.\n\nThe Profile System API enables stores to:\n\n* Communicate with a single source of truth for shoppers' data.\n* Safely store PII and sensitive information.\n\nBelow you can learn more about some of the Profile System's features and how to integrate with the APIs.\n\n> Data stored in the new Profile System is not related to documents saved in [Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api) or [Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2). The API endpoints and features described in this article only apply to documents registered in the new Profile System designed to handle PII data architecture.\n\n## Before you begin\n\n* Check the [changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data) that impact other integrations.\n* Check the [current limitations related to PII data architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta). Note that, at the moment, [Master Data triggers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-trigger-in-master-data--tutorials%5F1270) are not supported by the PII platform version Profile System, for example.\n\n## Permission\n\nTo use the Profile System features, ensure you have the appropriate [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) enabled for that user.\n\n| Product | Category | Resource | Description |\n| -------------- | --------- | -------------------- | ------------------------------------ |\n| Profile System | Documents | Get Item | Get items in Profile System entities |\n| Profile System | Documents | Save and Update Item | Edit items from Profile System. |\n| Profile System | Documents | Delete Item | Delete items from Profile System. |\n\n> Learn more about 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).\n\n## Auditability\n\nYou can use the [Audit app](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/searching-for-events-on-audit--5RXf9WJ5YLFBcS8q8KcxTA) to check actions made using the Profile System in your account.\n\n> Learn more about [how to audit actions in the VTEX platform](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/searching-for-events-on-audit--5RXf9WJ5YLFBcS8q8KcxTA).\n\nSee the table below to learn more about the Profile System events available on Audit.\n\n| Action | Description | Event details |\n| -------------------------------- | -------------------------------------------------------------------- | ---------------------------------- |\n| GetAddressUnmasked | Retrieval of an unmasked address. | Address ID. |\n| GetAddressVersionUnmasked | Retrieval of an unmasked address by ID and version. | Address ID and version ID. |\n| GetContactsUnmasked | Retrieval of unmasked contact information. | Contact ID. |\n| GetContactsVersionUnmasked | Retrieval of unmasked contact information by ID and version. | Contact ID and version ID. |\n| GetInvoiceSubjectUnmasked | Retrieval of unmasked invoice subject information. | Invoice subject ID. |\n| GetInvoiceSubjectVersionUnmasked | Retrieval of unmasked invoice subject information by ID and version. | Invoice subject ID and version ID. |\n| GetPickupInfoUnmasked | Retrieval of unmasked pickup point information. | Pickup point ID. |\n| GetPickupInfoVersionUnmasked | Retrieval of unmasked pickup point information by ID and version. | Pickup point ID and version ID. |\n| GetProfileUnmasked | Retrieval of an unmasked profile. | Profile ID. |\n| GetProfileVersionUnmasked | Retrieval of an unmasked profile by ID and version. | Profile ID and version ID. |\n| PutSchema | Schema modification. | Schema ID. |\n| ProfileSystemUserRightsDelete | Deletion of a user profile. | Profile ID. |\n\n## TTL\n\nProfile System documents have a defined TTL, which means Time To Live. This means that whenever a customer creates a profile, it will be deleted after the TTL has passed from the time of its creation.\n\nYou may set a document's TTL, with the query parameter `ttl` allowed for requests that create or update documents.\n\n## Alternative keys\n\nShopper profiles and addresses are accessible via API by a unique `profileId`. However, it is also possible to use alternative keys. Currently, there are two allowed alternative keys:\n\n* `email`\n* `document`\n\n> Note that, in this context, the `document` field means the document number registered by the store customer.\n\nTo do this, you must replace the `profileId` path parameter with the key of your choice and send the name of the field that will be used in the query parameter `alternativeKey`.\n\n## Masked data\n\nAfter registering customer information to the Profile System, such as profile and address, it will be returned as masked by the default `GET` requests.\n\nThere are specific endpoints from which to get unmasked data. When using those, mind this query parameter:\n\n| Parameter | Required | Type | Description |\n| --------- | -------- | ------ | ------------------------------------ |\n| reason | Yes | String | Reason for requesting unmasked data. |\n\nMasked profile example\n\n`1\n\n{ \n\n2\n\n \"id\": \"70caf394-8534-447e-a0ca-1803c669c771\", \n\n3\n\n \"meta\": { \n\n4\n\n \"version\": \"abc\", \n\n5\n\n \"author\": \"e40e0b6d-0605-4fa6-8176-1d69fbaf0818\", \n\n6\n\n \"creationDate\": \"13/12/2021T00:00:00Z\", \n\n7\n\n \"lastUpdate\": \"13/12/2021T00:00:00Z\" \n\n8\n\n }, \n\n9\n\n \"document\": { \n\n10\n\n \"firstName\": \"J***\", \n\n11\n\n \"lastName\": \"D**\", \n\n12\n\n \"email\": \"j***.d**@e******.c**\", \n\n13\n\n \"birthDate\": \"1925-11-17\", \n\n14\n\n \"document\": \"1**********\", \n\n15\n\n \"documentType\": \"CPF\" \n\n16\n\n } \n\n17\n\n} \n\n`\n\nUnmasked profile example\n\n`1\n\n{ \n\n2\n\n \"id\": \"70caf394-8534-447e-a0ca-1803c669c771\", \n\n3\n\n \"document\": { \n\n4\n\n \"firstName\": \"John\", \n\n5\n\n \"lastName\": \"Doe\", \n\n6\n\n \"email\": \"john.doe@example.com\", \n\n7\n\n \"birthDate\": \"1925-11-17\", \n\n8\n\n \"document\": \"12345678911\", \n\n9\n\n \"documentType\": \"CPF\" \n\n10\n\n }, \n\n11\n\n \"meta\": { \n\n12\n\n \"version\": \"abc\", \n\n13\n\n \"author\": \"e40e0b6d-0605-4fa6-8176-1d69fbaf0818\", \n\n14\n\n \"creationDate\": \"13/12/2021T00:00:00Z\", \n\n15\n\n \"lastUpdate\": \"13/12/2021T00:00:00Z\" \n\n16\n\n } \n\n17\n\n} \n\n`\n\n## Profile System API reference\n\nThere are several APIs you can integrate with in order to manage information regarding profiles and addresses. Below you can find some examples and links to the detailed API reference.\n\n### Profiles\n\nA profile is the main entity where a given customer’s data is stored.\n\n* `POST` [Create client profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23post-/api/storage/profile-system/profiles)\n* `GET` [Get profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-)\n* `PATCH` [Update client profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23patch-/api/storage/profile-system/profiles/-profileId-)\n* `DELETE` [Delete client profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23delete-/api/storage/profile-system/profiles/-profileId-)\n* `GET` [Get unmasked profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/unmask)\n* `GET` [Get profile by version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/versions/-profileVersionId-)\n* `GET` [Get unmasked profile by version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/versions/-profileVersionId-/unmask)\nExample request body for profile creation\n\n`1\n\n{ \n\n2\n\n \"firstName\": \"John\", \n\n3\n\n \"lastName\": \"Doe\", \n\n4\n\n \"email\": \"john.doe@example.com\", \n\n5\n\n \"birthDate\": \"1925-11-17\", \n\n6\n\n \"document\": \"12345678911\", \n\n7\n\n \"documentType\": \"CPF\" \n\n8\n\n} \n\n`\n\nExample response when getting unmasked profile\n\n`1\n\n{ \n\n2\n\n \"id\": \"70caf394-8534-447e-a0ca-1803c669c771\", \n\n3\n\n \"document\": { \n\n4\n\n \"firstName\": \"John\", \n\n5\n\n \"lastName\": \"Doe\", \n\n6\n\n \"email\": \"john.doe@example.com\", \n\n7\n\n \"birthDate\": \"1925-11-17\", \n\n8\n\n \"document\": \"12345678911\", \n\n9\n\n \"documentType\": \"CPF\" \n\n10\n\n }, \n\n11\n\n \"meta\": { \n\n12\n\n \"version\": \"abc\", \n\n13\n\n \"author\": \"e40e0b6d-0605-4fa6-8176-1d69fbaf0818\", \n\n14\n\n \"creationDate\": \"13/12/2021T00:00:00Z\", \n\n15\n\n \"lastUpdate\": \"13/12/2021T00:00:00Z\" \n\n16\n\n } \n\n17\n\n} \n\n`\n\n### Addresses\n\nAddresses are linked to profiles and any profile can have as many addresses as it might need. This means that a valid `profileId` is necessary to perform any action regarding addresses.\n\n* `POST` [Create client address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23post-/api/storage/profile-system/profiles/-profileId-/addresses)\n* `GET` [Get client addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/addresses)\n* `GET` [Get unmasked client addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/addresses/unmask)\n* `GET` [Get address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)\n* `PATCH` [Update client address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23patch-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)\n* `DELETE` [Delete address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23delete-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-)\n* `GET` [Get unmasked address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/unmask)\n* `GET` [Get address by version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/versions/-addressVersionId-)\n* `GET` [Get unmasked address by version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/addresses/-addressId-/versions/-addressVersionId-/unmask)\nExample request body for address creation\n\n`1\n\n{ \n\n2\n\n \"postalCode\": \"20200-000\", \n\n3\n\n \"countryName\": \"Brasil\", \n\n4\n\n \"countryCode\": \"BR\", \n\n5\n\n \"administrativeAreaLevel1\": \"RJ\", \n\n6\n\n \"locality\": \"Locality\", \n\n7\n\n \"localityAreaLevel1\": \"locality area\", \n\n8\n\n \"route\": \"51\", \n\n9\n\n \"streetNumber\": \"999\", \n\n10\n\n \"profileId\": \"70caf394-8534-447e-a0ca-1803c669c771\" \n\n11\n\n} \n\n`\n\nExample response when getting unmasked address\n\n`1\n\n{ \n\n2\n\n \"id\": \"bf82180e-cf9e-4089-9af6-ae1518555992\", \n\n3\n\n \"document\": { \n\n4\n\n \"postalCode\": \"20200-000\", \n\n5\n\n \"countryName\": \"Brasil\", \n\n6\n\n \"countryCode\": \"BR\", \n\n7\n\n \"administrativeAreaLevel1\": \"RJ\", \n\n8\n\n \"locality\": \"Locality\", \n\n9\n\n \"localityAreaLevel1\": \"locality area\", \n\n10\n\n \"route\": \"51\", \n\n11\n\n \"streetNumber\": \"999\", \n\n12\n\n \"profileId\": \"70caf394-8534-447e-a0ca-1803c669c771\" \n\n13\n\n }, \n\n14\n\n \"meta\": { \n\n15\n\n \"version\": \"c9c44895-4589-4d0d-a28d-e0e656ca1926\", \n\n16\n\n \"author\": \"80aa79a3-aa89-4912-a20e-8ef69af19a6c\", \n\n17\n\n \"creationDate\": \"2022-01-18T18:51:34.1293829+00:00\", \n\n18\n\n \"lastUpdateDate\": \"2022-01-18T18:51:34.1293829+00:00\" \n\n19\n\n } \n\n20\n\n} \n\n`\n\n### Prospects\n\n* `POST` [Create prospect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23post-/api/storage/profile-system/prospects)\n* `GET` [Get prospects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/prospects)\n* `GET` [Get unmasked prospects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/prospects/unmask)\n* `GET` [Get prospect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/prospects/-prospectId-)\n* `PATCH` [Update prospect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23patch-/api/storage/profile-system/prospects/-prospectId-)\n* `DELETE` [Delete prospect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23delete-/api/storage/profile-system/prospects/-prospectId-)\n* `GET` [Get unmasked prospect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/prospects/-prospectId-/unmask)\n\n### Purchase information\n\n* `POST` [Create purchase information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23post-/api/storage/profile-system/profiles/-profileId-/purchase-info)\n* `GET` [Get purchase information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/purchase-info)\n* `PATCH` [Update purchase information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23patch-/api/storage/profile-system/profiles/-profileId-/purchase-info)\n* `DELETE` [Delete purchase information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23delete-/api/storage/profile-system/profiles/-profileId-/purchase-info)\n* `GET` [Get unmasked purchase information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/profiles/-profileId-/purchase-info/unmask)\n\n### Schemas\n\nA JSON Schema defines the structure of data stored in the Profile System. It determines, for example, which fields a profile has and their respective formats. Read [Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system) for more information.\n\nThe following endpoints allow you to interact with the profile schema:\n\n* `GET` [Get full schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/schemas/profileSystem)\n* `PUT` [Create or delete custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23put-/api/storage/profile-system/schemas/profileSystem/custom)\n* `GET` [Get custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/schemas/profileSystem/custom)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/PedroAntunesCosta)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/profile-system.md)\n\n[Data residency« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system//docs/guides/data-residency)[Working with schemas in the Profile SystemNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system//docs/guides/working-with-schemas-in-the-profile-system)\n\nSee also\n\n[Data Protection PlusGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/data-protection-plus)[Changes in VTEX features behavior to handle PII dataGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)[PII Data Architecture specificationsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/pii-data-architecture-specifications)[Limitations of the PII data architecture during closed betaGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)[Data residencyGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/data-residency)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/PedroAntunesCosta)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23before-you-begin)\n\n[Permission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23permission)\n\n[Auditability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23auditability)\n\n[TTL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23ttl)\n\n[Alternative keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23alternative-keys)\n\n[Masked data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23masked-data)\n\n[Profile System API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23profile-system-api-reference)\n\n[Profiles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23profiles)[Addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23addresses)[Prospects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23prospects)[Purchase information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23purchase-information)[Schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23schemas)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/profile-system.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/profile-system/docs/guides/profile-system%23before-you-begin)\n\n[Permission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23permission)\n\n[Auditability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23auditability)\n\n[TTL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23ttl)\n\n[Alternative keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23alternative-keys)\n\n[Masked data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23masked-data)\n\n[Profile System API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23profile-system-api-reference)\n\n[Profiles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23profiles)[Addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23addresses)[Prospects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23prospects)[Purchase information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23purchase-information)[Schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system/docs/guides/profile-system%23schemas)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_9ae7d517
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides create a regular order using the checkout api in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/orders-2)\n\n[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api)\n\n[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-from-an-existing-cart)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/orders-2)\n\n[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api)\n\n[Creating a regular order from an existing cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-from-an-existing-cart)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/checkout-api-overview)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/orders-2)\n\n[Creating a regular order with the Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api)\n\nCreating a regular order with the Checkout API\n\nLearn how to use VTEX APIs to efficiently handle the placement, payment, and delivery aspects of a regular order.\n\nThis step-by-step guide will walk you through the process of using the [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) for handling the placement, payment, and delivery aspects of a regular order, with all responsibilities managed within the scope of a single account. It is divided into the following steps:\n\n1. **Assess cart requirements:** Begin by simulating a cart to assess available delivery and payment options. This step also involves checking whether the provided email address is already associated with an existing customer, which is required to place an order.\n2. **Assemble the cart:** Continue by building the cart, ensuring that all essential order details are properly structured according to the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) data structure.\n3. **Handle the order:** Place the order on the VTEX platform and send all required payment data to process the payment for the order.\n4. **Process and validate the order:** The process concludes with the processing of order details and a verification procedure to confirm the order's successful placement.\n\n## Before you begin\n\nBefore proceeding any further, ensure that you have a valid `appKey` and `appToken` with the necessary permissions to access the [Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) and [Payments Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) APIs. For more information, refer to the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) article.\n\n> Click the steps below to navigate through this article and explore specific topics. Relevant code for each phase or parameter is highlighted on the right side of the screen.\n\n## Step 1 - Assessing cart requirements\n\nIn this step, we will verify that your store can fulfill the cart requirements and collect the essential order details necessary to ensure a smooth order placement process in the subsequent steps.\n\n### Simulating a cart\n\nUse the [Cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForms/simulation) endpoint to obtain the available delivery and payment options for the current cart configuration. In this request, you must provide the following information in the request body:\n\n* `items.id`: SKU ID.\n* `items.quantity`: The number of items in the cart.\n* `items.seller`: Seller's ID.\n* `country`: Three-letter ISO code of the country of the shipping address.\n* `postalCode` or `geoCoordinates`: Shipping address's postal code or geocoordinates.\n\nUpon receiving a `200 OK` response, the request will provide a response body containing all information about the cart. Take note of the following information, as it will be used in the following steps:\n\n* `items`\n* `paymentData`\n* `logisticsInfo`\n\n### Checking for existing customer\n\nSend a request to the [Get client by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/profiles) endpoint to ensure a customer profile exists in your database associated with the email to be used in the order.\n\nUpon receiving a `200 OK` response, the request will provide a response body containing all information about the customer profile. Take note of the following information, as it will be used in the following steps:\n\n* `availableAddresses`\n* `userProfile`\n\n> If the response body fields are empty in this request, it may indicate that no customer is registered under this email, or that the customer profile is invalid or incomplete. In this case, you can use a different email address or enter data for a new customer when assembling the cart.\n\n## Step 2 - Assembling the cart\n\nIn this step, we will arrange the order details into the specified data format, following the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) data structure. This formatted cart data will be used as the request body in the following steps.\n\nBelow, we will briefly examine the key elements that make up the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields), which include:\n\n* `items`\n* `clientProfileData`\n* `shippingData.address`\n* `shippingData.logisticsInfo`\n* `paymentData`\n\n> While an `orderForm` may include various elements, a standard order generally comprises the key components described above.\n\n### `items`\n\n`items` is an array that contains all data pertinent to the SKUs being purchased. Build the `items` array using the `items` array obtained from the [Simulating a cart](#simulating-a-cart) step. For more complex examples, see the [Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) API reference.\n\n### `clientProfileData`: New customers\n\n`clientProfileData` is an object that contains information about the customer. If you noted the customer does not exist in your database during the [Checking for existing customer](#checking-for-existing-customer) step, build the `clientProfileData` object with the data of the new customer willing to place the order.\n\n### `clientProfileData`: Existing customers\n\nIf the customer already exists in your database, use the `userProfile.email` obtained in the [Checking for existing customer](#checking-for-existing-customer) step to build the `clientProfileData` object. The email address is enough to register the order to the shopper’s existing account.\n\n### `shippingData.address`: New customers\n\n`shippingData.address` is an object that contains information about the shipping address. If you noted the customer does not exist in your database during the [Checking for existing customer](#checking-for-existing-customer) step, build the `shippingData.address` object with the data of the new customer willing to place the order.\n\n### `shippingData.address`: Existing customers\n\nIf the customer already exists in your database, use the desired `availableAddresses[i].addressId` obtained from the [Checking for existing customer](#checking-for-existing-customer) step to build the `shippingData.address` block.\n\n### `shippingData.logisticsInfo`\n\n`logisticsInfo` is an array that contains logistics information, such as the desired delivery option and freight cost for each item in the `items` array.\n\n* Create the `logisticsInfo` array with the same number of objects as in the `items` array. For each object within the `logisticsInfo` array, define the following elements: \n * `itemIndex` \\- index of the corresponding item in the `items` array. For example, the object referring to the first item in the `items` array has an `itemIndex` of `0`. \n * `selectedSla` \\- desired delivery option. You can find the `id` value of the available options in the `slas` array obtained from the [Simulating a cart](#simulating-a-cart) step. \n * `price` \\- price of the item. You can retrieve this value from the [Simulating a cart](#simulating-a-cart) step. \n * (Optional) If the delivery method is pickup point, add the information `\"selectedDeliveryChannel\": \"pickup-in-point\"`.\n\n### `paymentData.payments`\n\n`paymentData.payments` is an array that contains information regarding the chosen payment method and installment preferences for the order. Build the `paymentData.payments` array considering the response obtained from the [Simulating a cart](#simulating-a-cart) step. For each payment option, define the following elements:\n\n* `paymentSystem` \\- ID of the desired payment system.\n* `referenceValue` \\- reference value used to calculate interest rates. If no interest applies to the order, the `value` and `referenceValue` should be the same.\n* `value` \\- total amount to be paid by the shopper.\n* `installments` \\- number of installments.\n\nFor more complex examples, see the [Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) API reference.\n\n## Step 3 - Handling the order\n\nBefore creating the new order, it is necessary to verify that the `orderForm` created in the previous steps has the appropriate structure in a valid JSON format.\n\n### New customer `orderForm`\n\nIf the `orderForm` was created for a new customer (not yet registered in the store's database), it should follow this structure.\n\n### Existing customer `orderForm`\n\nIf the `orderForm` was created for an existing customer who already has a customer profile registered in the store's database, it should follow this structure.\n\n### Placing the order\n\nPlace a new order via the [Place order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) endpoint using the `orderForm` you built as the request body.\n\nUpon receiving a `201 Created` response, take note of these five pieces of information:\n\n* `transactionId` \\- ID of the transaction, which can be found within an object contained in the `merchantTransactions` array.\n* `orderId` \\- ID of the order within VTEX’s Order Management System (OMS). You can find the `orderId` within each object in the `orders` array.\n* `orderGroup` \\- ID that groups all orders related to the same purchase. For example, when an order is fulfilled by multiple sellers, each seller has its own order ID (`v71021570str-01` and `v71021570str-02`), but they share the same order group ID (`v71021570str`).\n* `addressId` \\- ID of the customer address. If you plan to use the same address for both shipping and billing, get the `addressId` from the `orders[].shippingData.address` object.\n* `Vtex_CHKO_Auth` \\- authentication cookie provided in the response.\n\n> If you are using an email from an existing customer, ensure that the corresponding customer account is logged into your store. Otherwise, the process will fail.\n\n### Resolving the order payment\n\nNow, we will communicate the necessary payment data to VTEX to finalize the order payment.\n\n> Starting from the moment the order is placed, you have 5 minutes to submit the payment information and process the order (Step 4). If the payment information and order are not submitted and processed within 5 minutes, the order will be automatically canceled.\n\n* Send a request to the [Send payments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api%23post-/api/payments/transactions/-transactionId-/payments) endpoint, considering the following: \n * Use the `transactionId` value from the previous step as both the path parameter and the value for the `id` field within the `transaction` object. \n * Set the `merchantName` field within the `transaction` object to your account name. \n * Use the `orderId` value from the previous step as a query string parameter. \n * Ensure that the request body is based on the `paymentData` section of your `orderForm`. \n * In the `fields` object, you can: \n * Fill in the credit or debit card information (when applicable). \n * Use the `addressId` field to reference an existing address, or provide a new `address` object for an entirely new address. This type of information is only required if the shopper's address was not previously entered during checkout.\n\n> This request does not return any data in the response body, only a `201 Created` success confirmation message.\n\n## Step 4 - Processing and validating the order\n\nIn this final step, we will process the order.\n\n* Send a request to the [Process order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/gatewayCallback/-orderGroup-) endpoint, using the `orderGroup` value as a path parameter.\n\n> If the payment is processed without any issues, the order should be successfully placed (`204 No Content` status). Otherwise, a `500 Internal Server Error` message might occur.\n\n> Note that this process uses the gateway connectors configured in your VTEX environment. Be careful to prevent any unwanted charges or unexpected payment denials.\n\n### Verifying the order placement\n\nFinally, you can confirm if your order was correctly placed by checking the [Order management](https://read.calvincode.net/reader?url=https://newhelp.vtex.com/docs/tutorials/all-orders) in VTEX Admin. Alternatively, you can use the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) and [List orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders) endpoints for this purpose.\n\nShell\n\nPython\n\nNode.js\n\n`1\n\ncurl --request post \\ \n\n2\n\n --url 'https://{accountName}.{environment}.com.br/api/checkout/pub/orderForms/simulation?RnbBehavior=0' \\ \n\n3\n\n --header 'Accept: application/json' \\ \n\n4\n\n --header 'Content-Type: application/json' \\ \n\n5\n\n --header 'X-VTEX-API-AppKey: {appKey}' \\ \n\n6\n\n --header 'X-VTEX-API-AppToken: {appToken}' \\ \n\n7\n\n --data '{\"items\":[{\"id\":\"1\",\"quantity\":1,\"seller\":\"1\"}],\"country\":\"BRA\",\"postalCode\":\"12345-000\",\"geoCoordinates\":[-47.924747467041016]}' \n\n`\n\nResponse\n\n`1\n\n{ \n\n2\n\n \"items\": [], \n\n3\n\n \"ratesAndBenefitsData\": {}, \n\n4\n\n \"paymentData\": {}, \n\n5\n\n \"selectableGifts\": [], \n\n6\n\n \"marketingData\": {}, \n\n7\n\n \"postalCode\": string, \n\n8\n\n \"country\": string, \n\n9\n\n \"logisticsInfo\": [], \n\n10\n\n \"messages\": [], \n\n11\n\n \"purchaseConditions\": {}, \n\n12\n\n \"pickupPoints\": [], \n\n13\n\n \"subscriptionData\": string, \n\n14\n\n \"totals\": [], \n\n15\n\n \"itemMetadata\": {}, \n\n16\n\n \"sellers\": [], \n\n17\n\n \"allowMultipleDeliveries\": boolean, \n\n18\n\n \"minimumOrderValue\": number \n\n19\n\n} \n\n`\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/creating-a-regular-order-with-the-checkout-api.mdx)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/creating-a-regular-order-with-the-checkout-api.mdx)\n\n[Order Placement« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api//docs/guides/orders-2)[Creating a regular order from an existing cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api//docs/guides/creating-a-regular-order-from-an-existing-cart)\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23before-you-begin)\n\n[Step 1 - Assessing cart requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-1-assessing-cart-requirements)\n\n[Simulating a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23simulating-a-cart)[Checking for existing customer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23checking-for-existing-customer)\n\n[Step 2 - Assembling the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-2-assembling-the-cart)\n\n[items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23items)[clientProfileData: New customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23clientprofiledata-new-customers)[clientProfileData: Existing customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23clientprofiledata-existing-customers)[shippingData.address: New customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23shippingdataaddress-new-customers)[shippingData.address: Existing customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23shippingdataaddress-existing-customers)[shippingData.logisticsInfo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23shippingdatalogisticsinfo)[paymentData.payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23paymentdatapayments)\n\n[Step 3 - Handling the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-3-handling-the-order)\n\n[New customer orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23new-customer-orderform)[Existing customer orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23existing-customer-orderform)[Placing the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23placing-the-order)[Resolving the order payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23resolving-the-order-payment)\n\n[Step 4 - Processing and validating the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23step-4-processing-and-validating-the-order)\n\n[Verifying the order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-regular-order-using-the-checkout-api/docs/guides/creating-a-regular-order-with-the-checkout-api%23verifying-the-order-placement)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_8c9a2f5b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides erp integration import prices in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides)\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-guide)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices)\n\nImport prices\n\nLearn how to send pricing information to VTEX.\n\nIn this step, you will send the current pricing information for all your products to VTEX.\n\n## Before you begin\n\nIt is common for store owners to delegate price calculations to the ERP. In such scenarios, the ERP is responsible for calculating the price of each SKU and sending this price to VTEX.\n\nAs mentioned in the [Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products) step, Trade Policies are used in VTEX to differentiate the catalog, prices and logistics settings for each sales channel connected to your store. You may use them, for example, if you want the same list of SKUs to have different prices in each marketplace where your store is selling.\n\nIt’s also important to understand our [Pricing system architecture](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/7GptzvlPDVM11ojEjywIQx), based on three basic concepts:\n\n* **Prices**: the amount of money for which SKUs are listed for sale\n* **Price Tables**: a container that stores prices that should be applied in a given context\n* **Price Table Context**: conditions for application of a price table, such as a trade policy\n\nAlso, given a specific Price Table is selected according to the context, there are some definitions that should be known to understand the [computed price](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/7GptzvlPDVM11ojEjywIQx%23computed-price):\n\n* **List price**: value displayed as the suggested retail price proposed by the supplier\n* **Base price**: reference value for the computed price of an SKU in all contexts\n* **Computed price**: retail price after applying the [price rules](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/2rBirbpB7wLnei4dQ9KGMW) of a specific context\n* **Fixed price**: fixed value that overrides the computed price for an SKU in a price table\n\n|  |\n| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| The computed Price is obtained from the application of price rules on a base price. |\n\n|  |\n| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| A fixed price overrides the computed price for an SKU in a price table. |\n\nSo if you decide not to use price rules to compute your prices in VTEX, the way to do it is to send a single **base price** for each SKU sent by your ERP and set multiple **fixed prices** as needed to differentiate the value charged for each trade policy. If you would like a conceptual overview of our Pricing module, check out the [beginner track](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP) in our Help Center.\n\n## Set base price\n\nTo set the base price for an SKU, you should use the [Create/Edit Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api%23put-/prices/-itemId-) endpoint in the Pricing API.\n\nYou should set a base price for each SKU. In between steps, you can use the [Get Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api%23get-/prices/-itemId-) endpoint or visit the _Products > Prices > Price list_ section of your Admin panel to check on your progress.\n\n> In the same [Create/Edit Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api%23put-/prices/-itemId-) request, you may optionally set a list price. Additionally, you may set either a cost price or a markup value. By defining either one of them, the other will be calculated to conform to the formula `basePrice = costPrice * (1 + markup)`.\n\n## Set fixed prices for specific contexts\n\nTo set a fixed price for a specific context, you should use the [Create / Edit Fixed Prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api%23post-/prices/-itemId-/fixed/-priceTableId-) endpoint in the Pricing API. This context is represented by either a Trade Policy or a custom Price Table, which can be associated to a campaign or a customer cluster.\n\nYou should set a fixed price for each price table / SKU combination that needs to be priced differently from the base price. In between steps, you can use the [Get Fixed Prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api%23get-/prices/-itemId-/fixed) endpoint or visit the _Products > Prices > Price list_ section of your Admin panel to check on your progress.\n\n> The `tradePolicyId` parameter should be filled in with the Price Table name if you want to set fixed prices for a custom Price Table that is not associated with a specific Trade Policy.\n\n> Keep in mind that [price rules](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/prices-101--6f8pwCns3PJHqMvQSugNfP/2rBirbpB7wLnei4dQ9KGMW) might be a better option than fixed prices if you are consistently applying the same criteria for SKUs in the same category, brand or markup range.\n\n## Wrapping up\n\nIf you’ve done things correctly, you should have imported all your prices, including the base prices for your products and the fixed prices that should be applied in specific contexts.\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/erp-integration-guide/erp-integration-import-prices.md)\n\n[Set up catalog« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices//docs/guides/erp-integration-set-up-catalog)[Import inventoryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices//docs/guides/erp-integration-import-inventory)\n\nSee also\n\n[Pricing APIAPI Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/api-reference/pricing-api%23overview)[Import productsGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-products)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices%23before-you-begin)\n\n[Set base price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices%23set-base-price)\n\n[Set fixed prices for specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices%23set-fixed-prices-for-specific-contexts)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices%23wrapping-up)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/erp-integration-import-prices.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices%23before-you-begin)\n\n[Set base price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices%23set-base-price)\n\n[Set fixed prices for specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices%23set-fixed-prices-for-specific-contexts)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices/docs/guides/erp-integration-import-prices%23wrapping-up)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_9ed72f8f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain troubleshooting i cant install vtex io cli in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)\n\n[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)\n\n[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)\n\n[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/unable-to-access-headless-cms)\n\n[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)\n\n[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-install-vtex-io-cli)\n\n[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\n[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)\n\n[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)\n\n[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)\n\n[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)\n\n[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)\n\n[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)\n\n[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)\n\n[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)\n\n[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-create-a-new-workspace)\n\n[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)\n\n[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-dont-see-my-store-theme-changes)\n\n---\n\nStore performance\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting)\n\nDevelopment\n\nI can't install VTEX IO CLI\n\nWhen installing VTEX IO CLI, it returns \"Error: Cannot find module vtex\".\n\n**Keywords:** VTEX IO CLI | Plugins\n\nWhen [installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install), I get the following error message: `Error: Cannot find module ‘vtex’`.\n\nThis error is related to [plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins) detached from the VTEX IO CLI base code.\n\nEven though plugins are decoupled from VTEX IO CLI, they rely on the CLI features. Therefore, this error indicates that these plugins fail to access VTEX IO CLI features.\n\n## Solution\n\nTo solve this problem, follow these steps:\n\n1. Run `vtex --version` to ensure you are using the [latest CLI version](https://read.calvincode.net/reader?url=https://github.com/vtex/toolbelt/blob/3.x/CHANGELOG.md) available.\n2. If not, consider [updating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update) it.\n3. If the problem persists, follow the steps below based on your operating system:\n* MacOS: \n 1. Create a [symlink](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Symbolic%5Flink) from {vtex-folder}/node\\_modules/vtex to {vtex-folder}/. \n 2. Run the following command in the terminal: \n`1 \nln -s /usr/local/Cellar/vtex/2.119.2/libexec /usr/local/Cellar/vtex/2.119.2/libexec/node_modules/vtex \n`\n* Linux: \n 1. Create a [symlink](https://read.calvincode.net/reader?url=https://en.wikipedia.org/wiki/Symbolic%5Flink) from {vtex-folder}/node\\_modules/vtex to {vtex-folder}/. \n 2. Run the following command in the terminal: \n`1 \nln -s /usr/local/lib/vtex /usr/local/lib/vtex/node_modules/vtex \n`\n* Windows: \n 1. Run the `yarn global bin` command in your terminal. \n The expected output is a path that indicates where globally installed Yarn packages are stored on your computer. It might follow the pattern: `{UserProfileDirectory}\\AppData\\Local\\Yarn\\bin`, where `{UserProfileDirectory}` refers to your user profile directory, typically found at `C:\\Users\\{YourUserName}` on Windows systems. \n In the example below, the output is `C:\\Users\\Barbara Celi\\AppData\\Local\\Yarn\\bin` \n  \n 2. Copy the path that the terminal returned after running the `yarn global bin` command. \n 3. In the Windows search bar, type **Edit the system environment variables**. \n 4. Click **Open**. \n  \n 5. In the **System Properties** settings, go to the **Advanced** section and click **Environment Variables**. \n  \n 6. In the **Environment Variables** settings, double-click **Path**. \n > If you want to configure the variables only for your user, click Path within **User variables for {your.user}**. If the configuration is for all system users, click Path within **System variables**. \n  \n 7. In the **Edit environment variable** settings, click **New**. \n  \n 8. Paste the path copied in step 2. \n 9. Click **OK**. \n  \nIf the error persists, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk).\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\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/troubleshooting/development/i-cant-install-vtex-io-cli.md)\n\n[I can’t install the Headless CMS plugins in my account« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)[I can’t integrate my external Search ProviderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-integrate-my-external-search-provider)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-install-vtex-io-cli%23solution)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-cant-install-vtex-io-cli.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-install-vtex-io-cli/docs/troubleshooting/i-cant-install-vtex-io-cli%23solution)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_a9ae54aa
|
[
{
"role": "system",
"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 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/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/docs/api-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/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/docs/storefront-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/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/docs/troubleshooting)\n\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/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/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/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/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/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/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/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/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/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/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/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/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/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/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/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/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/guides/basic-components)\n\nSearch\n\nOfficial extension\n\nVersion: 2.18.8\n\nLatest version: 2.18.8\n\n[](#contributors-)\n\nThe VTEX Search app handles the new [**Intelligent Search**](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search) solution in IO stores by providing new UI components to enhance the search experience, such as the autocomplete feature.\n\n\n\n## Configuration\n\nThe Search app requires the `vtex.admin-search@1.x` and `vtex.search-resolver@1.x` apps to be installed in your store. For more information, read the [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search) documentation.\n\nTo configure the Search app, see the sections below.\n\n### Adding the Search app to your theme dependencies\n\nAdd the `search` app to your theme dependencies in the `manifest.json` as shown below:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.search\": \"2.x\" \n\n3\n\n } \n\n`\n\nYou can now use all blocks exported by the `search` app. See the full list below:\n\n| Block name | Description |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| autocomplete-result-list.v2 | Provides customized autocomplete features in the search bar component, such as top searches, search history, product suggestions, or term suggestions. You can read more about the Intelligent Search [autocomplete feature](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL) in the VTEX Help Center. |\n| search-banner | Renders a customized banner based on the search query. |\n| did-you-mean | Helps users with possible misspelling corrections for the current search query. |\n| search-suggestions | Renders a list of similar search terms for the current search. |\n\n> The `search-banner`, `did-you-mean`, and `search-suggestions` blocks require [Search Result app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) version `3.x` or higher installed in your theme.\n\n### Adding Search blocks to the theme\n\nFirst, declare the `autocomplete-result-list.v2` block as a child block of the [search-bar block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/searchbar), exported by the Store Components app. Example:\n\n`1\n\n{ \n\n2\n\n \"search-bar\": { \n\n3\n\n \"blocks\": [\"autocomplete-result-list.v2\"], \n\n4\n\n \"props\": { \n\n5\n\n \"openAutocompleteOnFocus\": true \n\n6\n\n } \n\n7\n\n } \n\n8\n\n} \n\n`\n\n#### `autocomplete-result-list.v2` props\n\n| Prop name | Type | Description | Default value |\n| ------------------------ | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| maxTopSearches | number | Maximum number of items in the top searches list. | 10 |\n| maxHistory | number | Maximum number of items in the search history. | 5 |\n| maxSuggestedProducts | number | Maximum number of items in the suggested products list. | 3 |\n| maxSuggestedTerms | number | Maximum number of items in the suggested terms list. | 3 |\n| autocompleteWidth | number | Autocomplete list width (percentage). This value must be between 0 and 100. | undefined |\n| productLayout | enum | Determines the layout the suggested products list will have when rendered. Possible values are HORIZONTAL and VERTICAL. | undefined |\n| hideTitles | boolean | Determines whether all component titles will be hidden when rendered (true) or not (false). | false |\n| hideUnavailableItems | boolean | Determines whether autocomplete should hide unavailable items (true) or not (false). This prop only hides items that are unavailable according to indexed information, without taking into account simulationBehavior. | false |\n| historyFirst | boolean | Determines whether the search history list should be prioritized over the other lists (true) or not (false). | false |\n| customBreakpoints | object | Determines the maximum number of recommended products per breakpoints. Possible values are md, lg, or xlg. | \\- |\n| simulationBehavior | \"skip\" or \"default\" | If you want faster searches and are not so concern about having the most up-to-date prices and promotions, use \"skip\". | default |\n| HorizontalProductSummary | product-summary block | By default, the mobile autocomplete uses the CustomListItem component to render the suggested products using a horizontal layout. But sending a product-summary block here will render your customized Product Summary component. Read our documentation to learn [how to build a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary) component. | undefined |\n\n##### The `customBreakpoints` object\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | -------------------------------------------------------------------------- | ------------- |\n| md | object | Defines the maximum number of recommended products for the md breakpoint. | undefined |\n| lg | object | Defines the maximum number of recommended products for the lg breakpoint. | undefined |\n| xlg | object | Defines the maximum number of recommended products for the xlg breakpoint. | undefined |\n\n##### The `md`, `lg`, and `xlg` objects\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------ | ------------------------------------- | ------------- |\n| width | number | Breakpoint minimum width. | undefined |\n| maxSuggestedProducts | number | Maximum number of suggested products. | undefined |\n\nThe `autocomplete-result-list.v2` block also allows you to add a list of child blocks to it. You can declare a theme block and have it rendered among the autocomplete features. Example:\n\n`1\n\n{ \n\n2\n\n \"autocomplete-result-list.v2\": { \n\n3\n\n \"blocks\": [\"product-summary\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\nNow, you can add the last three search blocks: `search-banner`, `did-you-mean`, and `search-suggestions`.\n\nThese blocks, as opposed to `autocomplete-result-list.v2`, need to be added under the `search-result-layout.desktop` or the `search-result-layout.mobile` blocks, following the Search Results block hierarchy.\n\nOnce added, the blocks can be declared using their respective props for configuration. Example:\n\n`1\n\n{ \n\n2\n\n \"search-result-layout.desktop\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#did-you-mean\", \n\n5\n\n \"flex-layout.row#suggestion\", \n\n6\n\n \"flex-layout.row#banner-one\", \n\n7\n\n \"flex-layout.row#result\" \n\n8\n\n ], \n\n9\n\n \"props\": { \n\n10\n\n \"pagination\": \"show-more\", \n\n11\n\n \"preventRouteChange\": true, \n\n12\n\n \"mobileLayout\": { \n\n13\n\n \"mode1\": \"small\", \n\n14\n\n \"mode2\": \"normal\" \n\n15\n\n } \n\n16\n\n } \n\n17\n\n }, \n\n18\n\n \n19\n\n \"flex-layout.row#did-you-mean\": { \n\n20\n\n \"children\": [\"did-you-mean\"] \n\n21\n\n }, \n\n22\n\n \"flex-layout.row#suggestion\": { \n\n23\n\n \"children\": [\"search-suggestions\"] \n\n24\n\n }, \n\n25\n\n \"flex-layout.row#banner-one\": { \n\n26\n\n \"children\": [\"search-banner#one\"] \n\n27\n\n }, \n\n28\n\n \n29\n\n \"search-banner#one\": { \n\n30\n\n \"props\": { \n\n31\n\n \"area\": \"one\", \n\n32\n\n \"blockClass\": \"myBanner\", \n\n33\n\n \"horizontalAlignment\": \"center\" \n\n34\n\n } \n\n35\n\n } \n\n36\n\n} \n\n`\n\n#### `search-banner` props\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| area | string | Area where the banner will be displayed in the store. This needs to match the predefined area value in the banner configuration. | undefined |\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| horizontalAlignment | string | Defines the horizontal alignment of the banner. Possible values are left, center, or right. | center |\n\n### Catalog integration\n\nAfter installing the app, you need to integrate it with your store's catalog. Go to **Store Settings > Intelligent Search > Integrations** in the VTEX Admin and click **Start integration** to set up the initial indexing of the catalog with Intelligent Search. Learn more about this process at [Setting up Intelligent Search integration with the Catalog](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-intelligent-search-integration-with-the-catalog--3Nt5cIdwISSlzVtnYfLeIH).\n\n\n\nAfterwards, you can follow the indexing status of products on the [Indexing History](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4flMwTaQL8FRKl1YT58ezH) page.\n\n## App behavior: Improving search experience\n\nTo improve the user's search experience in stores where the Intelligent Search engine is supported, the app have the following options:\n\n* **Stores using Universal Analytics (UA)**: \nThe Search app provides blocks that, when rendered as components, will improve the user's search experience in stores where the Intelligent Search engine is supported. \nThese components use `_q` as the query-string for the search term, meaning that if you want to track user searches in these components, you will need to add the `_q` query-string to the store's Google Analytics. To activate this behavior, refer to [Set up Site Search](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/1012264?hl=en%23zippy=%2Cin-this-article) Google's documentation. \n> Please note that although the Search app's blocks enhance the search experience in VTEX stores, this feature is only compatible with VTEX stores using UA. As UA will be discontinued on July 1st, 2023, **we highly recommend that you update your store to GA4**. For more information on the migration, see the [release notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2023-05-04-google-tag-manager-new-version) and follow the option below.\n* **Store using Google Analytics 4 (GA4)**: \nInstall the VTEX Google Tag Manager app, which includes the `search` event within the app's data layer. This app is responsible for tracking the user's search activity. For instructions on setting up Google Tag Manager, consult the [Setting up Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager) documentation.\n\n## Customization\n\nIn order to apply CSS customizations to 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| searchBanner |\n| didYouMeanPrefix |\n| didYouMeanTerm |\n| suggestionsList |\n| suggestionsListItem |\n| suggestionsListLink |\n| itemListSubItemLink |\n| itemListLink |\n| itemListLinkTitle |\n\n[Rich Text« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.rich-text)[SuggestionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search/suggestions)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[DidYouMeanVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search@2.18.8/DidYouMean)[SuggestionsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search@2.18.8/Suggestions)[AutocompleteVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search@2.18.8/Autocomplete)[BannerVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search@2.18.8/Banner)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search%23configuration)\n\n[Adding the Search app to your theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search%23adding-the-search-app-to-your-theme-dependencies)[Adding Search blocks to the theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search%23adding-search-blocks-to-the-theme)[Catalog integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search%23catalog-integration)\n\n[App behavior: Improving search experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search%23app-behavior-improving-search-experience)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search/docs/apps/vtex.search%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_1b9588bb
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides payment provider protocol api 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/payment-provider-protocol-api-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-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/payment-provider-protocol-api-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/payment-provider-protocol-api-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/payment-provider-protocol-api-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/payment-provider-protocol-api-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/payment-provider-protocol-api-overview/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/updates/release-notes)\n\nPayment Provider Protocol - Overview\n\n> Check the new [Payments onboarding guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Payments and is organized by focusing on the developer's journey. The Payment Provider Protocol is a set of definitions to help you integrate your payment processing API into VTEX platform, including sub-acquirers, acquirers, gateways and custom payment services.\n\nTo achieve this, you need to implement a web API (REST) following the specifications described in this documentation.\n\nTo learn more about the Payment Provider Protocol, check our [Help Center article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol).\n\n## Endpoint requirements\n\n* Must use a standard subdomain/domain name, and not a IP address.\n* Must be served over HTTPS on port 443 with TLS 1.2 support.\n* Must respond in less than 5 seconds when running the tests.\n* Must respond in less than 20 seconds when in production.\n* Must be [PCI-DSS compliant](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-pci-dss-compliance) or use [Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-secure-proxy) to accept branded cards like Visa, Mastercard, Amex, etc.\n\n## Testing\n\n_VTEX - Payment Provider Test Suite_: <https://apps.vtex.com/vtex-payment-provider-test-suite/p>\n\n_An extra header_ `X-VTEX-API-Is-TestSuite` \\= `true` _will be sent for every test suite request, to help you easily identify it and mock any required scenarios._\n\n## Common parameters in the documentation\n\n| {{providerApiEndpoint}} | Provider's endpoint for the implementation |\n| ----------------------- | ------------------------------------------ |\n| {{X-VTEX-API-AppKey}} | The AppKey configured by the merchant |\n| {{X-VTEX-API-AppToken}} | The AppToken configured by the merchant |\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/Payments/payment-provider-protocol-api-overview.md)\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Endpoint requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/guides/payment-provider-protocol-api-overview%23endpoint-requirements)\n\n[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/guides/payment-provider-protocol-api-overview%23testing)\n\n[Common parameters in the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/guides/payment-provider-protocol-api-overview%23common-parameters-in-the-documentation)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Payments/payment-provider-protocol-api-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Endpoint requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/guides/payment-provider-protocol-api-overview%23endpoint-requirements)\n\n[Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/guides/payment-provider-protocol-api-overview%23testing)\n\n[Common parameters in the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview/docs/guides/payment-provider-protocol-api-overview%23common-parameters-in-the-documentation)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_39ccde26
|
[
{
"role": "system",
"content": "You are a VTEX 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 input in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-overview)\n\nInput\n\nInputs are fields that capture user input.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/Input)\n\nThe `Input` component renders a single-line text field for capturing short user input. Typical use cases include:\n\n* Collecting user information (e.g., name, email, phone number).\n* Search queries and filters.\n* Form submissions and data entry.\n\nExample\n\nCode\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Input } 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/Input/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### Disabled\n\nExample\n\nCode\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------------- | ---------------------------------------------------------- |\n| \\--fs-input-padding | var(--fs-spacing-1) var(--fs-spacing-2) |\n| \\--fs-input-height | var(--fs-control-tap-size) |\n| \\--fs-input-bkg-color | var(--fs-color-body-bkg) |\n| \\--fs-input-box-shadow | none |\n| \\--fs-input-box-shadow-hover | 0 0 0 var(--fs-border-width) var(--fs-border-color-active) |\n| \\--fs-input-text-color | var(--fs-color-text) |\n| \\--fs-input-text-size | var(--fs-text-size-body) |\n| \\--fs-input-line-height | 1.25 |\n| \\--fs-input-transition-function | var(--fs-transition-function) |\n| \\--fs-input-transition-property | var(--fs-transition-property) |\n| \\--fs-input-transition-timing | var(--fs-transition-timing) |\n\n### Design tokens: Disabled\n\nDisabled inputs use reduced opacity and distinct styling to indicate when an input field is temporarily unavailable for interaction, preventing user input while maintaining visual context.\n\n| Local token | Default value/Global token linked |\n| --------------------------------- | --------------------------------- |\n| \\--fs-input-disabled-bkg-color | var(--fs-color-disabled-bkg) |\n| \\--fs-input-disabled-text-color | var(--fs-color-disabled-text) |\n| \\--fs-input-disabled-border-width | var(--fs-border-width) |\n| \\--fs-input-disabled-border-color | var(--fs-border-color) |\n\n---\n\n## Data attributes\n\nYou can target and override `Input` styles using the following data attributes:\n\n`data-fs-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-input |\n\n---\n\n## Best Practices\n\n### ✅ Do's\n\n* Provide a [Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label) when using input. Descriptive labels help users understand the purpose of a form control.\n* Use placeholder text as a hint or example of the expected input format, not as a replacement for labels.\n* Ensure sufficient color contrast between text and background for accessibility.\n* Use appropriate input types (e.g., email, name, phone number) to trigger the correct keyboard on mobile devices.\n\n### ❌ Don'ts\n\n* Don't use vague or ambiguous labels that leave users uncertain about what information to provide.\n* Don't use inputs for long-form text entry. Use a [textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-textarea) component instead.\n* Don't disable inputs without providing a clear reason why they're unavailable.\n\n---\n\n## Related components\n\n* Label \nInputField \nInputField wraps an Input and its corresponding Label. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/molecules-input-field)\n\nContributors\n\n3\n\n[](https://github.com/barbara-celi)\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/input.mdx)\n\n[Icon« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-icon)[LabelNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-label)\n\nContributors\n\n3\n\n[](https://github.com/barbara-celi)\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-input/docs/guides/faststore/atoms-input%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23examples)\n\n[Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23disabled)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23design-tokens)\n\n[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23related-components)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/input.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23examples)\n\n[Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23disabled)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23design-tokens)\n\n[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23best-practices)\n\n[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-input/docs/guides/faststore/atoms-input%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_68dc718a
|
[
{
"role": "system",
"content": "You are a VTEX 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 3 creating the new app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n[3\\. Declaring a theme block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\n[4\\. Defining styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-5-defining-styles)\n\n[5\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-6-structuring-documentation)\n\n[6\\. Consuming data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-7-consuming-data)\n\n[7\\. Translating the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-8-translating-the-component)\n\n[8\\. Improving performance with caching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-9-improving-performance-with-caching)\n\n[9\\. Making your app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-developing-custom-storefront-components)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[2\\. Creating the new app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app)\n\n2\\. Creating the new app\n\nNow that your development environment is set up, it is time to start developing your new React app.\n\nTo begin developing your app, you need to follow these steps:\n\n* Clone the React [boilerplate app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/react-app-template) to your local files.\n* Modify the `manifest.json` file in the React example app to include your app's information, such as its name, version, vendor, and dependencies.\n* [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\nOnce copied, the repository will automatically import the basic settings that you will need to kickstart your app development.\n\n## Instructions\n\n### Step 1 - Cloning the boilerplate repository to your local files\n\nClone the boilerplate repository to your local files by running the following command:\n\n`1\n\ngit clone https://github.com/vtex-apps/react-app-template \n\n`\n\n### Step 2 - Editing the `manifest.json` file\n\nNow, let's examine the manifest.json file, which contains essential information about the app such as:\n\n* `vendor` \\- Name of the VTEX account responsible for developing, maintaining, and distributing the app.\n* `name` \\- App name of your choice. Avoid special characters.\n* `version` \\- Current version of the app following [Semantic Versioning 2.0.0](https://read.calvincode.net/reader?url=https://semver.org/) standards.\n* `title` \\- The distribution name of the app that is displayed on the `Apps` section in the admin and, also, on the VTEX App Store.\n* `description` \\- Brief description of the app's features.\n* `builders` \\- List of [builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders/) that facilitate the app's development by abstracting service configurations.\n* `dependencies` \\- List of apps that the app you are developing depends on for proper functioning.\n\nIncorporating the new app's basic information into the `manifest.json` file is a crucial step at the beginning of the development process. This step is essential to make the app unique and distinct from the example version provided by VTEX.\n\nTo add this information, open the app's code in your code editor, and update the `manifest.json` file as in the following:\n\n1. Replace the `vendor` field value with the name of the VTEX account you are using for development.\n2. Replace the `name` field value with the name of your app. Avoid using special characters, except hyphens (-).\n3. Replace the values in the `title` and `description` fields with appropriate ones that describe the app you are developing.\n4. Add the `store@0.x` builder to the builder list to allow the creation of new blocks:\n\n`1\n\n\"builders\": { \n\n2\n\n+ \"store\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. If you want to import any React components previously developed for your new app, update the `dependencies` list with the name and version of the app that runs the desired component. For example:\n\n`1\n\n\"dependencies\": { \n\n2\n\n+ \"vtex.styleguide\": \"9.x\" \n\n3\n\n} \n\n`\n\nThis will allow you to later import the app component added in `dependencies` into your code via the `import {componentName} from '{dependency}'` structure.\n\n### Step 3 - Linking your app\n\nTo upload all the changes you made in your local files, you must link your app to the current development workspace by running the following command:\n\n`1\n\nvtex link \n\n`\n\nIf the process runs without any errors, the following message will be displayed: `App linked successfully`.\n\nTo check and review your local app code, run the `vtex browse` command to open a browser window for your current workspace. Alternatively, access `https://{workspace}--{account}.myvtex.com`, replacing `workspace` with the development workspace in use and `account` with the name of your VTEX account.\n\n> When linking an app to a development workspace, the `yarn install` command is automatically executed in the builder directories (e.g., `node` and `react` directories). Nevertheless, for an enhanced development experience, consider manually running `yarn install` in the root folder of your project to activate additional features, such as linter and prettier checks.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-3-creating-the-new-app.md)\n\n[1\\. Setting up your development environment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app//docs/guides/vtex-io-documentation-2-basic-development-setup-in-vtex-io)[3\\. Declaring a theme blockNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app//docs/guides/vtex-io-documentation-4-declaring-a-theme-block)\n\nSee also\n\n[ManifestApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-manifest)[BuildersApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-builders)\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-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app%23instructions)\n\n[Step 1 - Cloning the boilerplate repository to your local files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app%23step-1-cloning-the-boilerplate-repository-to-your-local-files)[Step 2 - Editing the manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app%23step-2-editing-the-manifestjson-file)[Step 3 - Linking your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app%23step-3-linking-your-app)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io/vtex-io-documentation-3-creating-the-new-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app%23instructions)\n\n[Step 1 - Cloning the boilerplate repository to your local files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app%23step-1-cloning-the-boilerplate-repository-to-your-local-files)[Step 2 - Editing the manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app%23step-2-editing-the-manifestjson-file)[Step 3 - Linking your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-creating-the-new-app/docs/guides/vtex-io-documentation-3-creating-the-new-app%23step-3-linking-your-app)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_77a81b34
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides headless profile management and order history in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/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/headless-profile-management-and-order-history/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-commerce)\n\n[Headless catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-catalog)\n\n[Headless cart and checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-cart-and-checkout)\n\n[Headless profile management and order history](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/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/headless-profile-management-and-order-history/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/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/headless-profile-management-and-order-history/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/headless-profile-management-and-order-history/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/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/headless-profile-management-and-order-history/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-commerce)\n\n[Headless catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-catalog)\n\n[Headless cart and checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-cart-and-checkout)\n\n[Headless profile management and order history](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/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/headless-profile-management-and-order-history/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/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/headless-profile-management-and-order-history/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/headless-profile-management-and-order-history/docs/guides)\n\nIntegration Guides\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-commerce)\n\n[Headless profile management and order history](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history)\n\nHeadless profile management and order history\n\nProfile management is an important feature, that allows shoppers in your store to view and edit their personal information, as well as order history and other features.\n\nVTEX's native storefront accomplishes this with the [My account page](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh), but below you can learn how to use VTEX APIs to build the same features in your headless shopping experience.\n\n## Profile management\n\nRegarding profile management, your integration must be able to [access profile information](#access-profile-information), [edit profile information](#edit-profile-information) and also perform [password resets](#password-reset).\n\n### Accessing profile information\n\nThe best way to retrieve shopper profile information on your headless storefront is to use this endpoint of the Checkout API:\n\n* [Get client profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/profiles)\n\nBy default, this endpoint returns only complete profiles, but you may use the boolean query parameter `ensureComplete=false` to get incomplete profiles as well.\n\n> A complete profile includes all information necessary to place an order: `email`, `firstName`, `lastName`, `phone`, `document`, and an associated address with all required fields.\n\n### Editing profile information\n\nVTEX uses [Master Data v1](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw) to store and manage shopper information. So in order to manage profile data from your storefront, you must use the Master Data v1 API.\n\n> Learn more about [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23versions-available) and its [basic components](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23basic-components).\n\nIn Master Data v1, shopper profiles are documents in the `CL` data entity, while addresses are documents in the `AD` data entity. See below the endpoints for managing Master Data v1 documents:\n\n* [Create new document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23post-/api/dataentities/-acronym-/documents)\n* [Update partial document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23patch-/api/dataentities/-acronym-/documents/-id-)\n* [Get document by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/documents/-id-)\n* [Delete document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23delete-/api/dataentities/-acronym-/documents/-id-)\n\nIf you prefer to search shopper information by other information, such as email address, instead of the document ID, use the search endpoint:\n\n* [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search)\n\n### Password\n\nCurrently, there is no way to edit shoppers' passwords from a headless frontend. However, you can implement password expiration, so that your customers can then go to your store and create a new password.\n\nTo implement this feature, follow the instructions in the guide [Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/expiring-a-shoppers-password).\n\n> This method of password expiration does not trigger any notification. You must notify the shopper that they must create a new password on your website. Learn more about [Shopper authentication for headless stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-commerce%23authenticating-shopper-identity).\n\n### News letter subscription\n\nWhen shoppers go to the profile management section of your store, they may wish to manage their consent of newsletter subscription. For this purpose, note that this information is in the shopper profile, in the boolean field named `isNewsletterOptIn`.\n\n## Order history\n\nYou can use the endpoints below to fetch order information related to a specific shopper.\n\n* [Retrieve list of user's orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/user/orders)\n* [Retrieve user order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/user/orders/-orderId-)\n\n### Actions on existing orders\n\nSome stores allow shoppers to request changes or even the cancellation of existing orders. For order cancelation, use this endpoint:\n\n* [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel)\n\nFor requesting changes to an existing order, you can use the endpoint below, but see the [Change order guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order) to learn more about this process.\n\n* [Register change on order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/changes)\n\n## Learn more\n\nSee these other guides to learn more about building a headless shopping experience using VTEX:\n\n* [Headless commerce overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-commerce)\n* [Headless catalog and search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-catalog)\n* [Headless cart and checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-cart-and-checkout)\n\nContributors\n\n1\n\n[](https://github.com/PedroAntunesCosta)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/headless-commerce/headless-profile-management-and-order-history.md)\n\n[Headless cart and checkout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history//docs/guides/headless-cart-and-checkout)[Login (SSO)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history//docs/guides/login-integration-guide)\n\nContributors\n\n1\n\n[](https://github.com/PedroAntunesCosta)\n\nON THIS PAGE\n\n[Profile management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23profile-management)\n\n[Accessing profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23accessing-profile-information)[Editing profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23editing-profile-information)[Password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23password)[News letter subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23news-letter-subscription)\n\n[Order history](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23order-history)\n\n[Actions on existing orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23actions-on-existing-orders)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23learn-more)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/headless-commerce/headless-profile-management-and-order-history.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Profile management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23profile-management)\n\n[Accessing profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23accessing-profile-information)[Editing profile information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23editing-profile-information)[Password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23password)[News letter subscription](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23news-letter-subscription)\n\n[Order history](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23order-history)\n\n[Actions on existing orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23actions-on-existing-orders)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/headless-profile-management-and-order-history/docs/guides/headless-profile-management-and-order-history%23learn-more)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b2475d31
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides 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/skus/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/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/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/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/skus/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/skus/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/skus/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/skus/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/skus/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/alternative-api-requests)\n\n[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/how-to-implement-product-color-variation)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/skus/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/skus/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/catalog-integration)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus)\n\nSKUs\n\nA [Stock Keeping Unit (SKU)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA%23) corresponds to the actual item in the inventory that customers can purchase, which means it is equivalent to a product variation at VTEX, such as a _long sleeve gray size S shirt_.\n\nOnce you have created a product, it is time to submit its respective SKUs.\n\n> Try the interactive version of this article by accessing this [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-skus). Code will be highlighted and focused for your convenience.\n\n## Creating an SKU\n\nTo create a new SKU, use the [Create SKU endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit).\n\nFollow these instructions when creating the request body:\n\n* During SKU creation, do not set `IsActive` as `true`. If you send the request to activate the SKU when creating it, you will receive a `400 Bad Request` error. The value to `IsActive` must always be `false` when sending that request for activation to occur afterward, as explained in [Activating an SKU](#activating-an-sku).\n* We suggest you set `ActivateIfPossible` as `true,` unless you plan to have an internal workflow to [manually activate SKUs](#manual-activation).\n* If there is a need to create a new SKU with a specific custom ID, specify the `Id` (integer) in the request. Otherwise, VTEX will generate the ID automatically.\n* Besides the main ID, you must provide at least one of the following alternate IDs in the request body: `RefId` or `EAN`. It is possible to provide both as well.\n\n#### **Request body example (custom ID)**\n\n`1\n\n{ \n\n2\n\n \"Id\": 1, \n\n3\n\n \"ProductId\": 310117069, \n\n4\n\n \"IsActive\": false, \n\n5\n\n \"ActivateIfPossible\": true, \n\n6\n\n \"Name\": \"sku test\", \n\n7\n\n \"RefId\": \"125478\", \n\n8\n\n \"Ean\": \"8949461894984\", \n\n9\n\n \"PackagedHeight\": 10, \n\n10\n\n \"PackagedLength\": 10, \n\n11\n\n \"PackagedWidth\": 10, \n\n12\n\n \"PackagedWeightKg\": 10, \n\n13\n\n \"Height\": null, \n\n14\n\n \"Length\": null, \n\n15\n\n \"Width\": null, \n\n16\n\n \"WeightKg\": null, \n\n17\n\n \"CubicWeight\": 0.1667, \n\n18\n\n \"IsKit\": false, \n\n19\n\n \"CreationDate\": null, \n\n20\n\n \"RewardValue\": null, \n\n21\n\n \"EstimatedDateArrival\": null, \n\n22\n\n \"ManufacturerCode\": \"123\", \n\n23\n\n \"CommercialConditionId\": 1, \n\n24\n\n \"MeasurementUnit\": \"un\", \n\n25\n\n \"UnitMultiplier\": 2.0000, \n\n26\n\n \"ModalType\": null, \n\n27\n\n \"KitItensSellApart\": false, \n\n28\n\n \"Videos\": [ \"https://www.youtube.com/\" ] \n\n29\n\n} \n\n`\n\n#### **Request body example (automatically generated ID)**\n\n`1\n\n{ \n\n2\n\n \"ProductId\": 310117069, \n\n3\n\n \"IsActive\": false, \n\n4\n\n \"ActivateIfPossible\": true, \n\n5\n\n \"Name\": \"sku test\", \n\n6\n\n \"RefId\": \"125478\", \n\n7\n\n \"Ean\": \"8949461894984\", \n\n8\n\n \"PackagedHeight\": 10, \n\n9\n\n \"PackagedLength\": 10, \n\n10\n\n \"PackagedWidth\": 10, \n\n11\n\n \"PackagedWeightKg\": 10, \n\n12\n\n \"Height\": null, \n\n13\n\n \"Length\": null, \n\n14\n\n \"Width\": null, \n\n15\n\n \"WeightKg\": null, \n\n16\n\n \"CubicWeight\": 0.1667, \n\n17\n\n \"IsKit\": false, \n\n18\n\n \"CreationDate\": null, \n\n19\n\n \"RewardValue\": null, \n\n20\n\n \"EstimatedDateArrival\": null, \n\n21\n\n \"ManufacturerCode\": \"123\", \n\n22\n\n \"CommercialConditionId\": 1, \n\n23\n\n \"MeasurementUnit\": \"un\", \n\n24\n\n \"UnitMultiplier\": 2.0000, \n\n25\n\n \"ModalType\": null, \n\n26\n\n \"KitItensSellApart\": false, \n\n27\n\n \"Videos\": [ \"https://www.youtube.com/\" ] \n\n28\n\n} \n\n`\n\n#### **Response body example**\n\n`1\n\n{ \n\n2\n\n \"Id\":1, \n\n3\n\n \"ProductId\": 310117069, \n\n4\n\n \"IsActive\": false, \n\n5\n\n \"ActivateIfPossible\": true, \n\n6\n\n \"Name\": \"sku test\", \n\n7\n\n \"RefId\": \"125478\", \n\n8\n\n \"Ean\": \"8949461894984\", \n\n9\n\n \"PackagedHeight\": 10, \n\n10\n\n \"PackagedLength\": 10, \n\n11\n\n \"PackagedWidth\": 10, \n\n12\n\n \"PackagedWeightKg\": 10, \n\n13\n\n \"Height\": null, \n\n14\n\n \"Length\": null, \n\n15\n\n \"Width\": null, \n\n16\n\n \"WeightKg\": null, \n\n17\n\n \"CubicWeight\": 0.1667, \n\n18\n\n \"IsKit\": false, \n\n19\n\n \"CreationDate\": null, \n\n20\n\n \"RewardValue\": null, \n\n21\n\n \"EstimatedDateArrival\": null, \n\n22\n\n \"ManufacturerCode\": \"123\", \n\n23\n\n \"CommercialConditionId\": 1, \n\n24\n\n \"MeasurementUnit\": \"un\", \n\n25\n\n \"UnitMultiplier\": 2.0000, \n\n26\n\n \"ModalType\": null, \n\n27\n\n \"KitItensSellApart\": false, \n\n28\n\n \"Videos\": [ \"https://www.youtube.com/\" ] \n\n29\n\n} \n\n`\n\n## Updating an SKU\n\nAfter an SKU has been successfully created, if any changes are needed or if it's necessary to [activate it manually](#manual-activation), use the [Update SKU endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-).\n\n#### **Request body example**\n\n`1\n\n{ \n\n2\n\n \"Id\": 70, \n\n3\n\n \"ProductId\": 42, \n\n4\n\n \"IsActive\": true, \n\n5\n\n \"Name\": \"Size 10\", \n\n6\n\n \"RefId\": \"B096QW8Y8Z\", \n\n7\n\n \"PackagedHeight\": 15.0, \n\n8\n\n \"PackagedLength\": 15.0, \n\n9\n\n \"PackagedWidth\": 15.0, \n\n10\n\n \"PackagedWeightKg\": 15.0, \n\n11\n\n \"Height\": null, \n\n12\n\n \"Length\": null, \n\n13\n\n \"Width\": null, \n\n14\n\n \"WeightKg\": null, \n\n15\n\n \"CubicWeight\": 0.0, \n\n16\n\n \"IsKit\": false, \n\n17\n\n \"CreationDate\": \"2020-01-25T15:51:00\", \n\n18\n\n \"RewardValue\": null, \n\n19\n\n \"EstimatedDateArrival\": null, \n\n20\n\n \"ManufacturerCode\": null, \n\n21\n\n \"CommercialConditionId\": 1, \n\n22\n\n \"MeasurementUnit\": \"un\", \n\n23\n\n \"UnitMultiplier\": 1.0, \n\n24\n\n \"ModalType\": null, \n\n25\n\n \"KitItensSellApart\": false, \n\n26\n\n \"Videos\": [] \n\n27\n\n} \n\n`\n\n#### **Response body example**\n\n`1\n\n{ \n\n2\n\n \"Id\": 70, \n\n3\n\n \"ProductId\": 42, \n\n4\n\n \"IsActive\": true, \n\n5\n\n \"Name\": \"Size 10\", \n\n6\n\n \"RefId\": \"B096QW8Y8Z\", \n\n7\n\n \"PackagedHeight\": 15.0, \n\n8\n\n \"PackagedLength\": 15.0, \n\n9\n\n \"PackagedWidth\": 15.0, \n\n10\n\n \"PackagedWeightKg\": 15.0, \n\n11\n\n \"Height\": null, \n\n12\n\n \"Length\": null, \n\n13\n\n \"Width\": null, \n\n14\n\n \"WeightKg\": null, \n\n15\n\n \"CubicWeight\": 0.0, \n\n16\n\n \"IsKit\": false, \n\n17\n\n \"CreationDate\": \"2020-01-25T15:51:00\", \n\n18\n\n \"RewardValue\": null, \n\n19\n\n \"EstimatedDateArrival\": null, \n\n20\n\n \"ManufacturerCode\": null, \n\n21\n\n \"CommercialConditionId\": 1, \n\n22\n\n \"MeasurementUnit\": \"un\", \n\n23\n\n \"UnitMultiplier\": 1.0, \n\n24\n\n \"ModalType\": null, \n\n25\n\n \"KitItensSellApart\": false, \n\n26\n\n \"Videos\": [] \n\n27\n\n} \n\n`\n\n## Activating an SKU\n\nBefore you can activate an SKU, it must meet the following requirements:\n\n* The SKU must have at least one of the following alternate IDs configured: `RefId` or `EAN`.\n* The SKU must have at least one image associated. To associate an image to an SKU, use the [Create SKU file endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).\n* If the SKU has [specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications), they must be filled in.\n* If the field `ActivateIfPossible` is `false`, the SKU must be activated manually. For more information, check the [Manual activation](#manual-activation) section.\n* If the SKU is a [kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunitkit), it must have at least one component active.\n* The SKU must be associated with an active product, which, in turn, must be associated with an active Brand and an active Category.\n\nOnce the SKU complies with all the aspects listed above, there are two ways that you can activate your SKU - [manually](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku%23manual-activation) or [automatically](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-activate-an-sku%23automatic-activation). Read the following sections for more details.\n\n> Note that additional configurations are necessary for a product and its SKUs to become visible in a store:\n> \n> * Having registered a price for the SKU in the associated trade policy (also known as sales channel). Read the Pricing onboarding guide for more information on this process.\n> * Having at least one unit in stock. Read the Fulfillment onboarding guide for more information on managing inventory.\n> * Configuring your storefront's CMS to display products correctly, as described in this Frequently Asked Question.\n\n### Manual activation\n\nTo manually activate your SKU, follow these steps:\n\n1. [Create the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit), setting `IsActive` as `false` and `ActivateIfPossible` as `false`.\n2. If the SKU is a kit, [create and associate SKU components](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-post-sku-kit).\n3. [Create and associate SKU files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).\n4. [Update the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-) as active, setting `IsActive` as `true`.\n\nNow the SKU should be active in your store.\n\n### Automatic activation\n\nThis configuration will automatically update the SKU as active once it is associated with an image or an active component. You do not need to update the SKU as in the previous steps.\n\nTo automatically activate your SKU, follow these steps:\n\n1. [Create the SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit), setting `IsActive` as `false` and `ActivateIfPossible` as `true`.\n2. If the SKU is a kit, [create and associate SKU components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunitkit).\n3. [Create and associate SKU files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/file).\n\nNow the SKU should be active in your store.\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/skus.md)\n\n[Updating SKU Specifications with Catalog API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus//docs/guides/updating-sku-specifications-with-catalog-api)[ImagesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus//docs/guides/images)\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Creating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23creating-an-sku)\n\n[Updating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23updating-an-sku)\n\n[Activating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23activating-an-sku)\n\n[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23manual-activation)[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23automatic-activation)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/skus.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23creating-an-sku)\n\n[Updating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23updating-an-sku)\n\n[Activating an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23activating-an-sku)\n\n[Manual activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23manual-activation)[Automatic activation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus/docs/guides/skus%23automatic-activation)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_dd1e9b3f
|
[
{
"role": "system",
"content": "You are a VTEX 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 assets 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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-builder/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-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-assets-builder/docs/guides/vtex-io-documentation-builders)\n\n[Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/guides/vtex-io-documentation-assets-builder)\n\nAssets builder\n\nLearn how to use the VTEX IO Assets builder.\n\nThe `assets` builder manages assets within VTEX IO apps. It does this by collecting all asset paths used and uploading them to the File Manager service.\n\nThe File Manager service manages store files and their respective URLs, translating asset paths and exporting immutable URLs for proper rendering of block assets.\n\n> For more information about using this builder in a Store Theme app, see [Using the assets builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-assets-builder).\n\n## Folder structure\n\nAn app that uses the `assets` builder has a folder named `\\assets` in its root directory. The directory structure may vary depending on specific project settings.\n\nYou can add any image extension, such as `.jpeg`, `.png`, and `.gif`, as well as store font files (`.ttf`or `.woff`) to later [customize store typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography).\n\nAssets can be added directly to the `/assets` folder, or for better organization, subfolders can be created within it, as illustrated below:\n\n`1\n\nassets \n\n2\n\n ┣ 📂 fonts \n\n3\n\n ┗ 📄 {FileName}.woff \n\n4\n\n ┣ 📄 {FileName}.jpeg \n\n5\n\n ┣ 📄 {FileName}.png \n\n`\n\n## Usage\n\nTo use the `assets` builder in your app, follow these steps:\n\n1. Add the `assets` builder to your app’s builder list in the `manifest.json` file, as shown below: \n`1 \n\"builders\": { \n2 \n \"assets\": \"0.x\" \n3 \n} \n`\n2. In the root directory of your app, create an `/assets` folder to manage store assets.\n3. Add the asset files to the `/assets` folder. Add subfolders to organize the files as needed.\n4. To use the stored assets within your app, use the asset path as the value of a given parameter. Note that if you have structured subfolders within the `assets` folder, you need to include the folder hierarchy in the asset path. For example: `assets/fonts/{FileName}.woff`.\n\n## Use case examples\n\nAs an example, check the folder structure of this builder in the [B2B Theme app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-theme):\n\n`1\n\nassets \n\n2\n\n ┣ 📂 fonts \n\n3\n\n ┗ 📄 {FileName}.woff \n\n4\n\n ┣ 📂 icons \n\n5\n\n ┗ 📄 {FileName}.svg \n\n6\n\n ┗ 📄 {FileName}.svg \n\n7\n\n┗ 📄 {FileName}.jpg \n\n`\n\n* The `fonts` folder contains `.woff` files, which are web fonts.\n* The `icons` folder holds `.svg` files, which may be icons, logos, graphics, and other vector images.\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-builders/vtex-io-documentation-assets-builder.md)\n\n[Admin Builder« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder//docs/guides/vtex-io-documentation-admin-builder)[Docs BuilderNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder//docs/guides/vtex-io-documentation-docs-builder)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Folder structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/guides/vtex-io-documentation-assets-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/guides/vtex-io-documentation-assets-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/guides/vtex-io-documentation-assets-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-assets-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-assets-builder/docs/guides/vtex-io-documentation-assets-builder%23folder-structure)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/guides/vtex-io-documentation-assets-builder%23usage)\n\n[Use case examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder/docs/guides/vtex-io-documentation-assets-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_95bfcf24
|
[
{
"role": "system",
"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 quickorder 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.quickorder/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/api-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.quickorder/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.quickorder/docs/storefront-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.quickorder/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.quickorder/docs/troubleshooting)\n\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.quickorder/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/b2b-components)\n\n[Order Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.order-configuration)\n\n[Quickorder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.quickorder)\n\n[SKU List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.sku-list)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/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.quickorder/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.quickorder/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/b2b-components)\n\n[Order Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.order-configuration)\n\n[Quickorder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.quickorder)\n\n[SKU List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.sku-list)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/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.quickorder/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.quickorder/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.quickorder/docs/vtex-io-apps)\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/guides/b2b-components)\n\nQuickorder\n\nOfficial extension\n\nVersion: 3.16.3\n\nLatest version: 3.16.3\n\n[](#contributors-)\n\nThe Quickorder app, designed for **B2B scenarios**, creates a custom page in your store aimed at purchases in bulk, offering tools such as uploading a spreadsheet to make bulk orders more agile.\n\n\n\n_Example of a quick order page without customization_ \n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-installing-an-app) the Quickorder app by running `vtex install vtex.quickorder@3.x` in your terminal.\n2. Open your store's Store Theme app directory in your code editor.\n3. Add the Quickorder app as a `peerDependency` in the `manifest.json` file: \n`1 \n \"peerDependencies\": { \n2 \n+ \"vtex.quickorder\": \"3.x\" \n3 \n } \n`\n\nOnce installed, the app will generate a new route called `/quickorder` for your store, creating the Quickorder custom page that allows bulk orders.\n\nThe new page already contains a default template with all blocks exported by the **Quickorder** app. This means the **Quickorder** page is ready to be rendered and no further actions are required.\n\nHowever, you can customize it by overwriting the template and creating a brand new one tailored to your preferences. To do so, check the [Advanced configurations](#advanced-configurations) section below.\n\n### Advanced configurations\n\nIn order to define the **Quickorder** custom page UI, you must use the blocks exported by the `vtex.quickorder` app:\n\n| Block name | Description |\n| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| quickorder-textarea | Renders a text box, allowing users to paste a list of desired SKUs following the structure \\[SKU Reference ID\\],\\[Quantity\\]. For more on this component, check out the [How the app works](#how-the-app-works) section. |\n| quickorder-upload | Renders an upload box, working as an option that replaces the Copy/Paste SKU component (quickorder-textarea block). It allows users to upload a spreadsheet containing the desired SKUs. For more on this component, check out the [How the app works](#how-the-app-works) section. |\n| quickorder-autocomplete | Renders a custom search bar, allowing users to look for SKUs and add them to the Minicart at once according to the desired quantity. For more on this component, check out the [How the app works](#how-the-app-works) section. |\n| quickorder-categories | Renders the store's category tree, allowing users to look for the desired SKUs and add them to the Minicart at once according to the desired quantity. |\n\nTo use these blocks, follow the instructions below.\n\n1. In the `store` folder of your Store Theme app, create a new file called `quickorder.json`.\n2. Then, create a new store template called `store.quickorder`.\n3. In its `blocks` array, declare the blocks responsible for building your **Quickorder** custom page. For example: \n`1 \n{ \n2 \n \"store.quickorder\": { \n3 \n \"blocks\": [ \n4 \n \"flex-layout.row#title\", \n5 \n \"flex-layout.row#textarea\", \n6 \n \"flex-layout.row#upload\", \n7 \n \"flex-layout.row#autocomplete\", \n8 \n \"flex-layout.row#categories\" \n9 \n ] \n10 \n }, \n`\n4. Configure each one of the blocks previously declared using its props, as shown in the example below: \n`1 \n{ \n2 \n \"store.quickorder\": { \n3 \n \"blocks\": [ \n4 \n \"flex-layout.row#title\", \n5 \n \"flex-layout.row#textarea\", \n6 \n \"flex-layout.row#upload\", \n7 \n \"flex-layout.row#autocomplete\", \n8 \n \"flex-layout.row#categories\" \n9 \n ] \n10 \n }, \n11 \n \"flex-layout.row#title\": { \n12 \n \"children\": [\"flex-layout.col#title\"] \n13 \n }, \n14 \n \"flex-layout.col#title\": { \n15 \n \"children\": [\"rich-text#title\"], \n16 \n \"props\": { \n17 \n \"blockClass\": \"titleQuickorder\", \n18 \n \"preventVerticalStretch\": true \n19 \n } \n20 \n }, \n21 \n \"rich-text#title\": { \n22 \n \"props\": { \n23 \n \"text\": \"## Quick Order\" \n24 \n } \n25 \n }, \n26 \n \n27 \n \"flex-layout.row#textarea\": { \n28 \n \"children\": [\"flex-layout.col#textarea\"] \n29 \n }, \n30 \n \"flex-layout.col#textarea\": { \n31 \n \"children\": [\"quickorder-textarea\"] \n32 \n }, \n33 \n \"quickorder-textarea\": { \n34 \n \"props\": { \n35 \n \"componentOnly\": false, \n36 \n \"text\": \"Copy/Paste Skus\", \n37 \n \"description\": \"[SKU Reference ID],[Quantity]\", \n38 \n } \n39 \n }, \n40 \n \n41 \n \"flex-layout.row#upload\": { \n42 \n \"children\": [\"flex-layout.col#upload\"] \n43 \n }, \n44 \n \"flex-layout.col#upload\": { \n45 \n \"children\": [\"quickorder-upload\"] \n46 \n }, \n47 \n \"quickorder-upload\": { \n48 \n \"props\": { \n49 \n \"componentOnly\": false, \n50 \n \"text\": \"Upload\", \n51 \n \"description\": \"Upload a Spreadsheet with two columns (SKU, Quantity) to bulk order\", \n52 \n \"downloadText\": \"Click here to download a spreadsheet model\", \n53 \n \"alwaysShowAddToCart:\": true, \n54 \n } \n55 \n }, \n56 \n \n57 \n \"flex-layout.row#autocomplete\": { \n58 \n \"children\": [\"flex-layout.col#autocomplete\"] \n59 \n }, \n60 \n \"flex-layout.col#autocomplete\": { \n61 \n \"children\": [\"quickorder-autocomplete\"] \n62 \n }, \n63 \n \"quickorder-autocomplete\": { \n64 \n \"props\": { \n65 \n \"componentOnly\": false, \n66 \n \"text\": \"One by One\", \n67 \n \"description\": \"Type the product name, select, enter quantity, add to the cart\", \n68 \n } \n69 \n }, \n70 \n \n71 \n \"flex-layout.row#categories\": { \n72 \n \"children\": [\"flex-layout.col#categories\"] \n73 \n }, \n74 \n \"flex-layout.col#categories\": { \n75 \n \"children\": [\"quickorder-categories\"] \n76 \n }, \n77 \n \"quickorder-categories\": { \n78 \n \"props\": { \n79 \n \"componentOnly\": false, \n80 \n \"text\": \"Categories\", \n81 \n \"description\": \"Add products directly from their categories\", \n82 \n } \n83 \n } \n84 \n} \n`\n\n#### Props\n\nAll blocks exported by the `quickorder` app share the same props:\n\n| Prop name | Type | Description | Default value |\n| ------------- | ------- | --------------------------------------------------------------------------------------------------------------- | ------------- |\n| text | string | Component title. | undefined |\n| description | string | Component description. It should be used to explain users how to properly bulk order using the given component. | undefined |\n| componentOnly | boolean | If true, only the component will be loaded, removing the text and description column. | false |\n\nEspecially, the `quickorder-upload` block also can use the following prop:\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| downloadText | string | Defines a text for the spreadsheet download button. Use this prop to explain users how to properly download the spreadsheet model provided by the component. | undefined |\n| alwaysShowAddToCart | boolean | Property that defines if the add to cart button will appear even if it has some invalid Sku. | true |\n\nIn addition, the `quickorder-upload` and the `quickorder-textarea` block can use the following prop:\n\n| Prop name | Type | Description | Default value |\n| ------------- | ------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| hiddenColumns | array of strings (i.e. \\[\"sku\", \"seller\", \"quantity\"\\]) | Defines which columns of the review block must be hidden, you might hide more than one column separating the values with comma | \\[\\] |\n\nFor more on each of the components and their respective functionalities, check out the [How the app works](#how-the-app-works) section below.\n\n## How the app works\n\nThe **Quickorder** custom page works just like any other store page, with a unique route and its own components.\n\nThis means that you can display a link to it in components from other pages, such as the homepage, so that your storefront users can access it faster.\n\nWhen configuring the page itself, we recommend that you choose a maximum of 2 bulk order options (from the total of 4 available) to establish clear communication with users. Remember: the more options on the UI, the more complex the order process becomes.\n\nRead the following sections to learn more about the available options.\n\n### Copy/Paste SKU (`quickorder-textarea` block)\n\nThe **Copy/Paste SKU** option allows user to paste a list of desired SKUs in a text box following the structure `[SKU Reference ID],[Quantity]`, where:\n\n* `SKU Reference ID`: SKU Reference ID (be aware that this is not the SKU ID displayed in your admin's Catalog).\n* `Quantity`: SKU quantity you wish to add to the cart.\n\nFor example:\n\n\n\n> Remember that you need to validate the list after pasting it. Validating the Reference IDs will let you know if the selected SKUs are in fact available for purchase.\n\n### Upload (`quickorder-upload` block)\n\nAnother possible option that replaces the **Copy/Paste SKU** option is to upload a spreadsheet containing two columns (SKU and Quantity) to the **Upload** component (`quickorder-upload` block).\n\n\n\nThe spreadsheet will work in the same way as the list pasted using the **Copy/Paste SKU** option, as follows:\n\n* `SKU` column: SKU Reference ID (be aware that this is not the SKU ID displayed in your admin's Catalog).\n* `Quantity` column: SKU quantity you wish to add to the cart.\n\n> Once uploaded, the spreadsheet is then validated. Based on the filled in SKU reference IDs, **Quickorder** will confirm whether the SKUs are in fact available for purchase.\n\n### Custom Search Bar (`quickorder-autocomplete` block)\n\nThe **Custom Search Bar** component works as a custom search bar. Simply add the name of the desired SKU, then select it and set the amount you wish to add to the cart.\n\nRemember to add each selected item to the cart by clicking on `Add`.\n\n\n\nThis option does not require any validation, since selecting the SKUs using a search bar already ensures that they are available to purchase.\n\n### Categories (`quickorder-categories` block)\n\nThe **Categories** component allows users to choose their desired SKUs and respective quantities using the store's categories tree, adding all the selected options to the cart at once.\n\n\n\n> This option is only recommended if you have less than 50 SKUs for each category in your Catalog. Otherwise, the component will take too long to load and will negatively affect your store's user experience.\n\nThis scenario also does not require validating the SKUs that you've added to the cart, since selecting them directly from the store's categories tree ensures their availability.\n\n## Customization\n\nIn order to apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| -------------------------- |\n| autocompleteBlock |\n| buttonAdd |\n| buttonClear |\n| buttonsBlock |\n| buttonValidate |\n| categoriesSubCategory |\n| categoriesProductContainer |\n| categoryButtonAdd |\n| categoryContainer |\n| categoryLoadingProducts |\n| categoryHelper |\n| categoryInputQuantity |\n| categoryProductLabel |\n| categoryProductTitle |\n| categoryProductThumb |\n| categoryProductReference |\n| categoryProductItem |\n| categoryTitle |\n| componentContainer |\n| container |\n| copyPasteBlock |\n| dropzoneContainer |\n| dropzoneLink |\n| dropzoneText |\n| downloadLink |\n| inputQuantity |\n| productLabel |\n| productTitle |\n| productSku |\n| productThumb |\n| reviewBlock |\n| skuSelection |\n| textContainer |\n| textContainerTitle |\n| textContainerDescription |\n| title |\n| customOptionButton |\n\n[Order Configuration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.order-configuration)[SKU ListNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.sku-list)\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.quickorder/docs/apps/vtex.quickorder%23configuration)\n\n[Advanced configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.quickorder%23advanced-configurations)\n\n[How the app works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.quickorder%23how-the-app-works)\n\n[Copy/Paste SKU (quickorder-textarea block)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.quickorder%23copypaste-sku-quickorder-textarea-block)[Upload (quickorder-upload block)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.quickorder%23upload-quickorder-upload-block)[Custom Search Bar (quickorder-autocomplete block)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.quickorder%23custom-search-bar-quickorder-autocomplete-block)[Categories (quickorder-categories block)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.quickorder%23categories-quickorder-categories-block)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.quickorder/docs/apps/vtex.quickorder%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_3b231436
|
[
{
"role": "system",
"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 add to cart button 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.add-to-cart-button/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/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.add-to-cart-button/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/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.add-to-cart-button/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.add-to-cart-button/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/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.add-to-cart-button/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.add-to-cart-button/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/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.add-to-cart-button/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/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.add-to-cart-button/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.add-to-cart-button/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/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.add-to-cart-button/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.add-to-cart-button/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.add-to-cart-button/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/basic-components)\n\nAdd To Cart Button\n\nOfficial extension\n\nVersion: 0.31.0\n\nLatest version: 0.31.0\n\n[](#contributors-)\n\nThe `add-to-cart-button` block is designed to add products to the [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/) (`minicart.v2`).\n\n\n\n> The **Add to Cart** button is only compatible with stores using Minicart v2\\. For these stores, it will function correctly on the Shelf component and the Product Details page. If you are using [Minicart v1](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart/blob/383d7bbd3295f06d1b5854a0add561a872e1515c/docs/README.md), you should configure the [Buy Button block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton) on the Product Details page and the [Product Summary Buy button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummarybuybutton) on the Shelf component instead.\n\n## Configuration\n\n1. Import the `vtex.add-to-cart-button` app to your theme dependencies in the `manifest.json` file, as follows:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.add-to-cart-button\": \"0.x\" \n\n3\n\n} \n\n`\n\n1. Add the `add-to-cart-button` to another theme block using the product context, such as the `product-summary.shelf`. In the example below, the `add-to-cart-button` is added to the `flex-layout.row` block from the `store.product` template, which uses the product context:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n \"add-to-cart-button\" \n\n9\n\n ] \n\n10\n\n } \n\n`\n\n| Prop name | Type | Description | Default value |\n| ----------------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------- |\n| onClickBehavior | enum | Controls what happens when users click the button. Possible values are: go-to-product-page, add-to-cart, ensure-sku-selection (if multiple SKUs are available, users will be redirected to the product page to select the desired one. If the product only has 1 SKU available, it will be automatically added to the cart when the button is clicked) and add-to-cart-and-trigger-shipping-modal (opens a modal for ZIP code input if none is provided; otherwise, it adds the item to the cart. See more in [vtex.shipping-option-components](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/shipping-option-components)). | add-to-cart |\n| onClickEventPropagation | enum | Controls whether the 'onClick' event, triggered upon user clicks, should propagate to the parent elements of the page. Possible values are: disabled and enabled. | disabled |\n| isOneClickBuy | boolean | Determines whether the user should be redirected to the checkout page (true) or not (false) when the **Add to Cart** button is clicked. | false |\n| customOneClickBuyLink | string | Defines the link to which users will be redirected when the **Add to Cart** button is clicked, and the isOneClickBuy prop is set to true. | /checkout/#/cart |\n| customToastUrl | string | Defines the link to which users will be redirected when the toast (pop-up notification displayed when adding an item to the minicart) is clicked. | /checkout/#/cart |\n| text | string | Defines a custom text message to be displayed on the **Add to Cart** button. | Add to cart _(automatic translation will be applied following your store default language)_ |\n| unavailableText | string | Defines a custom text message to be displayed on the **Add to Cart** button when a product is unavailable. | Unavailable _(automatic translation will be applied following your store default language)_ |\n| customPixelEventId | string | Defines the id for the event that the button will send upon user interaction. | undefined |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions in [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ------------------- |\n| buttonText |\n| buttonDataContainer |\n| tooltipLabelText |\n\n[Basic components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/guides/basic-components)[AutocompleteNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.search/Autocomplete)\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.add-to-cart-button/docs/apps/vtex.add-to-cart-button%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button/docs/apps/vtex.add-to-cart-button%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_fa0b329c
|
[
{
"role": "system",
"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 locale switcher 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.locale-switcher/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/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.locale-switcher/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/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.locale-switcher/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.locale-switcher/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/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.locale-switcher/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.locale-switcher/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/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.locale-switcher/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/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.locale-switcher/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.locale-switcher/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/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.locale-switcher/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.locale-switcher/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.locale-switcher/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/guides/basic-components)\n\nLocale Switcher\n\nOfficial extension\n\nVersion: 0.5.6\n\nLatest version: 0.5.6\n\nThe Locale Switcher app provides a component capable of changing the current language of your store.\n\n\n\n## Configuration\n\n1. Add the Locale Switcher app to your theme's dependencies in the `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.locale-switcher\": \"0.x\" \n\n3\n\n } \n\n`\n\n1. Add the `locale-switcher` block to your header. For example:\n\n`1\n\n\"header-row#desktop\": { \n\n2\n\n \"children\": [ \n\n3\n\n // (...) \n\n4\n\n \"locale-switcher\", \n\n5\n\n \"login\", \n\n6\n\n \"minicart.v2\" \n\n7\n\n ] \n\n8\n\n}, \n\n`\n\n1. Open a ticket to our support team in order to adjust your store's binding with the desired languages.\n\n> _**Caution:** The third step is mandatory. If no ticket is opened requiring the desired languages, the selection list may not appear on the Locale Switcher component._\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ----------------- |\n| button |\n| buttonText |\n| container |\n| list |\n| listElement |\n| localeIdText |\n| relativeContainer |\n\n[Header« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.store-header)[LoginNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.login)\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.locale-switcher/docs/apps/vtex.locale-switcher%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.locale-switcher/docs/apps/vtex.locale-switcher%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_cee06d65
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore headless cms managing content with scopes and requiredscopes in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-overview)\n\n[Managing content with 'scopes' and 'requiredScopes'](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes)\n\n[Multiple page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-multiple-page-template)\n\n[Previewing Headless CMS in development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-previewing-changes-in-development-mode)\n\n[Widgets for Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-widgets)\n\n[Customizing pages with Dynamic Content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/dynamic-content-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-overview)\n\nManaging content with `scopes` and `requiredScopes`\n\nUse `scopes` and `requiredScopes` to define which store sections can be added to specific pages, ensuring proper content structure for your store.\n\n`scopes` and `requiredScopes` are Headless CMS schema definitions that determine which store sections can be added to specific pages (defined within [Content Types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-3-adding-content-types-and-sections%23step-2-adding-content-types-to-the-headless-cms)).\n\nThese features help manage the content structure and ensure store sections are used in appropriate contexts. For example, the [Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-hero) component is only available for the homepage or pages like the Product Details Page (PDP).\n\n## Before you begin\n\n### Update the `@faststore/core` package version\n\nMake sure you have `@faststore/core` version `3.0.18` or greater to benefit from this feature. If you do not have the updated package, follow the instructions in [Updating the @faststore/core package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-updating-the-core-package-version).\n\n### Set Headless CMS\n\nMake sure to have set up the Headless CMS files `content-types.json` and `sections.json` in your store project by following the [Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-2-setting-up-the-headless-cms) guide. These files contain the store’s custom Content Types and sections.\n\n### Understand FastStore customization options\n\nWhile FastStore doesn’t support custom Content Types, you can create [custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section). To control where these sections appear, use the `requiredScopes` property. Your custom sections will use the same scopes as FastStore’s default Content Types, ensuring consistency with the existing structure.\n\n## `scopes`\n\n`scopes` are labels that define the context provided by a Content Type. They help categorize Content Types based on their capabilities.\n\nThe `scopes` are string arrays within the definition of your Content Type in the [content-types.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-3-adding-content-types-and-sections%23step-2-adding-content-types-to-the-headless-cms). For example:\n\n`1\n\n{ \n\n2\n\n \"id\": \"home\", \n\n3\n\n \"name\": \"Home\", \n\n4\n\n \"scopes\": [\"home\"], \n\n5\n\n \"isSingleton\": true, \n\n6\n\n \"configurationSchemaSets\": [...] \n\n7\n\n} \n\n`\n\nIn this example, the `Home` Content Type stores content for your homepage and has a `home` scope. This `scope` definition means that only sections designed for the homepage context can be used with this Content Type.\n\n### Default FastStore `scopes`\n\nWhen [creating custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-3-adding-content-types-and-sections), you can restrict their usage to specific Content Types using these default scopes:\n\n| scopes name | Content Type |\n| ----------- | -------------------- |\n| custom | Landing Page |\n| global | Global Sections |\n| landing | Landing Page |\n| pdp | Product Details Page |\n| plp | Product Listing Page |\n| search | Search Page |\n\n> [Custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) must use these predefined `scopes` in their `requiredScopes`. This ensures they integrate with FastStore's content architecture.\n\n## `requiredScopes`\n\n`requiredScopes` define the Content Types a section can be used in. Similar to `scopes`, `requiredScopes` are specified as string arrays within the section definition in the [sections.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-3-adding-content-types-and-sections%23step-3-adding-sections-to-the-headless-cms).\n\nA section is only available for a Content Type in Headless CMS if the Content Type's `scopes` include at least one matching `scope` from the section's `requiredScopes`. Sections with an empty `requiredScopes` array can be used in any Content Type.\n\n> While you can define `requiredScopes` for [custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section), they must use scopes from [default Content Types](#default-faststore-scopes) to maintain consistency across all store sections.\n\nIn the following example, the [ProductShelf section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-product-shelf) is only available for PDPs:\n\n`1\n\n{ \n\n2\n\n \"name\": \"ProductShelf\", \n\n3\n\n \"requiredScopes\": [\"pdp\"], \n\n4\n\n \"schema\": {...}, \n\n5\n\n} \n\n`\n\n### Empty `requiredScopes`\n\nWhen a section has an empty `requiredScopes` (`[]`), the section is available for all Content Types. In the following example, the [Navbar section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar) is available for use in any Content Type because it has no required `scopes`:\n\n`1\n\n{ \n\n2\n\n \"name\": \"Navbar\", \n\n3\n\n \"requiredScopes\": [ ], \n\n4\n\n \"schema\": {...} \n\n5\n\n} \n\n`\n\n### Default FastStore `requiredScopes`\n\nWhen [creating custom sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-3-adding-content-types-and-sections%23step-3-adding-sections-to-the-headless-cms) for Headless CMS, you can use these default `requiredScopes` for specific Content Types:\n\n| requiredScopes name | Section name |\n| ------------------- | ------------------------------------------------- |\n| custom | CrossSellingShelf |\n| pdp | CrossSellingShelf, Breadcrumb, and ProductDetails |\n| plp | Breadcrumb and ProductGallery |\n| search | ProductGallery |\n\n## Using `scopes` and `requiredScopes`\n\nIn the following example, we will set up a new Content Type `Custom Page` to display a new `Call To Action` section.\n\n\n\n> To better understand this tutorial, make sure you create the new `Call To Action` component by following the instructions in the [Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section%23call-to-action) guide.\n\n### Setting up the Headless CMS files\n\n> Make sure you have set up the Headless CMS files `content-types.json` and `sections.json` in your store project by following the [Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-2-setting-up-the-headless-cms) guide. These files contain the store’s custom Content Types and sections.\n\n1. In the `content-types.json` file, create a new `Custom Page` Content Type by adding the following: \ncontent-types.json \n`1 \n{ \n2 \n \"id\": \"customPage\", \n3 \n \"name\": \"Custom Page\", \n4 \n \"scopes\": [\"custom\"], \n5 \n \"configurationSchemaSets\": [ \n6 \n { \n7 \n \"name\": \"Settings\", \n8 \n \"configurations\": [ \n9 \n { \n10 \n \"name\": \"seo\", \n11 \n \"schema\": { \n12 \n \"title\": \"SEO\", \n13 \n \"description\": \"Search Engine Optimization options\", \n14 \n \"type\": \"object\", \n15 \n \"widget\": { \n16 \n \"ui:ObjectFieldTemplate\": \"GoogleSeoPreview\" \n17 \n }, \n18 \n \"required\": [\"slug\", \"title\", \"description\"], \n19 \n \"properties\": { \n20 \n \"slug\": { \n21 \n \"title\": \"Path\", \n22 \n \"type\": \"string\", \n23 \n \"default\": \"/\" \n24 \n }, \n25 \n \"title\": { \n26 \n \"title\": \"Default page title\", \n27 \n \"description\": \"Display this title when no other title is available\", \n28 \n \"type\": \"string\", \n29 \n \"default\": \"FastStore Starter\" \n30 \n }, \n31 \n \"description\": { \n32 \n \"title\": \"Meta tag description\", \n33 \n \"type\": \"string\", \n34 \n \"default\": \"A beautifully designed store\" \n35 \n }, \n36 \n \"canonical\": { \n37 \n \"title\": \"Canonical url for the page\", \n38 \n \"type\": \"string\" \n39 \n } \n40 \n } \n41 \n } \n42 \n } \n43 \n ] \n44 \n } \n45 \n ] \n46 \n} \n` \nWe defined the `\"scopes\": [\"custom\"]` for the new `customPage` Content Type. The `custom` scope is also the [landingPage default scope in FastStore](#default-faststore-scopes).\n2. In the `sections.json` file, add the following: \nsections.json \n`1 \n[ \n2 \n { \n3 \n \"name\": \"CallToAction\", \n4 \n \"requiredScopes\": [\"custom\"], \n5 \n \"schema\": { \n6 \n \"title\": \"Call To Action\", \n7 \n \"description\": \"Get your 20% off on the first purchase!\", \n8 \n \"type\": \"object\", \n9 \n \"required\": [ \n10 \n \"title\", \n11 \n \"link\" \n12 \n ], \n13 \n \"properties\": { \n14 \n \"title\": { \n15 \n \"title\": \"Title\", \n16 \n \"type\": \"string\" \n17 \n }, \n18 \n \"link\": { \n19 \n \"title\": \"Link Path\", \n20 \n \"type\": \"object\", \n21 \n \"required\": [ \n22 \n \"text\", \n23 \n \"url\" \n24 \n ], \n25 \n \"properties\": { \n26 \n \"text\": { \n27 \n \"title\": \"Text\", \n28 \n \"type\": \"string\" \n29 \n }, \n30 \n \"url\": { \n31 \n \"title\": \"URL\", \n32 \n \"type\": \"string\" \n33 \n } \n34 \n } \n35 \n } \n36 \n } \n37 \n } \n38 \n } \n39 \n] \n`\n\nWe defined that the `Call To Action` section will only be available for `customPage` and `landingPage` Content Types.\n\n> The `Call To Action` section is also available for use with the `landingPage` Content Type because the [custom scope is FastStore's default](#default-faststore-scopes).\n\nWhen editing the `Custom Page` Content Type, the Headless CMS checks its scopes (`custom`) and matches them against the sections' `requiredScopes` (`custom`). Since the Call to Action section matches the `custom` scope (which is present in both the Custom Page and Landing Page Content Types), the section is available for use in these two Content Types.\n\n### Syncing the Headless CMS changes\n\n1. Open the terminal and run `yarn cms-sync` to sync the new files created in the previous step.\n2. In the VTEX Admin, go to **Storefront > Headless CMS**, and open the FastStore project.\n3. Click on the `Create Document` dropdown.\n4. Click on `Custom Page`: \n\n5. In the `Sections` tab, click on `Add Section` (`+`).\n6. Select the **Call To Action** section.\n7. Set the section fields as you wish.\n8. Click `Save`.\n9. Click `Preview` to preview the saved content. You will see a section similar to the image below with a title **Shop deals in Fashion** and a Call To Action button `See all deals`. \n\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/managing-content-with-scopes-and-requiredscopes.mdx)\n\n[Headless CMS« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-overview)[Multiple page templatesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-multiple-page-template)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23before-you-begin)\n\n[Update the @faststore/core package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23update-the-faststorecore-package-version)[Set Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23set-headless-cms)[Understand FastStore customization options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23understand-faststore-customization-options)\n\n[scopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23scopes)\n\n[Default FastStore scopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23default-faststore-scopes)\n\n[requiredScopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23requiredscopes)\n\n[Empty requiredScopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23empty-requiredscopes)[Default FastStore requiredScopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23default-faststore-requiredscopes)\n\n[Using scopes and requiredScopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23using-scopes-and-requiredscopes)\n\n[Setting up the Headless CMS files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23setting-up-the-headless-cms-files)[Syncing the Headless CMS changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23syncing-the-headless-cms-changes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/headless-cms/managing-content-with-scopes-and-requiredscopes.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23before-you-begin)\n\n[Update the @faststore/core package version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23update-the-faststorecore-package-version)[Set Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23set-headless-cms)[Understand FastStore customization options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23understand-faststore-customization-options)\n\n[scopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23scopes)\n\n[Default FastStore scopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23default-faststore-scopes)\n\n[requiredScopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23requiredscopes)\n\n[Empty requiredScopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23empty-requiredscopes)[Default FastStore requiredScopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23default-faststore-requiredscopes)\n\n[Using scopes and requiredScopes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23using-scopes-and-requiredscopes)\n\n[Setting up the Headless CMS files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23setting-up-the-headless-cms-files)[Syncing the Headless CMS changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes/docs/guides/faststore/headless-cms-managing-content-with-scopes-and-requiredscopes%23syncing-the-headless-cms-changes)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0c4d1f25
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides integrating a new payment provider on 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/integrating-a-new-payment-provider-on-vtex/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-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/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex)\n\nIntegrating a new payment provider on VTEX\n\nThis article is divided into steps that explain the integration flow for a new payment provider on VTEX. Before completing each step and moving on, make sure to check and understand the information in the related links, as well as any prerequisites and settings that need to be in place in the current step.\n\nThe integration flow of a new payment provider on VTEX has the following steps:\n\n1. [Payment Provider Protocol - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%231-payment-provider-protocol-overview)\n2. [Defining the operation environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%232-defining-the-operation-environment)\n3. [Selecting the infrastructure type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%233-selecting-the-infrastructure-type)\n4. [Defining the purchase flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%234-defining-the-purchase-flow)\n5. [Additional requirements and settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%235-additional-requirements-and-settings)\n6. [Connector tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%236-connector-tests)\n7. [Homologation and Go-live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%237-homologation-and-go-live)\n\nThe following flowchart shows the possible journeys within the integration process.\n\n\n\n## 1\\. Payment Provider Protocol - Overview\n\nPayment service providers (PSP), or simply payment providers, are companies that support electronic transactions with different payment methods, such as credit cards or digital wallets.\n\nTo operate in the VTEX environment, payment providers need to be integrated through the Payment Provider Protocol (PPP). This protocol defines the necessary prerequisites and settings that the payment methods available in your connector need to have in order to work in VTEX stores.\n\nTo understand how the Payment Provider Protocol works and the routes used in the payment and authentication flows, see:\n\n* [Payment Provider Protocol - Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m)\n* [Payment Provider Protocol - API References](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol)\n\nAfter making sure you meet the PPP implementation [prerequisites](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m%23implementation-prerequisites), the next step is defining how your connector will work in the VTEX environment.\n\n## 2\\. Defining the operation environment\n\nOn VTEX, a payment connector can operate in three different contexts: ecommerce websites, physical stores, or both. Select the option that matches the operating characteristics of your connector.\n\n### Operating payments on the ecommerce website only\n\nA payment connector can handle purchases for all virtual stores within the VTEX ecosystem, whether they be national or international.\n\n> To process sales in countries other than your home country, check if your payment system meets the financial regulations of every country where you wish to operate. In addition, you need to sign a local or global partnership agreement with VTEX. Learn more in [Become a VTEX partner](https://read.calvincode.net/reader?url=https://vtex.com/us-en/partner/).\n\n### Operating payments in the physical stores only\n\nFor payment operations in physical stores, VTEX offers the VTEX Sales App solution. This app enables sales associates to offer a complete and customized in-person experience for each customer, tracking the purchase process from selecting the product to delivering the order.\n\n> Connectors developed for VTEX Sales App also use the Payment Provider Protocol (PPP).\n\nTo learn more about VTEX Sales App, see:\n\n* [VTEX Sales App - Getting started and setting up](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/instore-getting-started-and-setting-up--zav76TFEZlAjnyBVL5tRc/7fnnVlG3Kv1Tay9iagc5yf)\n* [VTEX Sales App - Using the app](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/instore-using-the-app--4BYzQIwyOHvnmnCYQgLzdr/6cq4E1JCmA6vCvBCCtAgIM)\n* [VTEX Sales App - Payments](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/instore-payments--43B4Nr7uZva5UdwWEt3PEy/2liigRors32hzqBNs2M1Oa)\n* [Payment Provider Protocol applied to payments with POS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-ppp-applied-to-pos)\n\n### Operating payments in both physical stores and ecommerce website\n\nIf you want to offer a payment experience in physical stores and on the ecommerce website, you will need to configure settings for both cases.\n\nTo learn more about this type of operation, in addition to the documentation references linked in previous sections, see [Unified Commerce Strategies](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/unified-commerce-strategies--3WGDRRhc3vf1MJb9zGncnv/2LGAiUnHES1enjHsfi8fI3).\n\n> You can develop a single connector configured to work in both environments (physical stores and ecommerce websites). You do not have to create a connector for each type of operation.\n\n## 3\\. Selecting the infrastructure type\n\nWhen implementing the payment connector on VTEX, you can use the internal infrastructure of your company or our low-code development platform, [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io).\n\n### Developing with internal infrastructure\n\nYou can develop a connector using your internal infrastructure. In this case, you need to make sure that the architecture allows secure communication between you (payment provider) and the VTEX gateway.\n\nTo protect sensitive information, like credit card numbers, during transactions, you need to have the [PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://www.pcisecuritystandards.org/document%5Flibrary/?document=pci%5Fdss) security certification or use Secure Proxy, the VTEX solution that replaces confidential information with encrypted tokens.\n\nTo learn more about how to develop the integration (middleware) and transfer sensitive payment information, see:\n\n* [Implementing a Payment Provider - Middleware](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider)\n* [PCI - DSS Compliance - Developer Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance)\n* [Secure proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy)\n\n### Developing with VTEX infrastructure (VTEX IO)\n\nIf you want to develop your connector using VTEX infrastructure, you can use our [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io), our proprietary development platform. VTEX IO offers the following advantages:\n\n* Greater integration agility by reusing VTEX templates and clients.\n* [Serverless](https://read.calvincode.net/reader?url=https://www.redhat.com/en/topics/cloud-native-apps/what-is-serverless) environment with no need to invest additional financial resources related to infrastructure, reliability, and security management.\n* Simplified authentication, authorization, and configuration resources that are integrated with all other VTEX systems.\n\nIf you use our infrastructure, you can also use our VTEX IO boilerplate, **Payment Provider Framework (PPF)**, which makes creating the connector faster in comparison to using your own infrastructure. With PPF, you do not have to manually configure the API routes, response and request body default formats, and sensitive information transfer (such as credit card information).\n\nTo learn more about development using VTEX IO and how the Payment Provider Framework works, see:\n\n* [What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io)\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)\n* [Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework)\n\n## 4\\. Defining the purchase flow\n\nA purchase flow represents the steps or actions that a customer takes to complete the payment of a purchase. On VTEX, the [available purchase flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows) are: transparent or custom (Payment App or Redirect). Select the option that matches the operating characteristics of your connector.\n\n### Transparent\n\nIn the transparent purchase flow, the customer enters the payment information and places the order directly in the checkout of the VTEX store. This is the most widely used flow type because it allows completing all payment steps in the same environment, which improves the customer purchase experience.\n\nTo learn more about the transparent purchase flow, see [What is transparent checkout?](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-transparent-checkout--2Y4ECegUmcYUggmck2GOwe).\n\n### Custom\n\nIf you do not want to use the native VTEX purchase flow (transparent), you have two options to create custom payment experiences for your customer: Payment App and Redirect.\n\n#### Payment App\n\nPayment App is an app created in [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io), which enables a payment provider to create a custom payment experience without having to redirect the customer to an external page, unlike the redirect purchase flow.\n\nIf your connector is being developed using [VTEX infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%23developing-with-vtex-infrastructure-vtex-io), you can implement Payment App in two different ways:\n\n1. [Create a specific app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-an-app) for Payment App.\n2. Use the connector's app. In this case, you have to create a specific React folder for Payment App within the connector app.\n\n> Connectors that only [operate payments in physical stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%23operating-payments-in-the-physical-stores-only) are required to use Payment App as the default purchase flow.\n\nTo learn more, see [Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app).\n\n#### Redirect\n\nIn this flow, the customer selects the payment option in the VTEX store and is redirected to an external page to complete their payment information. After completing the fields and confirming the payment, the customer is redirected back to the order confirmation screen in the VTEX store.\n\n> The redirect flow involves the most friction and the lowest purchase conversion rate, making it the least recommended flow.\n\nTo learn more about the redirect purchase flow, see [Purchase Flows - Redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows%23redirect).\n\n#### Layout modification (optional)\n\nWhen you implement Payment App or Redirect in your connector, you can also create a non-interactive custom layout (using HTML and CSS) that will be displayed on VTEX Checkout.\n\nTo learn how to create a custom payment layout, see [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).\n\n### Payment provider and VTEX interactions in the purchase flow\n\nIn addition to defining the best purchase flow, you need to know the operation and communication patterns between your connector and the VTEX payment gateway. To learn more, see:\n\n* [Payment flow - Operations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows%23operations-in-the-payment-flow)\n* [Payment flow - Communication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows%23communication-in-the-payment-flow)\n\n### Configuration flow information\n\nThe [configuration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider%23configuration-flow) has three endpoints ([Create Authorization Token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/authorization/token), [Provider Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/authorization/redirect), and [Get Credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/authorization/credentials)), designed to improve merchant experience when enabling your connector on the VTEX Admin.\n\nThis flow enables the merchant to authenticate in your connector through the VTEX Admin using the `appKey`, `appToken`, and `applicationId` as credentials. Also, you can use this resource to provide other authentication methods for the merchant, such as login on your platform or even an initial registration.\n\n> Implementing a configuration flow is optional. It can be done during middleware creation when you develop the connector using [your own infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider%23developing-with-internal-infrastructure) or with the [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider%23developing-with-vtex-infrastructure-vtex-io).\n\n## 5\\. Additional requirements and settings\n\nDepending on the payment method or features that your connector offers, you might need to meet specific requirements or configure additional settings.\n\n* **Payment methods (ecommerce website)** \n * **Debit, credit, or co-branded cards**: Make sure that your connector has the [PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance) certification. If you don't have or don't want to use that certification in your connector, you can implement [Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy).\n* **Payment methods (physical store)** \n * **Direct credit sale and direct debit sale**: Make sure that both these payment methods were configured as described in [Payment Provider Protocol applied to payments with POS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-ppp-applied-to-pos%23payment-connector-pre-requisites).\n* **Features** \n * **Split Payout**: This solution enables marketplaces to manage order amounts, and it divides your commission and the amount due to the seller. Learn more in: \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) \n * [Split Payment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/split-payment--6k5JidhYRUxileNolY2VLx) \n * **Custom Auto Capture**: This solution enables the merchant to set a window for automatic capture after the payment is completed. Learn more in Custom Auto Capture Feature. \n * **Inbound Request**: URL directly connected between the VTEX gateway and the payment provider. Learn more in 6\\. POST Inbound Request (BETA) in [Payment Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-implementing-a-payment-provider%23payment-flow).\n\n## 6\\. Connector Tests\n\nAfter connector development is complete, you can use [Test Suite App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-homologation%23install-the-test-suite-app) to test the following routes:\n\n* [Create Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments)\n* [Cancel Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/cancellations)\n* [Settle Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/settlements)\n* [Refund Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments/-paymentId-/refunds)\n\nLearn more about Test Suite App tests in [Testing details](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m%234-testing).\n\nYou can also access your test store to [simulate payment of an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework%23placing-an-order-with-your-new-connector) before starting the connector homologation process on VTEX.\n\n## 7\\. Homologation and Go-live\n\nAfter completing all the above stages, ensuring that all the necessary requirements and settings are in place, and getting positive test results, you need to request connector homologation by opening a [ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM?locale=en) with VTEX support.\n\n> The required SLA for homologation is 30 days, which may vary depending on any inconsistencies found in the connector development.\n\nAfter the homologation process is completed, you will receive a confirmation message and your connector will be available for configuration to VTEX Admin merchants.\n\n> If you want to increase the visibility of your connector in another channel, you can also publish your connector on the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/). Learn more in [Making your connector available to everyone](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework%23making-your-connector-available-to-everyone) and [Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store).\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/integrating-a-new-payment-provider-on-vtex.md)\n\n[Payments« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex//docs/guides/payments-integration-guide)[Payment Provider ProtocolNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex//docs/guides/payments-integration-payment-provider-protocol)\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[1\\. Payment Provider Protocol - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%231-payment-provider-protocol-overview)\n\n[2\\. Defining the operation environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%232-defining-the-operation-environment)\n\n[Operating payments on the ecommerce website only](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23operating-payments-on-the-ecommerce-website-only)[Operating payments in the physical stores only](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23operating-payments-in-the-physical-stores-only)[Operating payments in both physical stores and ecommerce website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23operating-payments-in-both-physical-stores-and-ecommerce-website)\n\n[3\\. Selecting the infrastructure type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%233-selecting-the-infrastructure-type)\n\n[Developing with internal infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23developing-with-internal-infrastructure)[Developing with VTEX infrastructure (VTEX IO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23developing-with-vtex-infrastructure-vtex-io)\n\n[4\\. Defining the purchase flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%234-defining-the-purchase-flow)\n\n[Transparent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23transparent)[Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23custom)[Payment provider and VTEX interactions in the purchase flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23payment-provider-and-vtex-interactions-in-the-purchase-flow)[Configuration flow information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23configuration-flow-information)\n\n[5\\. Additional requirements and settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%235-additional-requirements-and-settings)\n\n[6\\. Connector Tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%236-connector-tests)\n\n[7\\. Homologation and Go-live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%237-homologation-and-go-live)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/integrating-a-new-payment-provider-on-vtex.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[1\\. Payment Provider Protocol - Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%231-payment-provider-protocol-overview)\n\n[2\\. Defining the operation environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%232-defining-the-operation-environment)\n\n[Operating payments on the ecommerce website only](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23operating-payments-on-the-ecommerce-website-only)[Operating payments in the physical stores only](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23operating-payments-in-the-physical-stores-only)[Operating payments in both physical stores and ecommerce website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23operating-payments-in-both-physical-stores-and-ecommerce-website)\n\n[3\\. Selecting the infrastructure type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%233-selecting-the-infrastructure-type)\n\n[Developing with internal infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23developing-with-internal-infrastructure)[Developing with VTEX infrastructure (VTEX IO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23developing-with-vtex-infrastructure-vtex-io)\n\n[4\\. Defining the purchase flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%234-defining-the-purchase-flow)\n\n[Transparent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23transparent)[Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23custom)[Payment provider and VTEX interactions in the purchase flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23payment-provider-and-vtex-interactions-in-the-purchase-flow)[Configuration flow information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%23configuration-flow-information)\n\n[5\\. Additional requirements and settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%235-additional-requirements-and-settings)\n\n[6\\. Connector Tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%236-connector-tests)\n\n[7\\. Homologation and Go-live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex/docs/guides/integrating-a-new-payment-provider-on-vtex%237-homologation-and-go-live)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0378e7bd
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex store components shippingsimulator in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/updates/release-notes)\n\nShipping Simulator\n\nThe `shipping-simulator` block estimates the shipping fee based on a zip code input.\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 `shipping-simulator` block to any child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"shipping-simulator\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `shipping-simulator` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"shipping-simulator\": { \n\n2\n\n \"props\": { \n\n3\n\n \"skuID\": \"342\" \n\n4\n\n } \n\n5\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------- |\n| pricingMode | enum | If the product has gifts or attachments, for example, you can choose whether the shipping information will be grouped (grouped) by shipping type or showing the shipping prices for each of the items individually (individualItems). | individualItems |\n| seller | String | ID of the product seller. | \\- |\n| shouldUpdateOrderForm | Boolean | Whether interacting with the simulator should update the shopper's address in their orderForm. | true |\n| skuId | String | ID of the current product SKU. | \\- |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| --------------------------------- |\n| shippingContainer |\n| shippingContainerLoader |\n| shippingCTA |\n| shippingInputLoader |\n| shippingNoMessage |\n| shippingTable |\n| shippingTableBody |\n| shippingTableCell |\n| shippingTableCellDeliveryEstimate |\n| shippingTableCellDeliveryName |\n| shippingTableCellDeliveryPrice |\n| shippingTableHead |\n| shippingTableHeadDeliveryEstimate |\n| shippingTableHeadDeliveryName |\n| shippingTableHeadDeliveryPrice |\n| shippingTableLabel |\n| shippingTableRadioBtn |\n| shippingTableRow |\n| shippingZipcodeLabel |\n| shippingZipcodeLabelLoader |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-components/vtex-store-components-shippingsimulator.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/guides/vtex-store-components-shippingsimulator%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/guides/vtex-store-components-shippingsimulator%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/guides/vtex-store-components-shippingsimulator%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-components/vtex-store-components-shippingsimulator.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/guides/vtex-store-components-shippingsimulator%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/guides/vtex-store-components-shippingsimulator%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-shippingsimulator/docs/guides/vtex-store-components-shippingsimulator%23customization)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_bd4d05ac
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides payments integration payment provider framework in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-guide)\n\n[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/integrating-a-new-payment-provider-on-vtex)\n\n[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-protocol)\n\n[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-ppp-applied-to-pos)\n\n[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-implementing-a-payment-provider)\n\n[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\n[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-secure-proxy)\n\n[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/split-payouts-on-payment-provider-protocol)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n\n[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/custom-auto-capture-feature)\n\n[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-pix-instant-payments-in-brazil)\n\n[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/pse-payment-method)\n\n[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-guide)\n\n[Integrating a new payment provider on VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/integrating-a-new-payment-provider-on-vtex)\n\n[Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-protocol)\n\n[Payment Provider Protocol for Point of Sale (POS) - VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-ppp-applied-to-pos)\n\n[Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-implementing-a-payment-provider)\n\n[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)\n\n[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-secure-proxy)\n\n[Split Payouts on Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/split-payouts-on-payment-provider-protocol)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)\n\n[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/custom-auto-capture-feature)\n\n[Pix: Instant Payments in Brazil](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-pix-instant-payments-in-brazil)\n\n[PSE Payment Method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/pse-payment-method)\n\n[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-guide)\n\n[Payment Provider Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework)\n\nPayment Provider Framework\n\nPayment Provider Framework (PPF) is an alternative way to develop payment connectors for your integration through VTEX IO. Since the development is based on a boilerplate of an IO app, a lot of the work is already done to implement the needed feature including the [API routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payment-provider-protocol-api-overview), the types used in the request and response bodies, and the [Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy). With PPF, developers also do not need to worry about hosting the connector since it is hosted on the IO infrastructure.\n\n> To develop a new payment connector, it is mandatory to follow the **prerequisites determined by VTEX**. You can learn about them in the [Implementation prerequisites section of our Payment Provider Protocol article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol--RdsT2spdq80MMwwOeEq0m%23implementation-prerequisites). For more information on how payment providers can be integrated into VTEX, visit [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\n## Getting started\n\n### Cloning base repository\n\nIf you are starting a brand new project, we recommend you to clone the [example repository](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/payment-provider-example), as it already has all the basic configuration setup.\n\n### Updating your project\n\nOnce you have the repository code in your workspace, you have to make sure you have all the necessary dependencies and that they are updated. To do so, follow these steps:\n\n1. Run the following command on your node folder:\n\n`1\n\n yarn add @vtex/payment-provider \n\n`\n\n1. Go to your `package.json` and make sure it has been added as a dependency with the correct version:\n\n`1\n\n \"@vtex/payment-provider\": \"1.x\" \n\n`\n\n1. Check in the `package.json` the version of `@vtex/api`, which should be listed in the devDependencies as follows:\n\n`1\n\n \"@vtex/api\": \"6.x\" \n\n`\n\n1. When linking your app, this version might get updated to a later than 6.x version, which is fine. In case it is not listed as a `devDependency`, run the following command on your node folder:\n\n`1\n\n yarn add -D @vtex/api \n\n`\n\n> If you get any type errors or conflicts in your project related to `@vtex/api`, follow these steps: 1\\. Delete the `node_modules` folder and the `yarn.lock` file from both your project root and your project's node folder. 2\\. Run the command `yarn install -f` in both folders.\n\n1. In your `manifest.json`, you should check the builders section, in which you must include the `paymentProvider` in its current version. This will add policies to callback the Payment Gateway APIs and also expose Payment Provider protocol routes.\n\n`1\n\n\"builders\": { \n\n2\n\n \"node\": \"6.x\", \n\n3\n\n \"paymentProvider\": \"1.x\" \n\n4\n\n} \n\n`\n\n## Next steps\n\nIn order to create your service, you must implement your [payment provider connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework%23payment-provider) and the [service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework%23payment-provider-service) itself, as described in the sections below.\n\n## Payment Provider\n\nThis is an abstract class with the signatures of the route functions required in your connector, according to the [protocol](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol).\n\nYou must create a new class extending the Payment Provider, which must implement a function for each route. The functions will receive the request body (when there is one) as a parameter and the response must be returned as an object, such as the example shown below:\n\n`1\n\nimport { \n\n2\n\n PaymentProvider, \n\n3\n\n // ... \n\n4\n\n} from '@vtex/payment-provider' \n\n5\n\n \n6\n\nclass YourPaymentConnector extends PaymentProvider { \n\n7\n\n \n8\n\n // ... implementation of the other routes functions \n\n9\n\n} \n\n`\n\n> Typescript should automatically check for typing errors, but if you need, you can check the requests and responses signatures from the [Payment Flow endpoints in our API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23get-/manifest).\n\n### Payment Provider builder\n\nTo specify which payment methods the connector will accept to process, follow the steps below:\n\n1. Create a folder named `paymentProvider` using the following folder structure.\n\n`1\n\nnode \n\n2\n\npaymentProvider \n\n3\n\nmanifest.json \n\n`\n\n1. Create a file named `configuration.json` inside the `paymentProvider` folder.\n\n`1\n\nnode \n\n2\n\npaymentProvider \n\n3\n\n |--configuration.json \n\n4\n\nmanifest.json \n\n`\n\n1. Declare the payment methods accepted by your payment provider. This action allows them to be implemented automatically by the builder, without the need to declare them in the `/manifest` route.\n\n`1\n\n{ \n\n2\n\n \"name\": \"MyConnector\", \n\n3\n\n \"paymentMethods\": [ \n\n4\n\n { \n\n5\n\n \"name\": \"Visa\", \n\n6\n\n \"allowsSplit\": \"onCapture\" \n\n7\n\n }, \n\n8\n\n { \n\n9\n\n \"name\": \"American Express\", \n\n10\n\n \"allowsSplit\": \"onCapture\" \n\n11\n\n }, \n\n12\n\n { \n\n13\n\n \"name\": \"Diners\", \n\n14\n\n \"allowsSplit\": \"onCapture\" \n\n15\n\n }, \n\n16\n\n { \n\n17\n\n \"name\": \"Elo\", \n\n18\n\n \"allowsSplit\": \"onCapture\" \n\n19\n\n }, \n\n20\n\n { \n\n21\n\n \"name\": \"Hipercard\", \n\n22\n\n \"allowsSplit\": \"onCapture\" \n\n23\n\n }, \n\n24\n\n { \n\n25\n\n \"name\": \"Mastercard\", \n\n26\n\n \"allowsSplit\": \"onCapture\" \n\n27\n\n }, \n\n28\n\n { \n\n29\n\n \"name\": \"BankInvoice\", \n\n30\n\n \"allowsSplit\": \"onAuthorize\" \n\n31\n\n } \n\n32\n\n ] \n\n33\n\n} \n\n`\n\n> The `name` field indicating the name of the connector must be replaced with the name of your provider. This field cannot be filled with a value `\"MyConnector\"`.\n\n> To check which payment methods are currently available in the VTEX Admin, go to Store **Settings > Payment > Settings**, or type **Settings** in the search bar at the top of the page and click the green `+` button. If you want to support a new payment method that is not available, you need to [open a ticket to the VTEX team](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) informing them of this new payment method.\n\nYou can also declare the `customFields` array to allow your payment provider to send specific information. The `type` field can be configured as follows: `text` for non-confidential data; `password` for sensitive and security information (except `appKey` and `AppToken` which should not be sent in this field); and `select` to group a set of custom information.\n\n`1\n\n{ \n\n2\n\n \"name\": \"MyConnector\", \n\n3\n\n \"paymentMethods\": [ \n\n4\n\n ... \n\n5\n\n ], \n\n6\n\n \"customFields\": [ \n\n7\n\n { \n\n8\n\n \"name\": \"Company account\", \n\n9\n\n \"type\": \"text\" \n\n10\n\n }, \n\n11\n\n { \n\n12\n\n \"name\": \"POS URL\", \n\n13\n\n \"type\": \"text\" \n\n14\n\n }, \n\n15\n\n { \n\n16\n\n \"name\": \"Client key\", \n\n17\n\n \"type\": \"password\" \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n \"name\": \"Auto Capture Settings\", \n\n21\n\n \"type\": \"select\", \n\n22\n\n \"options\": [ \n\n23\n\n { \n\n24\n\n \"text\": \"Automatic Capture Immediately After Payment Authorization\", \n\n25\n\n \"value\": \"Immediately\" \n\n26\n\n }, \n\n27\n\n { \n\n28\n\n \"text\": \"Auto Settle Delay: 7 Days\", \n\n29\n\n \"value\": \"Deactivated\" \n\n30\n\n } \n\n31\n\n ] \n\n32\n\n } \n\n33\n\n ] \n\n34\n\n} \n\n`\n\n### Overriding the Manifest route\n\nIf you wish to override the default `/manifest` route due to some specific feature of your provider, please [open a ticket to the VTEX support team](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) describing your use case and add special parameters as specified below.\n\n`1\n\n{ \n\n2\n\n \"memory\": 256, \n\n3\n\n \"ttl\": 10, \n\n4\n\n \"timeout\": 10, \n\n5\n\n \"minReplicas\": 2, \n\n6\n\n \"maxReplicas\": 3, \n\n7\n\n \"routes\": { \n\n8\n\n \"manifest\": { \n\n9\n\n \"path\": \"/_v/api/my-connector/manifest\", \n\n10\n\n \"handler\": \"vtex.payment-gateway@1.x/providerManifest\", \n\n11\n\n \"headers\": { \n\n12\n\n \"x-provider-app\": \"$appVendor.$appName@$appVersion\", \n\n13\n\n }, \n\n14\n\n \"public\": true \n\n15\n\n } \n\n16\n\n } \n\n17\n\n} \n\n`\n\n> The `x-provider-app` parameter must be updated whenever there is an important change (e.g. vtex.payment-provider-example@1.2.3). You can also omit the `handler` and `headers` parameters, however, when performing this procedure you will need to implement them yourself.\n\n### Available Configurable Options\n\nIn addition to the manifest fields (`paymentMethods` and `customFields`), the following configuration options are available:\n\n| Parameter name | Required | Default | Description |\n| -------------------------- | -------- | --------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| name | Yes | Payment provider connector name. | |\n| serviceUrl | Yes | Auto-generated for IO connectors. | A valid URL (can include relative paths). |\n| implementsOAuth | No | false | Defines whether the provider implements the configuration flow with OAuth authentication support. |\n| implementsSplit | No | false | Defines whether the provider implements the payment split flow. |\n| usesProviderHeadersName | No | true | Defines whether the provider will receive appKey and appToken headers as \"x-provider-api-appKey\" and \"x-provider-api-appToken\" respectively. |\n| useAntifraud | No | false | Defines whether anti-fraud providers can be used in the payment provider's transactions. |\n| usesBankInvoiceEnglishName | No | false | Defines if the Bank Invoice payment method will use the English name (true), or the Brazilian name (Boleto Bancário)(false). |\n| usesSecureProxy | No | true | If true, the provider can process payment without being [PCI-Certified](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance). The connector will receive a secureProxyUrl on createPayment flow, and the card encrypted data. If false, the provider must be a PCI-Certified entity, and you should send the AOC containing the provided serviceUrl. |\n| requiresDocument | No | false | If true, the customer must include the cardholder document on Checkout. A new field will appear on the Checkout form. If false, the customer does not need to include a cardholder document. |\n| acceptSplitPartialRefund | No | false | If true, a partial refund will be sent when a payment split occurs. If false, the connector couldn't process a partial refund when a payment split occurs. |\n| usesAutoSettleOptions | No | false | If true, the client will be able to choose the behavior of the auto settlement in the VTEX admin configurations of the provider. The available options are as follows: \"Use behavior recommended by the payment processor\", \"Automatic capture immediately after payment authorization\", \"Automatic capture immediately after anti-fraud analysis\", \"Scheduled: schedules the automatic capture\" and \"Deactivated: not automatically captured\". If false, the connector will not have this dropdown configuration field for auto settlement. More information can be found in the [Custom Auto Capture Feature article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature). |\n\n### Request a retry from Payment Gateway\n\nA retry is required to develop your connector according to the [protocol](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol), and for this action, the function below must be invoked:\n\n`1\n\nthis.retry(request) \n\n`\n\n> More information about the retry flow can be found in the [Payment Authorization section of the Payment Provider Protocol article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/payment-provider-protocol%23payment-authorization).\n\n### Payment Provider Service\n\nThis is a class that extends the Service from `@vtex/api`. You must invoke it by passing the developed connector as a property of the first parameter and it will automatically set up the required routes for you.\n\nThe following code shows how to do this and find it in the `node/index.ts` file.\n\n`1\n\nimport { \n\n2\n\n PaymentProviderService, \n\n3\n\n} from '@vtex/payment-provider' \n\n4\n\n \n5\n\nnew PaymentProviderService({ \n\n6\n\n connector: YourPaymentConnector, \n\n7\n\n}) \n\n`\n\nBy default, the Payment Provider Service declares the following routes:\n\n* `/manifest`\n* `/payments`\n* `/settlements`\n* `/refunds`\n* `/cancellations`\n* `/inbound`\n\nIf your service requires any extra routes, you must declare them separately and use them as parameters:\n\n`1\n\nnew PaymentProviderService({ \n\n2\n\n routes: newRoutes, \n\n3\n\n connector: YourPaymentConnector, \n\n4\n\n}) \n\n`\n\nIf your connector requires any extra clients, you must also pass them in the parameters along with the connector:\n\n`1\n\nnew PaymentProviderService({ \n\n2\n\n clients: NewClients, \n\n3\n\n connector: YourPaymentConnector, \n\n4\n\n}) \n\n`\n\n### Using Secure Proxy\n\nFor processing credit, debit or co-branded card transactions, integrations must be compliant with [PCI-DSS security standards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance). For integrations hosted in VTEX IO supporting one of those payment methods, it is mandatory to use Secure Proxy to make calls to a PCI-certified endpoint. You can check more details in the [Secure Proxy article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-secure-proxy).\n\n> The endpoint must be allowed by VTEX Secure Proxy. This must be [requested via ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support) sending the AOC with the wanted endpoint. Currently the Secure Proxy only accepts two Content-Types: You can use `\\\"application/json\\\"` or `\\\"application/x-www-form-urlencoded\\\"`. Any other Content-Type will not be supported.\n\nTo make calls over our Secure Proxy, you must:\n\n1. Extend the `SecureExternalClient` abstract class. The constructor of the class is made in a way that VTEX allows `'http://my-pci-certified-domain.com'` as one of the trusted destinations by receiving its AOC.\n2. Set the Secure Proxy URL on the request that you want to be proxied. `SecureProxyURL` is received on `createPayment` flow.\n\n`1\n\nimport { SecureExternalClient, CardAuthorization } from '@vtex/payment-provider' \n\n2\n\nimport type { \n\n3\n\n InstanceOptions, \n\n4\n\n IOContext, \n\n5\n\n RequestConfig, \n\n6\n\n} from '@vtex/api' \n\n7\n\n \n8\n\nexport class MyPCICertifiedClient extends SecureExternalClient { \n\n9\n\n constructor(protected context: IOContext, options?: InstanceOptions) { \n\n10\n\n super('http://my-pci-certified-domain.com', context, options) \n\n11\n\n } \n\n12\n\n \n13\n\n public myPCIEndpoint = (cardRequest: CardAuthorization) => { \n\n14\n\n return this.http.post( \n\n15\n\n 'my-pci-endpoint', \n\n16\n\n { \n\n17\n\n holder: cardRequest.holderToken, \n\n18\n\n number: cardRequest.numberToken, \n\n19\n\n expiration: cardRequest.expiration, \n\n20\n\n csc: cardRequest.cscToken \n\n21\n\n }, \n\n22\n\n { \n\n23\n\n headers: { \n\n24\n\n Authorization: 'my-pci-endpoint-authorization', \n\n25\n\n }, \n\n26\n\n secureProxy: cardRequest.secureProxyUrl, \n\n27\n\n } as RequestConfig \n\n28\n\n ) \n\n29\n\n } \n\n30\n\n} \n\n`\n\n## Placing an order with your new connector\n\nNow that you have a new connector ready to be used, you can test it entirely in the production flow using your store's Checkout.\n\n> The account must be allowed to test IO Connectors. This must be [requested via ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) informing the name of the app and the account where the tests will be made.\n\nA prerequisite for this procedure is to have products for sale at your store for testing. To place an order with your new connector:\n\n1. Launch a beta version of your connector. E.g.: `vtex.payment-provider-test@0.1.0-beta`. If you need, check the [Making your app publicly available article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23launching-a-new-version) to learn how to create a beta version of your app.\n2. Install the beta version on `master` workspace. Wait for around 1 hour.\n3. Go to `https://{account}.myvtex.com/admin/affiliations/connector/Vtex.PaymentGateway.Connectors.PaymentProvider.PaymentProviderConnector_{connector-name}/`. Replace `{account}` for the name of the account you want to test on and `{connector-name}` for the name of your connector. The format of the name is: `${vendor}-${appName}-${appMajor}` (e.g.: `vtex-payment-provider-example-v1`). \n\n4. In **Payment Control**, activate the test environment by clicking **Enable test mode**. A new field called **Workspace** will appear.\n5. Set the **Workspace** as you wish. You can leave it as `master` if it is the workspace you want to test on. \n\n6. Configure a [payment condition](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-configure-payment-conditions--tutorials%5F455) with your newly created connector and wait 10 minutes to appear on Checkout.\n7. Make a purchase with the payment condition you configured with your connector.\n8. After completing all transaction testing in the beta version of the connector, [release and deploy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available%23step-6---deploying-the-app-stable-version) a stable version of your connector (e.g.: vtex.payment-provider-test@0.1.0). This stable version must be sent to the [homologation process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/integrating-a-new-payment-provider-on-vtex%237-homologation-and-go-live).\n\n## Making your connector available to process sales\n\n> To process sales with your connector on all VTEX accounts, make sure to send the `billingOptions` field indicated as `free` in the manifest. If you want to restrict the use of the connector to only a few specific accounts, the `billingOptions` field must also be sent as `free`, but the payments team must be notified via a [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) to enable the connector only for the desired accounts. More information about this field can be found in the [Billing Options article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-billing-options).\n\nThe publication process is made via the [app store](https://read.calvincode.net/reader?url=https://apps.vtex.com/). More info on how to do that can be found in the [Submitting your app to the VTEX App Store article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store).\n\nAfter that, you need to [open a ticket to the VTEX support team](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM?locale=en) informing them that the integration was completed. However, before opening the ticket, make sure you have the following information:\n\n* **Connector App Name**: Name of the PPF connector app. Use the following format: `\"vendor.appname\"`. For example: `partnername.connector-partnername`. These can be found in the `manifest.json` file.\n* **Partner contact**: partner email address in case we need to communicate changes and new features of our protocol.\n* **Production Service Provider Endpoint**: the base path that will be used for API calls to the provider, e.g. `https://vtex.pagseguro.com`. It has to respond to the route `{{serviceUrl}}/manifest` . This endpoint must be publicly available.\n* **Allowed Accounts**: describe which VTEX accounts from this provider will be available (all accounts or specific accounts).\n* **New Payment methods**: inform if this connector supports a payment method that is not yet available in the VTEX Admin.\n* **New Payment method purchase flow**: if a \"New Payment method\" is supported, inform whether it works with Redirect or Payment App. For more information, access the [Purchase Flows article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-purchase-flows).\n\nThe SLA required for the payment team to carry out homologation is 30 days.\n\nAfter the homologation step is complete, your app needs to be installed in the account that wants to use it. Then, a new affiliation will be available to configure it.\n\n## Updating and testing new configurations for an already published connector\n\nTo change and test new settings in an already published connector, you must:\n\n1. Apply the new settings to the last created beta version of your connector.\n2. Follow the same procedures described in the [Placing an order with your new connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework%23placing-an-order-with-your-new-connector) section to verify that the beta version of your connector is working correctly after applying the new settings.\n3. Create and submit a new stable version of your connector (containing the same modifications as the beta version) to the homologation process. E.g.: vtex.payment-provider-test@0.1.1.\n4. Publish it as indicated in the [Making your connector available to process sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework%23making-your-connector-available-to-process-sales) section.\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-payment-provider-framework.md)\n\n[Implementing a Payment Provider« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework//docs/guides/payments-integration-implementing-a-payment-provider)[Purchase FlowsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework//docs/guides/payments-integration-purchase-flows)\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23getting-started)\n\n[Cloning base repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23cloning-base-repository)[Updating your project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23updating-your-project)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23next-steps)\n\n[Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23payment-provider)\n\n[Payment Provider builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23payment-provider-builder)[Overriding the Manifest route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23overriding-the-manifest-route)[Available Configurable Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23available-configurable-options)[Request a retry from Payment Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23request-a-retry-from-payment-gateway)[Payment Provider Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23payment-provider-service)[Using Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23using-secure-proxy)\n\n[Placing an order with your new connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23placing-an-order-with-your-new-connector)\n\n[Making your connector available to process sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23making-your-connector-available-to-process-sales)\n\n[Updating and testing new configurations for an already published connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23updating-and-testing-new-configurations-for-an-already-published-connector)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-payment-provider-framework.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23getting-started)\n\n[Cloning base repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23cloning-base-repository)[Updating your project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23updating-your-project)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23next-steps)\n\n[Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23payment-provider)\n\n[Payment Provider builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23payment-provider-builder)[Overriding the Manifest route](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23overriding-the-manifest-route)[Available Configurable Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23available-configurable-options)[Request a retry from Payment Gateway](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23request-a-retry-from-payment-gateway)[Payment Provider Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23payment-provider-service)[Using Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23using-secure-proxy)\n\n[Placing an order with your new connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23placing-an-order-with-your-new-connector)\n\n[Making your connector available to process sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23making-your-connector-available-to-process-sales)\n\n[Updating and testing new configurations for an already published connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-provider-framework/docs/guides/payments-integration-payment-provider-framework%23updating-and-testing-new-configurations-for-an-already-published-connector)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_ec54877d
|
[
{
"role": "system",
"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 productsummaryattachmentlist app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/guides/basic-components)\n\nProduct Summary Attachment List\n\n[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\nProduct Summary Attachment is the block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering the [attachment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/o-que-e-um-anexo--aGICk0RVbqKg6GYmQcWUm) options available for a product.\n\n\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary-attachment-list` block to a store template of your choice as a child of the `product-summary.shelf` block. For example:\n\n`1\n\n \"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-image\", \n\n4\n\n \"product-summary-name\", \n\n5\n\n \"product-summary-sku-name\", \n\n6\n\n+ \"product-summary-attachment-list\", \n\n7\n\n \"product-summary-space\", \n\n8\n\n \"product-summary-column#1\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\nAfter adding the `product-summary-attachment-list` block to your store theme, use the VTEX Admin to add attachments to your products to display the component in your store correctly. For more information, please refer to [Adding an attachment](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/cadastrar-um-anexo--7zHMUpuoQE4cAskqEUWScU).\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------------------- |\n| attachmentListContainer |\n| attachmentItemContainer |\n| attachmentItem |\n| attachmentItemProductText |\n\n[Product Summary« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary)[Product Summary Buy ButtonNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummarybuybutton)\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/productsummaryattachmentlist/docs/apps/vtex.product-summary)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryattachmentlist%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryattachmentlist/docs/apps/vtex.product-summary/productsummaryattachmentlist%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_6e8fbf1a
|
[
{
"role": "system",
"content": "You are a VTEX 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 availability notify in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-availability-notify/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/api-reference)\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-availability-notify/docs/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-availability-notify/docs/storefront-development)\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-availability-notify/docs/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-availability-notify/docs/troubleshooting)\n\n[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-availability-notify/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/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-availability-notify/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-availability-notify/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/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-availability-notify/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-availability-notify/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-availability-notify/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/advanced-components)\n\nAvailability Notify\n\nOfficial extension\n\nVersion: 1.13.1\n\nLatest version: 1.13.1\n\n## ⚠️ Maintenance ⚠️\n\n_Starting June 1st 2023, this application will no longer be maintained by VTEX._\n\n---\n\nThe Availability Notify component is responsible for showing a subscription form when a product SKU is not available. The form lets customers subscribe to get notified when that item gets restocked.\n\n\n\nThe app records the notification request and monitors inventory updates. This way, once the requested SKU gets back in stock, the app will email the shoppers who asked to be notified.\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-installing-an-app) the Availability Notify app in the desired VTEX account by running `vtex install vtex.availability-notify` in your terminal.\n2. Open your store’s Store Theme app directory in your code editor.\n3. Open your app's `manifest.json file` and add the Availability Notify app under the `peerDependencies` field.\n\n> Warning\n> \n> Due to changes in its peer dependencies you will need to release a new major version. Check the documentation on [How to migrate CMS settings after a theme major update](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-migrating-cms-settings-after-major-update).\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n \"vtex.availability-notify\": \"1.x\" \n\n3\n\n } \n\n`\n\n1. Add the `availability-notify` component block to your PDP in your store theme (`store.product`). For example:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"availability-notify\" \n\n5\n\n ] \n\n6\n\n }, \n\n`\n\n1. Once you have added the `availability-notify` component, access your store's Admin.\n2. Go to **Extensions Hub** \\> **Installed Apps** \\> **Availability Notifier**. You can also find it using the search bar on the top of the page.\n3. Then, you will see the app's settings:\n\n\n\n| Setting field | Description |\n| --------------------- | ---------------------------------------------------------------------------------------------------------------------- |\n| Verify Availability | Runs a shipping simulation to verify that the item can be shipped to the shopper before sending a notificaiton. |\n| Marketplace to Notify | Allows a seller account to specify a comma separated list of marketplace account names to notify of inventory updates. |\n| Download Requests | Download an XLS file of all recquest records. |\n| Process Unsent | Process all unsent requests and download an XLS file of the results. |\n\nAfter making the desired settings in the app, set up its template according to your necessities. Check out more details about it in the next section, [Customizing the Back in stock template](#customizing-the-back-in-stock-template).\n\n## Seller Configuration\n\nThis app needs to also be installed on the seller account\n\n1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-installing-an-app) the Availability Notify app in the desired VTEX SELLER account through the app store\n2. In the app configuration enter the name of the marketplace to notify when there are any inventory changes\n\nThis will forward the inventory change to the MARKETPLACE and then trigger the `Back In Stock` email to the subscribed users of that product.\n\n## Customizing the Back in stock template\n\nOnce you have installed the app, you can customize the email template to send to the shoppers who asked to be notified.\n\n1. Find the email template, named **BACK IN STOCK**, in your store's Admin in **Customer** \\> **Message center** \\> **Templates**.\n2. Search for the `availability-notify` component template, named **BACK IN STOCK** and click on it.\n3. After, you will see the email template and its configuration. For example:\n\n\n\nTo edit the email template's field, check the documentation on [How to create and edit transactional email templates](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/335JZKUYgvYlGOJgvJYxRO), and you will notice the **JSON Data** field, which is responsible for adding variables that allow you to dynamically add data to the email. These variables are JSON properties, and you can see more details about them in [Get SKU and context](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-sku%23catalog-api-get-sku-context) and in [Including order variables in email template](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/fLMUCPArCYB9vcTZEZ6bi).\n\n> _JSON Data examples will only appear in templates when you complete the desired action in your store. If you have not transacted an order, recurrence or any other action, JSON Data will appear blank._ _NOTE: notification email is only triggered when on the `master` workspace_\n\n## Searching and Processing Availability Notify data\n\nThis app uses [Master Data V2](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/master-data-api-v2-overview), to search for stored data you should use Master Data API - v2 endpoints with the variables `data_entity_name` and `schema` with the value `notify`.\n\nIf you want to run the services manually you can use the two endpoints below: (An authentication token is required)\n\n* To process Unsent Requests:`https://app.io.vtex.com/vtex.availability-notify/v1/{{accountName}}/master/_v/availability-notify/process-unsent-requests`\n* To process All Requests:`https://app.io.vtex.com/vtex.availability-notify/v1/{{accountName}}/master/_v/availability-notify/process-all-requests`\n\nCheck out the [Open API Schemas repository](https://read.calvincode.net/reader?url=https://github.com/vtex/openapi-schemas) containing several VTEX Postman Collections including Master Data API - v2.\n\n## Customization\n\nIn order to apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ---------------- |\n| notiferContainer |\n| title |\n| notifyLabel |\n| form |\n| content |\n| input |\n| inputName |\n| inputEmail |\n| submit |\n| sucess |\n| error |\n\n[Advanced components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/guides/advanced-components)[Category MenuNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.category-menu)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[⚠️ Maintenance ⚠️](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.availability-notify%23-maintenance-)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.availability-notify%23configuration)\n\n[Seller Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.availability-notify%23seller-configuration)\n\n[Customizing the Back in stock template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.availability-notify%23customizing-the-back-in-stock-template)\n\n[Searching and Processing Availability Notify data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.availability-notify%23searching-and-processing-availability-notify-data)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify/docs/apps/vtex.availability-notify%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_8f5cc61a
|
[
{
"role": "system",
"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 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/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/docs/api-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/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/docs/storefront-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/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/docs/troubleshooting)\n\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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/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/docs/api-reference/marketplace-protocol/)\n\nExternal Seller\n\nExternal Marketplace\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-protocol/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-protocol/docs/api-reference/marketplace-protocol/)\n\nExternal Seller\n\nExternal Marketplace\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-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/marketplace-protocol/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[DeDelete affiliate by ID« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol/docs/api-reference/marketplace-apis%23delete-/fulfillment/pvt/affiliates/-affiliateId-)[PoFulfillment simulation - External SellerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orderForms/simulation)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d25fa9af
|
[
{
"role": "system",
"content": "You are a VTEX 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 navbar links in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-navbar-links/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-navbar-links/docs/api-reference)\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-navbar-links/docs/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-navbar-links/docs/storefront-development)\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-navbar-links/docs/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-navbar-links/docs/troubleshooting)\n\n[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-navbar-links/updates/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-navbar-links/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-navbar-links/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/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-navbar-links/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/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-navbar-links/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/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-navbar-links/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-navbar-links/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-navbar-links/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-navbar-links/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/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-navbar-links/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-navbar-links/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/updates/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-navbar-links/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-navbar-links/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/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-navbar-links/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/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-navbar-links/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/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-navbar-links/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-navbar-links/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-navbar-links/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-navbar-links/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/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-navbar-links/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-navbar-links/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-navbar-links/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-overview)\n\nNavbarLinks\n\nDisplays a set of navigation links.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/NavbarLinks)\n\nThe `NavbarLinks` component displays a set of navigation links that self adapts on mobile or desktop screens.\n\nThis component is part of the [Navigation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-navigation) feature and must be used in the [Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar) context.\n\n> The mobile version can be achieved with [NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-navbar-slider) as wrapper.\n\nExample\n\nCode\n\nSet location\n\n* [Office](#)\n* [Home Appliances](#)\n* [Computer and Software](#)\n* [Technology](#)\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { \n\n2\n\n NavbarLinks, \n\n3\n\n NavbarLinksList, \n\n4\n\n NavbarLinksListItem, \n\n5\n\n} from \"@faststore/ui\"; \n\n`\n\n### Import styles\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/molecules/NavbarLinks/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-navbar-links-bkg-color | \\--fs-color-body-bkg |\n| \\--fs-navbar-links-transition-property | var(--fs-transition-property) |\n| \\--fs-navbar-links-transition-timing | var(--fs-transition-timing) |\n| \\--fs-navbar-links-transition-function | var(--fs-transition-function) |\n| \\--fs-navbar-links-border-top-width-mobile | var(--fs-border-width) |\n| \\--fs-navbar-links-border-top-color-mobile | var(--fs-border-color-light) |\n| \\--fs-navbar-links-border-bottom-width-mobile | var(--fs-navbar-links-border-top-width-mobile) |\n| \\--fs-navbar-links-border-bottom-color-mobile | var(--fs-navbar-links-border-top-color-mobile) |\n\n### Link\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | --------------------------------- |\n| \\--fs-navbar-links-link-width-notebook | auto |\n| \\--fs-navbar-links-link-padding-notebook | 0 var(--fs-spacing-0) |\n\n### List\n\n| Local token | Default value/Global token linked |\n| -------------------------------------------------- | --------------------------------- |\n| \\--fs-navbar-links-list-padding-left-notebook | var(--fs-spacing-3) |\n| \\--fs-navbar-links-list-margin-left-notebook | var(--fs-spacing-2) |\n| \\--fs-navbar-links-list-border-left-width-notebook | var(--fs-border-width) |\n| \\--fs-navbar-links-list-border-left-color-notebook | var(--fs-border-color-light) |\n\n---\n\n## Data attributes\n\nYou can target and override `NavbarLinks` styles using the following data attributes:\n\n`data-fs-navbar-links`\n\n`data-fs-navbar-links-list`\n\n`data-fs-navbar-links-list-item`\n\n---\n\n## Props\n\n### NavbarLinks\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-navbar-links |\n\n### NavbarLinksList\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-navbar-links-list |\n| **marker** | false \\| true | Specify whether or not this component should display the list's markers (bullets or numbers). | |\n\n---\n\n## Related components\n\n* Storefront \n[Login](#) \nSet location \n * [Office](#) \n * [Home Appliances](#) \n * [Computer and Software](#) \n * [Technology](#) \nNavbar \nRepresents the page header and groups features like Search and Regionalization. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/organisms-navbar)\n* Open Menu \nNavbarSlider \nAs part of the Navbar, this component it its mobile version used to list the navigation links. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/organisms-navbar-slider)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/navbar-links.mdx)\n\n[Modal« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-modal)[OrderSummaryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-order-summary)\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-navbar-links/docs/guides/faststore/molecules-navbar-links%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23design-tokens)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23link)[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23list)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23props)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23navbarlinks)[NavbarLinksList](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23navbarlinkslist)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%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/navbar-links.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-navbar-links/docs/guides/faststore/molecules-navbar-links%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23design-tokens)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23link)[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23list)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23props)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23navbarlinks)[NavbarLinksList](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%23navbarlinkslist)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-navbar-links/docs/guides/faststore/molecules-navbar-links%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_3bfc1c9b
|
[
{
"role": "system",
"content": "You are a VTEX 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 products in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/updates/release-notes)\n\nManaging products\n\nLearn how to create and update a product with the Catalog API.\n\nThis step-by-step guide will walk you through the process of creating and updating a [product](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/1wmX3QvQVxbKVmalhIE5Ru) within the VTEX platform.\n\nA product is a generic definition of an item that is part of your store’s Catalog, for instance, a shirt.\n\nProducts may vary by model, color, size, among other characteristics. Therefore, it would be possible to have the same product (shirt) in different models, like short or long sleeves, gray or pink color, sizes S, M or L.\n\nEach variation, such as a _long sleeve gray size S shirt_, will correspond to a [Stock Keeping Unit (SKU)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA), which is the actual item in the inventory that customers can purchase. Before creating SKUs, you must create a product.\n\n## Before you begin\n\nBefore you begin managing your SKUs, make sure you've completed the following steps:\n\n* **Obtain API Credentials**: Ensure you have a valid `appKey` and `appToken` with the necessary permissions to access the [Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api). For more information, please refer to the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) article.\n\n## Creating a product\n\nWhen creating or updating products, the product must be associated with their corresponding brand and most specific [category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories). Hence, use the [Create product with category and brand endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/product) to insert a new product, considering the following scenarios:\n\n* [Type 1 - New product, category, and brand](#type-1---new-product-category-and-brand)\n* [Type 2 - New product, existing category, and brand](#type-2---new-product-existing-category-and-brand)\n\nRegardless of the type of request, if there is a need to create a new product with a specific custom product ID, it is possible to specify the `Id` (integer) in the request body. Otherwise, VTEX will generate the ID automatically.\n\n> We recommend leaving VTEX to automatically generate an ID, by not including a custom product ID in the `Id` field of the request body. The generated ID can be retrieved in the request's response and must be stored in the system for future updates of this product.\n\n> Click the steps below to navigate through this article and explore specific topics. Relevant code will be highlighted and focused for your convenience. Additionally, in the code viewer on the right, you can switch between different code files or tabs to view the corresponding code examples.\n\n#### Type 1 - New product, category, and brand\n\nCreate a new product as well as a new category path (including subcategories) and a new brand by specifying the `CategoryPath` and `BrandName` parameters in the [Create product with category and brand endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/product) request body.\n\n##### Type 1 with custom `Id`\n\nIf there is a need to create a new product with a specific custom product ID, specify the `Id` (integer) in the request body.\n\n#### Type 2 - New product, existing category and brand\n\nCreating a new product given an existing `CategoryId` and an existing `BrandId` by specifying the `CategoryId` and `BrandId` parameters in the [Create product with category and brand endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/product) request body.\n\n##### Type 2 with custom `Id`\n\nIf there is a need to create a new product with a specific custom product ID, specify the `Id` (integer) in the request body.\n\n## Retrieving product data\n\nYou can retrieve product information by calling the [Get product by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/product/-productId-) endpoint.\n\nMake sure to copy the response body, modify specific fields and use the full updated body as a request when [updating a product](#updating-a-product).\n\n## Updating a product\n\n> If you need to change any product field, it is necessary to send all the other fields in the request. Otherwise, all other previously configured information will be deleted. Therefore, before making a change, you should [get the product data](#retrieving-product-data) for the same `Id` and use the response as a template to make the change.\n\nIf you want to update information from an existing product, send a request to the [Update product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/product/-productId-) endpoint, indicating the `Id` of the existing product.\n\nShell\n\nPython\n\nNode.js\n\n`1\n\ncurl --request post \\ \n\n2\n\n --url https://{accountName}.vtexcommercestable.com.br/api/catalog/pvt/product \\ \n\n3\n\n --header 'Accept: application/json' \\ \n\n4\n\n --header 'Content-Type: application/json' \\ \n\n5\n\n --header 'X-VTEX-API-AppKey: {appKey}' \\ \n\n6\n\n --header 'X-VTEX-API-AppToken: {appToken}' \\ \n\n7\n\n --data '{body}' \n\n`\n\nRequest\n\nResponse\n\n`1\n\n{ \n\n2\n\n \"Name\": \"Black T-Shirt\", \n\n3\n\n \"CategoryPath\": \"Mens/Clothing/T-Shirts\", \n\n4\n\n \"BrandName\": \"Nike\", \n\n5\n\n \"RefId\": \"31011706925\", \n\n6\n\n \"Title\": \"Black T-Shirt\", \n\n7\n\n \"LinkId\": \"tshirt-black\", \n\n8\n\n \"Description\": \"This is a cool Tshirt\", \n\n9\n\n \"ReleaseDate\": \"2022-01-01T00:00:00\", \n\n10\n\n \"IsVisible\": true, \n\n11\n\n \"IsActive\": true, \n\n12\n\n \"TaxCode\": \"\", \n\n13\n\n \"MetaTagDescription\": \"tshirt black\", \n\n14\n\n \"ShowWithoutStock\": true, \n\n15\n\n \"Score\": 1 \n\n16\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/Catalog/managing-products.mdx)\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/managing-products/docs/guides/managing-products%23before-you-begin)\n\n[Creating a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/guides/managing-products%23creating-a-product)\n\n[Retrieving product data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/guides/managing-products%23retrieving-product-data)\n\n[Updating a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/guides/managing-products%23updating-a-product)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Catalog/managing-products.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/guides/managing-products%23before-you-begin)\n\n[Creating a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/guides/managing-products%23creating-a-product)\n\n[Retrieving product data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/guides/managing-products%23retrieving-product-data)\n\n[Updating a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-products/docs/guides/managing-products%23updating-a-product)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_dc1b030c
|
[
{
"role": "system",
"content": "You are a VTEX 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 toast in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-toast/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-toast/docs/api-reference)\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-toast/docs/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-toast/docs/storefront-development)\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-toast/docs/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-toast/docs/troubleshooting)\n\n[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-toast/updates/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-toast/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-toast/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/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-toast/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/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-toast/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/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-toast/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-toast/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-toast/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-toast/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/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-toast/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-toast/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/updates/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-toast/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-toast/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/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-toast/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/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-toast/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/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-toast/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-toast/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-toast/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-toast/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/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-toast/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-toast/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-toast/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-overview)\n\nToast\n\nToasts are used to display notifications. They appear temporarily, and should contain a single line of text directly related to the operation performed.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Toast)\n\nToasts are used to display notifications. They appear temporarily, and should contain a single line of text directly related to the operation performed.\n\nExample\n\nCode\n\nSimple Toast\n\nInfo Toast\n\nError Toast\n\nWarning Toast\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Toast } 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/Toast/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-toast-width | calc(100% - (2 \\* var(--fs-spacing-3))) |\n| \\--fs-toast-min-height | var(--fs-spacing-9) |\n| \\--fs-toast-padding | var(--fs-spacing-1) var(--fs-spacing-3) var(--fs-spacing-1) var(--fs-spacing-1) |\n| \\--fs-toast-margin | var(--fs-spacing-3) var(--fs-spacing-3) 0 var(--fs-spacing-3) |\n| \\--fs-toast-top-mobile | 3.125rem |\n| \\--fs-toast-top-tablet | 6.25rem |\n| \\--fs-toast-border-radius | var(--fs-border-radius-medium) |\n| \\--fs-toast-border-width | var(--fs-border-width) |\n| \\--fs-toast-border-color | transparent |\n| \\--fs-toast-shadow | var(--fs-shadow-hover) |\n| \\--fs-toast-bkg-color | var(--fs-color-neutral-0) |\n| \\--fs-toast-transition-property | var(--fs-transition-property) |\n| \\--fs-toast-transition-timing | var(--fs-transition-timing) |\n| \\--fs-toast-transition-function | var(--fs-transition-function) |\n\n### Icon\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | ---------------------------------------- |\n| \\--fs-toast-icon-container-min-width | var(--fs-spacing-7) |\n| \\--fs-toast-icon-container-height | var(--fs-toast-icon-container-min-width) |\n| \\--fs-toast-icon-container-bkg-color | var(--fs-color-primary-bkg-light) |\n| \\--fs-toast-icon-container-border-radius | var(--fs-border-radius) |\n\n### Title\n\n| Local token | Default value/Global token linked |\n| ----------------------------- | --------------------------------- |\n| \\--fs-toast-title-size | var(--fs-text-size-body) |\n| \\--fs-toast-title-weight | var(--fs-text-weight-bold) |\n| \\--fs-toast-title-line-height | 1.2 |\n| \\--fs-toast-title-margin-left | var(--fs-spacing-3) |\n\n### Message\n\n| Local token | Default value/Global token linked |\n| ------------------------------- | --------------------------------- |\n| \\--fs-toast-message-size | var(--fs-toast-title-size) |\n| \\--fs-toast-message-line-height | var(--fs-toast-title-line-height) |\n| \\--fs-toast-message-margin-left | var(--fs-spacing-3) |\n\n---\n\n## Data attributes\n\nYou can target and override `Toast` styles using the following data attributes:\n\n`data-fs-toast`\n\n`data-fs-toast-visible=\"true | false\"`\n\n`data-fs-toast-icon-container`\n\n`data-fs-toast-content`\n\n`data-fs-toast-title`\n\n`data-fs-toast-message`\n\n---\n\n## Props\n\nToast's props are in the object passed as an argument by `pushToast(toast: Props)` method.\n\n| Name | Type | Description | Default |\n| ------------- | -------------------- | -------------------------------------------------------- | -------------------- |\n| **title** | string | Toast's title. | |\n| **message\\*** | string | Message shown in Toast. | |\n| **status\\*** | 'ERROR' \\| 'WARNING' | 'INFO' | Toast's status type. |\n| **icon** | ReactNode | A React component that will be rendered as toast's icon. | |\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/toast.mdx)\n\n[TextareaField« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-textarea-field)[ToggleNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toggle)\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-toast/docs/guides/faststore/molecules-toast%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23design-tokens)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23icon)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23title)[Message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23message)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%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/toast.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-toast/docs/guides/faststore/molecules-toast%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23design-tokens)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23icon)[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23title)[Message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23message)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toast/docs/guides/faststore/molecules-toast%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_5c7a55db
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides store framework managing 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/store-framework-managing-performance/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-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/store-framework-managing-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/store-framework-managing-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/store-framework-managing-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/store-framework-managing-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/store-framework-managing-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/store-framework-managing-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/store-framework-managing-performance/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-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/store-framework-managing-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/store-framework-managing-performance/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance)\n\nManaging Performance\n\nExplore the key configurations to improve your store performance on Store Framework.\n\nThe performance of your website directly impacts overall business success. Fast-loading websites provide a smoother shopping experience, keep users engaged, and reduce bounce rates. In contrast, poor performance, such as slow load times, may frustrate users and result in lost sales.\n\nSite performance is also a key factor in SEO rankings, influencing organic traffic and search engine visibility. Learn more in the [SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo) guide.\n\nIn this section, you will learn how to optimize your website performance by configuring key settings in your Store Framework store.\n\n## Before you begin\n\n### Have a store using Store Framework\n\nEnsure your store has a [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) developed following the [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) guide.\n\nCustomize your store theme based on your business needs by following the guides within the [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework) section, such as the guides [Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-building-pages) and [Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-using-components).\n\n### Check the builders\n\nCheck if the builders are properly installed in your Store Theme. To use builders, your account must have at least version `vtex.builder-hub@0.293.4` installed. Also, you need to specify them in the app's `manifest.json` file. Learn more in [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders).\n\n### Learn about performance best practices\n\nFamiliarize yourself with the best practices and tools for optimizing your store performance. Learn more in the [Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance) guide.\n\n## Guides in this section\n\n[Deactivating the VTEX IO native service workerLearn how to deactivate the VTEX IO native service worker.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)[Displaying asynchronous pricesImprove page load speed by showing prices asynchronously.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)[Enabling the orderForm optimizationLearn how to optimize the orderForm for quicker cart updates.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization)[Enabling performance settingsFind out how to safely configure performance-related settings of your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-performance-settings)[Lazy loading componentsImplement lazy loading by using fold blocks to improve the initial page load speed.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks)[Optimizing image renderingLearn how to optimize image rendering for faster loading times.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-managing-performance.md)\n\n[Using several service workers in your store« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance//docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)[Deactivating the VTEX IO native service workerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance//docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23before-you-begin)\n\n[Have a store using Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23have-a-store-using-store-framework)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23check-the-builders)[Learn about performance best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23learn-about-performance-best-practices)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23guides-in-this-section)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-managing-performance.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23before-you-begin)\n\n[Have a store using Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23have-a-store-using-store-framework)[Check the builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23check-the-builders)[Learn about performance best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23learn-about-performance-best-practices)\n\n[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-managing-performance/docs/guides/store-framework-managing-performance%23guides-in-this-section)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_a648c027
|
[
{
"role": "system",
"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.speech to 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/vtexarg.speech-to-text/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-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/vtexarg.speech-to-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/vtexarg.speech-to-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/vtexarg.speech-to-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/vtexarg.speech-to-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/vtexarg.speech-to-text/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-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/vtexarg.speech-to-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/vtexarg.speech-to-text/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-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/vtexarg.speech-to-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/vtexarg.speech-to-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/vtexarg.speech-to-text/docs/vtex-io-apps)\n\nSpeech to Text Search\n\nOfficial extension\n\nVersion: 1.0.10\n\nLatest version: 1.0.10\n\n[](#contributors-)\n\nThe `speech-to-text` app uses Google Chrome language processing to listen to the user's microphone and convert speech-to-text. The recognized text is then used to redirect the user to the corresponding search page.\n\n\n\n## Configuration\n\n1. Add the `vtexarg.speech-to-text` app to your theme's **peer dependency** in the `manifest.json` file.\n2. Add the `text-speech` block to the desired theme template or inside another block. For example:\n\n`1\n\n \"flex-layout.col#text-speech\": \\{ \n\n2\n\n \"children\": [ \n\n3\n\n \"speech-to-text\" \n\n4\n\n ] \n\n5\n\n \\}, \n\n`\n\n1. Then, declare the `speech-to-text` block using the props stated in the [Props](#props) table. For example\n\n`1\n\n \"speech-to-text\": { \n\n2\n\n \"props\": { \n\n3\n\n \"lang\": \"es-ES\", \n\n4\n\n \"iconHeight\": \"20px\", \n\n5\n\n \"iconWidth\": \"20px\", \n\n6\n\n \"imgSrc\": \"https://upload.wikimedia.org/wikipedia/commons/a/a7/Font_Awesome_5_solid_microphone.svg\" \n\n7\n\n } \n\n8\n\n } \n\n`\n\n## Props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | ------------------------------------------- | ------------- |\n| lang | enum | Language used by the Google Chrome NLP API. | en-EN |\n| iconHeight | string | Icon height in px. | 20px |\n| iconWidth | string | Icon width in px. | 20px |\n| imgSrc | string | URL of the source image. | none |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ---------------------------- |\n| audioSearchContainer |\n| audioSearchImg |\n| audioSearchImgRecordingState |\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/vtexarg.speech-to-text/docs/apps/vtexarg.speech-to-text%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/apps/vtexarg.speech-to-text%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexarg.speech-to-text/docs/apps/vtexarg.speech-to-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_669ea709
|
[
{
"role": "system",
"content": "You are a VTEX 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 a customer credit account in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/customer-credit-integration-guide)\n\n[Managing a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account)\n\n[Managing a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-invoice)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/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-a-customer-credit-account/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/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-a-customer-credit-account/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/customer-credit-integration-guide)\n\n[Managing a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account)\n\n[Managing a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-invoice)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/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-a-customer-credit-account/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/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-a-customer-credit-account/docs/guides)\n\nIntegration Guides\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/customer-credit-integration-guide)\n\n[Managing a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account)\n\nManaging a Customer Credit account\n\nThis guide describes how to manage a [Customer Credit account](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0) in your store by performing the following actions through the endpoints of the [Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api):\n\n* [Create a Customer Credit account](#creating-a-customer-credit-account)\n* [Check Customer Credit account details](#checking-customer-credit-account-details)\n* [Update personal information and credit settings](#changing-customer-credit-account-information)\n* [Check operations statement](#checking-operations-in-a-customer-credit-account)\n* [Register dependents for credit sharing](#sharing-credit-with-dependents)\n* [Check all Customer Credit accounts of a store](#checking-all-customer-credit-accounts-of-a-store)\n* [Close a Customer Credit account](#closing-a-customer-credit-account)\n\n> For more information about Customer Credit functionalities, access [Customer Credit - Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0) and [Customer Credit - Getting Started](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/21ok0GBwmcIeaY2IukYMOg).\n\n## Creating a Customer Credit account\n\nTo provide exclusive credit to a customer, you can create a Customer Credit account via VTEX Admin or use the [Open an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23post-/api/creditcontrol/accounts) endpoint. In this request, you must send the following customer data and account usage parameters:\n\n* `document`: Customer document.\n* `documentType`: Document type (CPF, CNPJ, other).\n* `email`: Customer email.\n* `creditLimit`: Maximum credit amount on the account.\n* `tolerance`: Account credit tolerance (in decimals). This value represents the increase in credit on an account. For example, a value of `0.30` indicates that the customer - can use up to 30% above the account's original maximum credit amount.\n\n**POST - Open an account**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"document\": \"55555555555\", \n\n3\n\n \"documentType\": \"CPF\", \n\n4\n\n \"email\": \"customer@test.com\", \n\n5\n\n \"creditLimit\": \"3000\", \n\n6\n\n \"tolerance\": \"0.05\" \n\n7\n\n} \n\n`\n\nThe endpoint will return some of the previously sent data and new information about the created account, such as:\n\n* `id`: Client’s Customer Credit account identification.\n* `balance`: Account balance value. If this number is negative, the account has a debit instead of a credit to be used.\n* `status`: Client’s Customer Credit account status. All accounts are created with the status `Open`.\n* `updatedAt`: Date of the last update made to the account (UTC format).\n* `createdAt`: Account creation date (UTC format).\n* `availableCredit`: Credit amount available on the account.\n* `preAuthorizedCredit`: Credit value that can only be used by the account owner after the merchant releases a specific purchase transaction.\n* `availableBalance`: Balance available in the account\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"55555555555_CPF\", \n\n3\n\n \"balance\": 0.0, \n\n4\n\n \"document\": \"55555555555\", \n\n5\n\n \"status\": \"Open\", \n\n6\n\n \"documentType\": \"CPF\", \n\n7\n\n \"creditLimit\": 3000.00, \n\n8\n\n \"updatedAt\": \"2024-02-22T20:43:21.8753045Z\", \n\n9\n\n \"createdAt\": \"2024-02-22T20:43:21.8287567Z\", \n\n10\n\n \"description\": \"\", \n\n11\n\n \"availableCredit\": 3000.00, \n\n12\n\n \"preAuthorizedCredit\": 0.0, \n\n13\n\n \"email\": \"customer@test.com\", \n\n14\n\n \"tolerance\": 0.05, \n\n15\n\n \"availableBalance\": 3000.00 \n\n16\n\n} \n\n`\n\nYou can also access your VTEX Admin (**Apps > Customer Credit > Accounts**) to confirm that the new Customer Credit account was created.\n\n\n\n> When the Customer Credit account is created using the [Open an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23post-/api/creditcontrol/accounts) endpoint, the account identification (`id`) will be composed of information from the `document` and `documentType` fields, for example, `55555555555_CPF`. If account creation is performed through your VTEX Admin (**Apps > Customer credit > Accounts > New**), an identification code will be randomly created by the system and will be used as account identification, such as `92bccd01-b4ed-15sa-88a4 -175868a0bf42`.\n\n## Checking Customer Credit account details\n\nWhen you want to check details about a specific Customer Credit account, you can use the [Retrieve an account by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts/-creditAccountId-) endpoint. In this request, you must send the account identification (`id`) as a path parameter.\n\nSee an example below using the account `111111111_CPF`:\n\n**GET - Retrieve an account by ID**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/111111111_CPF`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"111111111_CPF\", \n\n3\n\n \"balance\": 0.0, \n\n4\n\n \"document\": \"111111111\", \n\n5\n\n \"status\": \"Open\", \n\n6\n\n \"documentType\": \"CPF\", \n\n7\n\n \"creditLimit\": 5000.0, \n\n8\n\n \"updatedAt\": \"2024-02-22T21:47:37.2832458Z\", \n\n9\n\n \"createdAt\": \"2024-02-22T21:47:37.2207379Z\", \n\n10\n\n \"description\": \"\", \n\n11\n\n \"availableCredit\": 5000.0, \n\n12\n\n \"preAuthorizedCredit\": 0.0, \n\n13\n\n \"email\": \"customer2@test.com\", \n\n14\n\n \"tolerance\": 0.0, \n\n15\n\n \"availableBalance\": 5000.0, \n\n16\n\n} \n\n`\n\n> You can also check a Customer's Credit account details using the VTEX Admin. For more information, go to **Apps > Customer Credit > Accounts** and click the desired account.\n\n## Changing Customer Credit account information\n\nThe Customer Credit API allows you to modify an account settings through the following actions:\n\n* [Update account information](#updating-account-information)\n* [Change credit limit](#changing-the-credit-limit-of-an-account)\n* [Change tolerance](#changing-a-credit-account-tolerance)\n\n### Updating account information\n\nThe [Update account information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/accounts/-creditAccountId-) endpoint must be used to update the email address, type, and document number registered to the client.\n\n> You can also use this endpoint to change the credit limit and tolerance information, but it will be mandatory to send the `id`, `document`, and `documentId` fields, even when you do not intend to update this information. If the `id`, `document`, and `documentId` fields are not sent in this request, the information related to them will be removed from the account.\n\nSee an example below using the account `fe60ff40-d1cb-11ee-a0ed-87f4fcc03446`:\n\n**PUT - Update account information**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"email\": \"customer32@test.com\", \n\n3\n\n \"document\": \"44444444\", \n\n4\n\n \"documentType\": \"CPF\" \n\n5\n\n} \n\n`\n\nThe endpoint will return the account details with updated information.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"fe60ff40-d1cb-11ee-a0ed-87f4fcc03446\", \n\n3\n\n \"balance\": 0.0, \n\n4\n\n \"document\": \"44444444\", \n\n5\n\n \"status\": \"Open\", \n\n6\n\n \"documentType\": \"CPF\", \n\n7\n\n \"creditLimit\": 4500.0, \n\n8\n\n \"updatedAt\": \"2024-02-23T17:21:41.6800112Z\", \n\n9\n\n \"createdAt\": \"2024-02-22T21:47:37.2207379Z\", \n\n10\n\n \"description\": \"\", \n\n11\n\n \"availableCredit\": 4500.0, \n\n12\n\n \"preAuthorizedCredit\": 0.0, \n\n13\n\n \"email\": \"customer32@test.com\", \n\n14\n\n \"tolerance\": 0.0, \n\n15\n\n \"availableBalance\": 5000.0 \n\n16\n\n} \n\n`\n\n### Changing the credit limit of an account\n\nThe [Change credit limit of an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/accounts/-creditAccountId-/creditlimit) endpoint must be used when you want to change the credit limit value available to a customer credit account. In this request, you must send the account identification (`id`) as a path parameter and the `value` field containing the new credit limit, as shown in the example below:\n\n**PUT - Change credit limit of an account**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/creditlimit`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"value\": 5300 \n\n3\n\n} \n\n`\n\nThe endpoint will return the account details and the `creditLimit` field already updated.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"fe60ff40-d1cb-11ee-a0ed-87f4fcc03446\", \n\n3\n\n \"balance\": 0.0, \n\n4\n\n \"document\": \"44444444\", \n\n5\n\n \"status\": \"Open\", \n\n6\n\n \"documentType\": \"CPF\", \n\n7\n\n \"creditLimit\": 5300.0, \n\n8\n\n \"updatedAt\": \"2024-02-23T17:44:44.7931543Z\", \n\n9\n\n \"createdAt\": \"2024-02-22T21:47:37.2207379Z\", \n\n10\n\n \"description\": \"\", \n\n11\n\n \"availableCredit\": 5300.0, \n\n12\n\n \"preAuthorizedCredit\": 0.0, \n\n13\n\n \"email\": \"customer32@test.com\", \n\n14\n\n \"tolerance\": 0.3, \n\n15\n\n \"availableBalance\": 5300.0 \n\n16\n\n} \n\n`\n\n### Changing a credit account tolerance\n\nThe [Change tolerance of an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/accounts/-creditAccountId-/tolerance) endpoint must be used when you want to change the credit tolerance amount available on a customer credit account.\n\nIn this request, you must send the account identification (`id`) as a path parameter and the `value` field containing the new credit limit. The `value` is represented by a decimal number, where a `value` of `0.30` means 30% of tolerance.\n\nSee an example below using the account `fe60ff40-d1cb-11ee-a0ed-87f4fcc03446` and a tolerance of 15%.\n\n**PUT - Change tolerance of an account**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/tolerance`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"value\": 0.15 \n\n3\n\n} \n\n`\n\nThe endpoint will return the account details and the `tolerance` field already updated.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"fe60ff40-d1cb-11ee-a0ed-87f4fcc03446\", \n\n3\n\n \"balance\": 0.0, \n\n4\n\n \"document\": \"44444444\", \n\n5\n\n \"status\": \"Open\", \n\n6\n\n \"documentType\": \"CPF\", \n\n7\n\n \"creditLimit\": 5800.00, \n\n8\n\n \"updatedAt\": \"2024-02-23T18:03:03.4849783Z\", \n\n9\n\n \"createdAt\": \"2024-02-22T21:47:37.2207379Z\", \n\n10\n\n \"description\": \"\", \n\n11\n\n \"availableCredit\": 5800.00, \n\n12\n\n \"preAuthorizedCredit\": 0.0, \n\n13\n\n \"email\": \"customer32@test.com\", \n\n14\n\n \"tolerance\": 0.15, \n\n15\n\n \"availableBalance\": 5800.00 \n\n16\n\n} \n\n`\n\n## Checking operations in a customer credit account\n\nThe [Get account statements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts/-creditAccountId-/statements) endpoint can be used to track operations performed on a customer credit account, such as:\n\n* [Customer credit limit modification](#tracking-a-credit-limit-change-operation)\n* [Tolerance percentage modification](#tracking-a-tolerance-value-change-transaction)\n* [Invoice Issuance](#tracking-a-credit-invoice-creation)\n* [Invoice payment](#tracking-a-credit-invoice-payment)\n\nIn this request, you must send the account identification (`id`) as a path parameter:\n\n**GET - Get account statements**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/statements`\n\nIf you send the `id` of a new account or one without an operation type, the response body of the request will not present any value, as shown below:\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"statements\": [], \n\n3\n\n \"currentBalance\": 0.0, \n\n4\n\n \"intervalBalance\": 0.0, \n\n5\n\n \"previousBalance\": 0.0 \n\n6\n\n} \n\n`\n\n### Tracking a credit limit change operation\n\nWhen the credit limit of a customer credit account is modified via VTEX Admin or through the [Change credit limit of an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/accounts/-creditAccountId-/creditlimit) endpoint, it is possible to identify the new value indicated and when the operation was carried out.\n\nSee below a scenario where an initial credit limit USD 10.000 is reduced to USD 9.000 and then increased to USD 12.000\\. The tolerance value configured on this account is 10%.\n\n#### FIRST OPERATION: Decreasing credit limit from USD 10.000 to USD 9.000\n\n**PUT - Change credit limit of an account**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/creditlimit`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"value\": 9.000 \n\n3\n\n} \n\n`\n\n**GET - Get account statements**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/statements`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"statements\": [ \n\n3\n\n { \n\n4\n\n \"value\": -1100.0, \n\n5\n\n \"date\": \"2024-02-26T13:29:08.3978356Z\", \n\n6\n\n \"origin\": \"Credit\" \n\n7\n\n } \n\n8\n\n ], \n\n9\n\n \"currentBalance\": 0.0, \n\n10\n\n \"intervalBalance\": -1100.0, \n\n11\n\n \"previousBalance\": 0.0 \n\n12\n\n} \n\n`\n\nNote that the value displayed in the `value` field is indicated by a negative sign and 1100.0, instead of 1000.0 which would correspond to how much the credit limit was reduced. This occurs because the endpoint returns the sum of the amount of the reduced credit limit and the percentage of credit tolerance applied to it, in this case, 10% over 1000.0 (100.0).\n\n#### SECOND OPERATION: Increasing credit limit from USD 9.000 to USD 12.000\n\n**PUT - Change credit limit of an account**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/creditlimit`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"value\": 12.000 \n\n3\n\n} \n\n`\n\n**GET - Get account statements**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/statements`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"statements\": [ \n\n3\n\n { \n\n4\n\n \"value\": -1100.0, \n\n5\n\n \"date\": \"2024-02-26T17:08:49.3904874Z\", \n\n6\n\n \"origin\": \"Credit\" \n\n7\n\n }, \n\n8\n\n { \n\n9\n\n \"value\": 3300.0, \n\n10\n\n \"date\": \"2024-02-26T17:08:55.3123304Z\", \n\n11\n\n \"origin\": \"Credit\" \n\n12\n\n } \n\n13\n\n ], \n\n14\n\n \"currentBalance\": 0.0, \n\n15\n\n \"intervalBalance\": 2200.0, \n\n16\n\n \"previousBalance\": 0.0 \n\n17\n\n} \n\n`\n\nAs in the credit limit-reducing operation, the value present in the \"value\" field (3300.0) is indicated by the sum of the value added to the credit limit (3000.0) and the percentage of credit tolerance applied to the operation, 10% on 3000.0 (300.0).\n\n> The \"intervalBalance\" field is responsible for showing the balance between all amounts reduced and added in operations performed on a customer credit account since its opening. In this case, 2200.0 (3300.0 - 1100.0).\n\n### Tracking a tolerance value change transaction\n\nWhen the credit tolerance value in a customer credit account is modified via VTEX Admin or through the [Change tolerance of an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/accounts/-creditAccountId-/tolerance) endpoint, it is possible to identify the new value indicated and when the operation was carried out.\n\nSee below a scenario where an initial credit tolerance of 10% is reduced to 0%, and then increased to 25%. The credit limit value configured on this account is 5.000.\n\n#### FIRST OPERATION: Decreasing credit tolerance from 10% to 0%\n\n**PUT - Change tolerance of an account**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/tolerance`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"value\": 0 \n\n3\n\n} \n\n`\n\n**GET - Get account statements**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/statements`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"statements\": [ \n\n3\n\n { \n\n4\n\n \"value\": -500.0, \n\n5\n\n \"date\": \"2024-02-26T20:04:27.7754907Z\", \n\n6\n\n \"origin\": \"Credit\" \n\n7\n\n } \n\n8\n\n ], \n\n9\n\n \"currentBalance\": 0.0, \n\n10\n\n \"intervalBalance\": -500.0, \n\n11\n\n \"previousBalance\": 0.0 \n\n12\n\n} \n\n`\n\nNote that the value displayed in the `value` field is indicated by a negative sign (reduced tolerance percentage) and 500.0, instead of the percentage value 0\\. This occurs because the endpoint returns the value referring to the percentage reduced in the operation applied to the total amount of credit limit registered on the account. That is, a 10% tolerance reduction over 5000.0 equals 500.0.\n\n#### SECOND OPERATION: Increasing credit tolerance from 0% to 25%\n\n**PUT - Change tolerance of an account**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/tolerance`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"value\": 0.25 \n\n3\n\n} \n\n`\n\n**GET - Get account statements**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/statements`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"statements\": [ \n\n3\n\n { \n\n4\n\n \"value\": -500.0, \n\n5\n\n \"date\": \"2024-02-26T20:04:27.7754907Z\", \n\n6\n\n \"origin\": \"Credit\" \n\n7\n\n }, \n\n8\n\n { \n\n9\n\n \"value\": 1250.0, \n\n10\n\n \"date\": \"2024-02-26T22:39:53.8090863Z\", \n\n11\n\n \"origin\": \"Credit\" \n\n12\n\n } \n\n13\n\n ], \n\n14\n\n \"currentBalance\": 0.0, \n\n15\n\n \"intervalBalance\": 750.0, \n\n16\n\n \"previousBalance\": 0.0 \n\n17\n\n} \n\n`\n\nIn the same way, as in the operation in which the tolerance percentage was reduced, the value present in the `value` field (1250.0) represents the added percentage of 25% applied to the credit limit registered in the account (5000.0).\n\n### Tracking a credit invoice creation\n\nAfter the customer makes a purchase in the store using customer credit as a payment method and the order is [invoiced](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-invoice-an-order--7p1h852V5t54KyscpgxE2v), it is possible to check the credit operation information on the [Get account statements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts/-creditAccountId-/statements) endpoint.\n\nUnlike situations involving credit limit and tolerance changes, in the response body of this type of operation, the `origin` field is indicated as `invoice` and a new object named `metadata` is shown containing the following information:\n\n* `transactionId`: Transaction identification.\n* `orderId`: Identification of the order for which the invoice was created.\n* `numberOfInstallments`: Number of invoices created to pay for the transaction. invoices created to pay for the order.\n\nSee the example below for the response body information related to the operation of a purchase made worth USD 15.\n\n**GET - Get account statements**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/statements`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"statements\": [ \n\n3\n\n { \n\n4\n\n \"value\": -15.0, \n\n5\n\n \"date\": \"2024-02-26T14:39:54.7141907Z\", \n\n6\n\n \"origin\": \"Invoice\", \n\n7\n\n \"metadata\": { \n\n8\n\n \"transactionId\": \"ED01C38CD4C949C2BCDFDB2C461C80F1\", \n\n9\n\n \"orderId\": \"1413590513132-01\", \n\n10\n\n \"numberOfInstallments\": 1 \n\n11\n\n } \n\n12\n\n } \n\n13\n\n ], \n\n14\n\n \"currentBalance\": 0.0, \n\n15\n\n \"intervalBalance\": -8.01, \n\n16\n\n \"previousBalance\": 0.0 \n\n17\n\n} \n\n`\n\n### Tracking a credit invoice payment\n\nTo confirm when a customer credit invoice has been paid by the customer you can also use the [Get account statements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts/-creditAccountId-/statements) endpoint.\n\nSee below the response body containing the invoice information after order payment.\n\n**GET - Get account statements**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/statements`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"statements\": [ \n\n3\n\n { \n\n4\n\n \"value\": 8.01, \n\n5\n\n \"date\": \"2024-02-26T14:47:15.9276873Z\", \n\n6\n\n \"origin\": \"Payment\", \n\n7\n\n \"metadata\": { \n\n8\n\n \"transactionId\": \"ED01C38CD4C949C2BCDFDB2C461C80F1\", \n\n9\n\n \"installment\": 1 \n\n10\n\n } \n\n11\n\n } \n\n12\n\n ], \n\n13\n\n \"currentBalance\": 0.0, \n\n14\n\n \"intervalBalance\": 0.0, \n\n15\n\n \"previousBalance\": 0.0 \n\n16\n\n} \n\n`\n\n## Sharing credit with dependents\n\nYou can also share the credit available in a customer account with other customers. To do this, you must add a dependent — also known as an account holder — to the account.\n\n> Credit sharing between account holders registered in an account occurs in such a way that the sum of all purchases made by them through Customer Credit cannot exceed the amount of credit available in the account.\n\n### Adding a new account holder\n\nTo add the new account holder to the customer credit account, use the VTEX Admin or the [Add an account holder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23post-/api/creditcontrol/accounts/-creditAccountId-/holders) endpoint. In this request, you must send the account identification (`id`) as a path parameter.\n\nSee an example below using the account `fe60ff40-d1cb-11ee-a0ed-87f4fcc03446`:\n\n**POST - Add an account holder**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/holders`\n\nRequest body\n\n`1\n\n{ \n\n2\n\n \"claims\": { \n\n3\n\n \"email\": \"customertestholder1@test.com\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\nThe endpoint will return information about the creation of the new holder such as:\n\n* `level`: Holder hierarchy. The value 2 indicates that the holder is a dependent of the account's main holder.\n* `email`: Holder email.\n* `id`: Holder identification.\n* `createdAt`: Date of appointment of the holder.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"level\": 2, \n\n3\n\n \"claims\": { \n\n4\n\n \"email\": \"customertestholder1@test.com\" \n\n5\n\n }, \n\n6\n\n \"id\": \"78d22849ad844ae5a57ef1715de73467\", \n\n7\n\n \"createdAt\": \"2024-02-27T14:38:36.0027682Z\" \n\n8\n\n} \n\n`\n\nYou can also access your VTEX Admin (**Apps > Customer Credit > Accounts**) and click the desired account to verify that the new holder was added.\n\n\n\n### Removing an account holder\n\nTo remove a holder from a customer credit account and prevent them from using the available credit, you can use the VTEX Admin or the [Delete an account holder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23delete-/api/creditcontrol/accounts/-creditAccountId-/holders/-holderId-) endpoint. In this request, you must send the account identification (`id`) and the holder identification (`id` obtained in the VTEX Admin or in the response body of the [Add an account holder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23post-/api/creditcontrol/accounts/-creditAccountId-/holders) endpoint as path parameters.\n\nSee an example below using the account `fe60ff40-d1cb-11ee-a0ed-87f4fcc03446` and the holder `78d22849ad844ae5a57ef1715de73467`:\n\n**DEL - Delete an account holder**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/fe60ff40-d1cb-11ee-a0ed-87f4fcc03446/holders/78d22849ad844ae5a57ef1715de73467`\n\nThe endpoint will return the holder's identification, confirming that it was deleted from the account.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"78d22849ad844ae5a57ef1715de73467\" \n\n3\n\n} \n\n`\n\nYou can also access your VTEX Admin (**Apps > Customer Credit > Accounts**) and click on the desired account to verify that the new holder was removed.\n\n\n\n## Checking all customer credit accounts of a store\n\nTo check information about all customer credit accounts registered in your store, you can use the VTEX Admin or the [Search all accounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts) endpoint.\n\n**GET - Search all accounts**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/`\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"data\": [ \n\n3\n\n { \n\n4\n\n \"id\": \"07D0F8272B6D77F1E68B\", \n\n5\n\n \"balance\": 0.0, \n\n6\n\n \"status\": \"Open\", \n\n7\n\n \"creditLimit\": 1000.0, \n\n8\n\n \"updatedAt\": \"2021-06-28T21:33:46.70945Z\", \n\n9\n\n \"createdAt\": \"2020-04-15T01:23:54.4690229Z\", \n\n10\n\n \"description\": \"\", \n\n11\n\n \"availableCredit\": 1000.0, \n\n12\n\n \"preAuthorizedCredit\": 0.0, \n\n13\n\n \"email\": \"isadora.bombonatti@vtex.com.br\", \n\n14\n\n \"tolerance\": 0.0, \n\n15\n\n \"availableBalance\": 1000.0 \n\n16\n\n }, \n\n17\n\n { \n\n18\n\n \"id\": \"E93480BCE84892A336F3\", \n\n19\n\n \"balance\": 0.0, \n\n20\n\n \"status\": \"Open\", \n\n21\n\n \"creditLimit\": 2000.0, \n\n22\n\n \"updatedAt\": \"2021-06-28T21:33:46.8344386Z\", \n\n23\n\n \"createdAt\": \"2020-05-21T22:42:37.8764106Z\", \n\n24\n\n \"description\": \"\", \n\n25\n\n \"availableCredit\": 2000.0, \n\n26\n\n \"preAuthorizedCredit\": 0.0, \n\n27\n\n \"email\": \"contato@diasbruno.com\", \n\n28\n\n \"tolerance\": 0.0, \n\n29\n\n \"availableBalance\": 2000.0 \n\n30\n\n }, \n\n31\n\n { \n\n32\n\n \"id\": \"B07403D8311D642477F4\", \n\n33\n\n \"balance\": 0.0, \n\n34\n\n \"status\": \"Open\", \n\n35\n\n \"creditLimit\": 2000.0, \n\n36\n\n \"updatedAt\": \"2021-06-28T21:33:47.1156945Z\", \n\n37\n\n \"createdAt\": \"2020-07-23T20:26:33.894492Z\", \n\n38\n\n \"description\": \"\", \n\n39\n\n \"availableCredit\": 2000.0, \n\n40\n\n \"preAuthorizedCredit\": 0.0, \n\n41\n\n \"email\": \"joao.rios@vtex.com.br\", \n\n42\n\n \"tolerance\": 0.0, \n\n43\n\n \"availableBalance\": 2000.0 \n\n44\n\n }, \n\n45\n\n… \n\n46\n\n ], \n\n47\n\n \"summary\": { \n\n48\n\n \"count\": 35 \n\n49\n\n } \n\n50\n\n} \n\n`\n\n> The `count` field displays the number of customer credit accounts registered in the store.\n\n## Closing a customer credit account\n\nIf you wish to stop offering credit to a specific customer, you must close the account through VTEX Admin or the [Close an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23delete-/api/creditcontrol/accounts/-creditAccountId-) endpoint. In this request, you must send the account identification (`id`) as a path parameter.\n\nAdditionally, you can use the queries below (individually or combined) in the URL to refine your account search:\n\n* By the location of the accounts in the list (quantity of accounts): `?from={int}&to={int}`\n* By status: `?status={Open, Closed or Cancelled}`\n* By email: `?email={string}`\n\n> If your store has more than 20 customer credit accounts and you do not use any queries in the call, only the first 20 account records will appear in the response body.\n\nSee an example below using the account `fe60ff40-d1cb-11ee-a0ed-87f4fcc03446`:\n\n**DEL - Close an account**\n\n`https://{accountName}.{environment}.com.br/api/creditcontrol/accounts/c5886660-d598-11ee-ac7f-a50b38956bb7`\n\nThe endpoint will return the information for the account that was deleted, displaying the `status` field as `Closed`.\n\nResponse body\n\n`1\n\n{ \n\n2\n\n \"id\": \"c5886660-d598-11ee-ac7f-a50b38956bb7\", \n\n3\n\n \"balance\": 0.0, \n\n4\n\n \"document\": \"98765432101\", \n\n5\n\n \"status\": \"Closed\", \n\n6\n\n \"documentType\": \"CPF\", \n\n7\n\n \"creditLimit\": 3000.0, \n\n8\n\n \"updatedAt\": \"2024-02-27T17:52:52.842757Z\", \n\n9\n\n \"createdAt\": \"2024-02-27T17:51:03.5303894Z\", \n\n10\n\n \"description\": \"\", \n\n11\n\n \"availableCredit\": 3000.0, \n\n12\n\n \"preAuthorizedCredit\": 0.0, \n\n13\n\n \"email\": \"customerclosed@test.com\", \n\n14\n\n \"tolerance\": 0.0, \n\n15\n\n \"availableBalance\": 3000.0 \n\n16\n\n} \n\n`\n\nYou can also access your VTEX Admin (**Apps > Customer Credit > Accounts**) to verify that the account was deleted.\n\n\n\n> Once closed, a Customer Credit account cannot be reopened again and all invoices, statements, and additional dependents data will be deleted. However, after completing the account closure, if you wish, you can [open a new account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23post-/api/creditcontrol/accounts) for the customer using the same email as the closed account.\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/customer-credit-integration-guide/managing-a-customer-credit-account.md)\n\n[Customer Credit« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account//docs/guides/customer-credit-integration-guide)[Managing a Customer Credit invoiceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account//docs/guides/managing-a-customer-credit-invoice)\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Creating a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23creating-a-customer-credit-account)\n\n[Checking Customer Credit account details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23checking-customer-credit-account-details)\n\n[Changing Customer Credit account information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23changing-customer-credit-account-information)\n\n[Updating account information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23updating-account-information)[Changing the credit limit of an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23changing-the-credit-limit-of-an-account)[Changing a credit account tolerance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23changing-a-credit-account-tolerance)\n\n[Checking operations in a customer credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23checking-operations-in-a-customer-credit-account)\n\n[Tracking a credit limit change operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23tracking-a-credit-limit-change-operation)[Tracking a tolerance value change transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23tracking-a-tolerance-value-change-transaction)[Tracking a credit invoice creation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23tracking-a-credit-invoice-creation)[Tracking a credit invoice payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23tracking-a-credit-invoice-payment)\n\n[Sharing credit with dependents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23sharing-credit-with-dependents)\n\n[Adding a new account holder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23adding-a-new-account-holder)[Removing an account holder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23removing-an-account-holder)\n\n[Checking all customer credit accounts of a store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23checking-all-customer-credit-accounts-of-a-store)\n\n[Closing a customer credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23closing-a-customer-credit-account)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/customer-credit-integration-guide/managing-a-customer-credit-account.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23creating-a-customer-credit-account)\n\n[Checking Customer Credit account details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23checking-customer-credit-account-details)\n\n[Changing Customer Credit account information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23changing-customer-credit-account-information)\n\n[Updating account information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23updating-account-information)[Changing the credit limit of an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23changing-the-credit-limit-of-an-account)[Changing a credit account tolerance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23changing-a-credit-account-tolerance)\n\n[Checking operations in a customer credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23checking-operations-in-a-customer-credit-account)\n\n[Tracking a credit limit change operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23tracking-a-credit-limit-change-operation)[Tracking a tolerance value change transaction](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23tracking-a-tolerance-value-change-transaction)[Tracking a credit invoice creation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23tracking-a-credit-invoice-creation)[Tracking a credit invoice payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23tracking-a-credit-invoice-payment)\n\n[Sharing credit with dependents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23sharing-credit-with-dependents)\n\n[Adding a new account holder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23adding-a-new-account-holder)[Removing an account holder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23removing-an-account-holder)\n\n[Checking all customer credit accounts of a store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23checking-all-customer-credit-accounts-of-a-store)\n\n[Closing a customer credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account/docs/guides/managing-a-customer-credit-account%23closing-a-customer-credit-account)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_fa4892b2
|
[
{
"role": "system",
"content": "You are a VTEX 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 a customer credit invoice in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-a-customer-credit-invoice/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/api-reference)\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-a-customer-credit-invoice/docs/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-a-customer-credit-invoice/docs/storefront-development)\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-a-customer-credit-invoice/docs/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-a-customer-credit-invoice/docs/troubleshooting)\n\n[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-a-customer-credit-invoice/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/customer-credit-integration-guide)\n\n[Managing a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-account)\n\n[Managing a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/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-a-customer-credit-invoice/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/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-a-customer-credit-invoice/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/customer-credit-integration-guide)\n\n[Managing a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-account)\n\n[Managing a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/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-a-customer-credit-invoice/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/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-a-customer-credit-invoice/docs/guides)\n\nIntegration Guides\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/customer-credit-integration-guide)\n\n[Managing a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice)\n\nManaging a Customer Credit invoice\n\nCustomer Credit invoice is a document automatically generated by VTEX after the customer makes a purchase using Customer Credit as a payment method and the order is billed.\n\nIn cases of installment purchases, invoices are generated according to the number of installments. For example, a purchase made with payment in 10 installments on Customer Credit will generate 10 invoices related to the same order number.\n\n> The Order invoice and the Customer Credit invoice are different documents. The Order invoice is issued for all purchases made in a store, regardless of the payment method selected. The Customer Credit invoice is additionally issued only for purchases made using the Customer Credit payment method. Learn more about invoiced orders in [How to invoice an order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-manually-invoice-an-order--7p1h852V5t54KyscpgxE2v).\n\n\n\nThis guide describes how to manage [Customer Credit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0) invoices in your store by performing the following actions through the endpoints of the [Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api):\n\n* Check information: \n * [About a specific Customer Credit invoice](#checking-customer-credit-invoice-details) \n * [Of all invoices issued to a Customer Credit account](#checking-invoice-details-on-a-customer-credit-account) \n * [Regarding Customer Credit invoices created for all users in a VTEX store](#checking-details-of-all-customer-credit-invoices-in-a-vtex-store)\n* [Update invoice details](#updating-invoice-details-on-a-customer-credit-account)\n* [Postpone the due date of an invoice](#postponing-the-due-date-of-a-customer-credit-invoice)\n* [Record payment of an invoice](#confirming-payment-of-a-customer-credit-invoice)\n* [Cancel an invoice](#cancelling-a-customer-credit-invoice)\n\n> For more information about Customer Credit functionalities, access [Customer Credit - Overview](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/customer-credit-overview--1uIqTjWxIIIEW0COMg4uE0) and [Customer Credit - Getting Started](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/customer-credit-getting-started--1hCRg21lXYy2seOKgqQ2CC/21ok0GBwmcIeaY2IukYMOg).\n\n## Checking Customer Credit invoice details\n\nWhen you want to check details about a specific Customer Credit invoice, you can use the [Retrieve invoice by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-) endpoint. In this request, you must send the [Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-account) and invoice identification (`creditAccountId` and `invoiceId`) as path parameters.\n\nSee an example below using the account `11111111111_CPF` and invoice `7583E36F101C461094AB6CA68FA8EE2C-01`.\n\n**GET - Retrieve invoice by ID**\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01 \n\n`\n\nResponse body example\n\n`1\n\n{ \n\n2\n\n \"id\": \"7583E36F101C461094AB6CA68FA8EE2C-01\", \n\n3\n\n \"friendlyId\": \"IBjuAsrJ-1\", \n\n4\n\n \"status\": \"Opened\", \n\n5\n\n \"value\": 9.63, \n\n6\n\n \"accountId\": \"11111111111_CPF\", \n\n7\n\n \"creditValue\": 0.0, \n\n8\n\n \"createdAt\": \"2024-03-03T06:52:53.1314379Z\", \n\n9\n\n \"updatedAt\": \"2024-04-05T06:52:56.2329924Z\", \n\n10\n\n \"originalDueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n11\n\n \"dueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n12\n\n \"installment\": 1, \n\n13\n\n \"orderId\": \"1413870513134-01\", \n\n14\n\n \"transactionId\": \"7583E36F101C461094AB6CA68FA8EE2C\", \n\n15\n\n \"numberOfInstallments\": 1, \n\n16\n\n \"creditAccountId\": \"11111111111_CPF\" \n\n17\n\n} \n\n`\n\n> You can also check some details of a Customer Credit invoice details using the VTEX Admin. To do that, go to **Apps > Customer Credit > Invoices**, and click on the desired invoice.\n\n## Checking invoice details on a Customer Credit account\n\nTo check details of all invoices issued on a Customer Credit account, you can use the [Retrieve invoices by Customer Credit account ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts/-creditAccountId-/invoices) endpoint. In this request, you must send the account identification (`creditAccountId`) as a path parameter.\n\nSee an example below using the account `111111111_CPF`:\n\n**GET - Retrieve invoices by Customer Credit account ID**\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/ \n\n`\n\nResponse body example\n\n`1\n\n{ \n\n2\n\n \"data\": [ \n\n3\n\n { \n\n4\n\n \"id\": \"ED01C38CD4C949C2BCDFDB2C461C80F1-01\", \n\n5\n\n \"friendlyId\": \"MWKd4GUB-1\", \n\n6\n\n \"status\": \"Paid\", \n\n7\n\n \"value\": 8.01, \n\n8\n\n \"accountId\": \"11111111111_CPF\", \n\n9\n\n \"creditValue\": 0.0, \n\n10\n\n \"createdAt\": \"2024-02-26T14:39:54.6205024Z\", \n\n11\n\n \"resolvedAt\": \"2024-02-26T14:47:15.8495716Z\", \n\n12\n\n \"updatedAt\": \"2024-02-26T14:47:15.8964469Z\", \n\n13\n\n \"originalDueDate\": \"2024-03-27T14:39:54.6205024Z\", \n\n14\n\n \"dueDate\": \"2024-03-27T14:39:54.6205024Z\", \n\n15\n\n \"installment\": 1, \n\n16\n\n \"orderId\": \"1413590513132-01\", \n\n17\n\n \"transactionId\": \"ED01C38CD4C949C2BCDFDB2C461C80F1\", \n\n18\n\n \"numberOfInstallments\": 1, \n\n19\n\n \"creditAccountId\": \"11111111111_CPF\" \n\n20\n\n }, \n\n21\n\n { \n\n22\n\n \"id\": \"7583E36F101C461094AB6CA68FA8EE2C-01\", \n\n23\n\n \"friendlyId\": \"IBjuAsrJ-1\", \n\n24\n\n \"status\": \"Opened\", \n\n25\n\n \"value\": 9.63, \n\n26\n\n \"accountId\": \"11111111111_CPF\", \n\n27\n\n \"creditValue\": 0.0, \n\n28\n\n \"createdAt\": \"2024-03-03T06:52:53.1314379Z\", \n\n29\n\n \"updatedAt\": \"2024-04-05T06:52:56.2329924Z\", \n\n30\n\n \"originalDueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n31\n\n \"dueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n32\n\n \"installment\": 1, \n\n33\n\n \"orderId\": \"1413870513134-01\", \n\n34\n\n \"transactionId\": \"7583E36F101C461094AB6CA68FA8EE2C\", \n\n35\n\n \"numberOfInstallments\": 1, \n\n36\n\n \"creditAccountId\": \"11111111111_CPF\" \n\n37\n\n } \n\n38\n\n ], \n\n39\n\n \"summary\": { \n\n40\n\n \"total\": 9.63, \n\n41\n\n \"count\": 2, \n\n42\n\n \"totalPaid\": 8.01, \n\n43\n\n \"totalCancelled\": 0.0 \n\n44\n\n } \n\n45\n\n} \n\n`\n\n> You can also use VTEX Admin to check the list of all invoices issued to a Customer Credit account. To do that, go to **Apps > Customer Credit > Accounts**, and click on the desired invoice.\n\n## Checking details of all Customer Credit invoices in a VTEX store\n\nTo list all invoices created in Customer Credit accounts of a VTEX store, you can use the [Search all invoices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/invoices) endpoint.\n\n**GET - Search all invoices**\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/creditcontrol/invoices/ \n\n`\n\nResponse body example\n\n`1\n\n{ \n\n2\n\n \"data\": [ \n\n3\n\n { \n\n4\n\n \"id\": \"8C7A5F6F57AE4464B3D1F15A0E47C536-01\", \n\n5\n\n \"status\": \"Opened\", \n\n6\n\n \"value\": 15.0, \n\n7\n\n \"accountId\": \"09173503401_CPF\", \n\n8\n\n \"creditValue\": 0.0, \n\n9\n\n \"createdAt\": \"2018-10-24T15:34:14.5879054Z\", \n\n10\n\n \"updatedAt\": \"2018-10-24T15:34:14.6503743Z\", \n\n11\n\n \"originalDueDate\": \"2018-11-23T15:34:14.5879054Z\", \n\n12\n\n \"dueDate\": \"2018-11-23T15:34:14.5879054Z\", \n\n13\n\n \"installment\": 1, \n\n14\n\n \"orderId\": \"500001\", \n\n15\n\n \"transactionId\": \"8C7A5F6F57AE4464B3D1F15A0E47C536\", \n\n16\n\n \"creditAccountId\": \"09173503401_CPF\" \n\n17\n\n }, \n\n18\n\n { \n\n19\n\n \"id\": \"8C7A5F6F57AE4464B3D1F15A0E47C536-01\", \n\n20\n\n \"status\": \"Paid\", \n\n21\n\n \"value\": 15.0, \n\n22\n\n \"accountId\": \"09173503401_CPF\", \n\n23\n\n \"creditValue\": 0.0, \n\n24\n\n \"createdAt\": \"2018-10-24T15:34:14.5879054Z\", \n\n25\n\n \"resolvedAt\": \"2021-03-05T15:01:23.0768211Z\", \n\n26\n\n \"updatedAt\": \"2021-03-05T15:01:23.1236966Z\", \n\n27\n\n \"originalDueDate\": \"2018-11-23T15:34:14.5879054Z\", \n\n28\n\n \"dueDate\": \"2018-11-23T15:34:14.5879054Z\", \n\n29\n\n \"installment\": 1, \n\n30\n\n \"orderId\": \"500001\", \n\n31\n\n \"transactionId\": \"8C7A5F6F57AE4464B3D1F15A0E47C536\", \n\n32\n\n \"creditAccountId\": \"09173503401_CPF\" \n\n33\n\n }, \n\n34\n\n { \n\n35\n\n \"id\": \"A69BD96CDA1F402B939913B81C6346B2-01\", \n\n36\n\n \"status\": \"Opened\", \n\n37\n\n \"value\": 35.0, \n\n38\n\n \"accountId\": \"09173503401_CPF\", \n\n39\n\n \"creditValue\": 0.0, \n\n40\n\n \"createdAt\": \"2018-10-25T01:01:07.3570738Z\", \n\n41\n\n \"updatedAt\": \"2018-10-25T01:01:07.5133444Z\", \n\n42\n\n \"originalDueDate\": \"2018-11-24T01:01:07.3570738Z\", \n\n43\n\n \"dueDate\": \"2018-11-24T01:01:07.3570738Z\", \n\n44\n\n \"installment\": 1, \n\n45\n\n \"orderId\": \"500004\", \n\n46\n\n \"transactionId\": \"A69BD96CDA1F402B939913B81C6346B2\", \n\n47\n\n \"creditAccountId\": \"09173503401_CPF\" \n\n48\n\n } \n\n49\n\n……… \n\n50\n\n ], \n\n51\n\n \"summary\": { \n\n52\n\n \"total\": 2388.95, \n\n53\n\n \"count\": 121, \n\n54\n\n \"totalPaid\": 1379.11, \n\n55\n\n \"totalCancelled\": 1.24 \n\n56\n\n } \n\n57\n\n} \n\n`\n\n## Updating invoice details on a Customer Credit account\n\nThrough the [Change invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-) endpoint, you can update an invoice status, create an observation note, or add a link to assist your customer in the payment process.\n\nSee the example below, modifying the status, creating a observation note and adding the payment link to the invoice `7583E36F101C461094AB6CA68FA8EE2C-01` of account `111111111_CPF`:\n\n**PUT - Change invoice**\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01 \n\n`\n\nRequest body example\n\n`1\n\n{ \n\n2\n\n \"status\": \"Paid\", \n\n3\n\n \"observation\": \"BF 2024 customer invoice.\", \n\n4\n\n \"paymentLink\": \"https://paymentlink.com\" \n\n5\n\n} \n\n`\n\n> The success of this call is confirmed by the **200 OK** status and the empty response body.\n\nTo confirm the information was updated, use the [Retrieve invoice by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-) endpoint.\n\nResponse body example\n\n`1\n\n{ \n\n2\n\n \"id\": \"7583E36F101C461094AB6CA68FA8EE2C-01\", \n\n3\n\n \"friendlyId\": \"IBjuAsrJ-1\", \n\n4\n\n \"status\": \"Paid\", \n\n5\n\n \"value\": 9.63, \n\n6\n\n \"accountId\": \"11111111111_CPF\", \n\n7\n\n \"creditValue\": 0.0, \n\n8\n\n \"createdAt\": \"2024-03-03T06:52:53.1314379Z\", \n\n9\n\n \"resolvedAt\": \"2024-05-08T18:43:14.7046593Z\", \n\n10\n\n \"updatedAt\": \"2024-05-08T18:43:14.8765325Z\", \n\n11\n\n \"paymentLink\": \"https://www.paymentlink.com\", \n\n12\n\n \"originalDueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n13\n\n \"dueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n14\n\n \"installment\": 1, \n\n15\n\n \"orderId\": \"1413870513134-01\", \n\n16\n\n \"observation\": \"BF 2024 customer invoice.\", \n\n17\n\n \"transactionId\": \"7583E36F101C461094AB6CA68FA8EE2C\", \n\n18\n\n \"numberOfInstallments\": 1, \n\n19\n\n \"creditAccountId\": \"11111111111_CPF\" \n\n20\n\n} \n\n`\n\nYou can also access your store Admin (**Apps > Customer Credit > Account Details**), select the desired account and invoice to confirm that the information was updated.\n\n\n\n## Postponing the due date of a Customer Credit invoice\n\nTo change the original due date of an invoice in Customer Credit, allowing the customer more time to complete the payment, you can use the endpoint [Postpone an invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-/postponement).\n\nHowever, before defining how many additional days of payment you will provide to the customer, you need to enable the option to postpone payment in your store's settings. To do this, you must use the endpoint [Create or change store configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/storeconfig).\n\nThe following parameters of this endpoint are responsible for enabling the option to postpone payment of invoices in the store:\n\n* `invoicePostponementLimit`: The maximum number of times allowed to extend an invoice.\n* `maxPostponementDays`: The maximum number of days an invoice can be extended.\n* `postponementEnabled`: Allow extension of invoices in the store.\n\n> The settings available in the [Create or change store configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/storeconfig) endpoint apply to all Customer Credit accounts registered in a VTEX store. It is not possible to customize these settings for each specific Customer Credit account of a given store.\n\nSee the example below, where a store is configured to allow invoice expiration dates to be extended up to 3 times and for a maximum period of 30 days in total.\n\n**PUT - Create or change store configuration**\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/creditcontrol/storeconfig \n\n`\n\nRequest body example\n\n`1\n\n{ \n\n2\n\n \"invoicePostponementLimit\": 3, \n\n3\n\n \"maxPostponementDays\": 30, \n\n4\n\n \"postponementEnabled\": true \n\n5\n\n} \n\n`\n\nThe response to this request provides updated information about postponing invoices and other settings already applied in the store.\n\nResponse body example\n\n`1\n\n{ \n\n2\n\n \"dailyInterestRate\": 0.01, \n\n3\n\n \"invoicePostponementLimit\": 3, \n\n4\n\n \"taxRate\": 0.4, \n\n5\n\n \"maxPostponementDays\": 30, \n\n6\n\n \"defaultCreditValue\": 150, \n\n7\n\n \"maxPreAuthorizationGrowthRate\": 0.1, \n\n8\n\n \"myCreditsEnabled\": true, \n\n9\n\n \"toleranceEnabled\": true, \n\n10\n\n \"automaticCheckingAccountCreationEnabled\": true, \n\n11\n\n \"postponementEnabled\": true, \n\n12\n\n \"notificationsSettings\": { \n\n13\n\n \"daysPrior\": [ \n\n14\n\n { \n\n15\n\n \"days\": 1, \n\n16\n\n \"timeOfDay\": \"16:00:00\" \n\n17\n\n } \n\n18\n\n ], \n\n19\n\n \"daysAfter\": [ \n\n20\n\n { \n\n21\n\n \"days\": 0, \n\n22\n\n \"timeOfDay\": \"12:00:00\" \n\n23\n\n } \n\n24\n\n ] \n\n25\n\n } \n\n26\n\n} \n\n`\n\n> For more information about other configuration fields available for Customer Credit in a store, access the [Create or change store configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/storeconfig) endpoint reference.\n\nOnce invoice postponement is enabled, you can postpone a specific invoice. See the example below in which 5 additional days will be granted to pay an invoice with an original due date of May 20, 2024.\n\n**PUT - Postpone an invoice**\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01/postponement \n\n`\n\nRequest body example\n\n`1\n\n{ \n\n2\n\n \"dueDays\": 5 \n\n3\n\n} \n\n`\n\n> The success of this call is confirmed by the **200 OK** status and the empty response body.\n\nTo confirm that the new invoice due date has been modified, use the [Retrieve invoice by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-) endpoint and check the updated information in the `dueDate` field.\n\n**GET - Retrieve invoice by ID**\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01 \n\n`\n\nResponse body example\n\n`1\n\n{ \n\n2\n\n \"id\": \"7583E36F101C461094AB6CA68FA8EE2C-01\", \n\n3\n\n \"friendlyId\": \"IBjuAsrJ-1\", \n\n4\n\n \"status\": \"Opened\", \n\n5\n\n \"value\": 9.63, \n\n6\n\n \"accountId\": \"11111111111_CPF\", \n\n7\n\n \"creditValue\": 0.0, \n\n8\n\n \"createdAt\": \"2024-03-03T06:52:53.1314379Z\", \n\n9\n\n \"updatedAt\": \"2024-04-05T06:52:56.2329924Z\", \n\n10\n\n \"originalDueDate\": \"2024-05-20T06:52:53.1314379Z\", \n\n11\n\n \"dueDate\": \"2024-05-25T06:52:53.1314379Z\", \n\n12\n\n \"installment\": 1, \n\n13\n\n \"orderId\": \"1413870513134-01\", \n\n14\n\n \"transactionId\": \"7583E36F101C461094AB6CA68FA8EE2C\", \n\n15\n\n \"numberOfInstallments\": 1, \n\n16\n\n \"creditAccountId\": \"11111111111_CPF\" \n\n17\n\n} \n\n`\n\nYou can also verify the new invoice due date through your store Admin (**Apps > Customer Credit > Account Details**).\n\n\n\n## Confirming payment of a Customer Credit invoice\n\nTo confirm payment of a Customer Credit invoice, you can use the [Mark an invoice as paid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23post-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-/payments) endpoint.\n\nSee example of payment of invoice `7583E36F101C461094AB6CA68FA8EE2C-01` in account `111111111_CPF`:\n\n**POST - Mark an invoice as paid**\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01/payments \n\n`\n\nResponse body example\n\n`1\n\n{ \n\n2\n\n \"id\": \"7583E36F101C461094AB6CA68FA8EE2C-01\", \n\n3\n\n \"friendlyId\": \"IBjuAsrJ-1\", \n\n4\n\n \"status\": \"Paid\", \n\n5\n\n \"value\": 9.63, \n\n6\n\n \"accountId\": \"11111111111_CPF\", \n\n7\n\n \"creditValue\": 0.0, \n\n8\n\n \"createdAt\": \"2024-03-03T06:52:53.1314379Z\", \n\n9\n\n \"resolvedAt\": \"2024-05-08T18:43:14.7046593Z\", \n\n10\n\n \"updatedAt\": \"2024-05-08T18:43:14.8765325Z\", \n\n11\n\n \"paymentLink\": \"https://www.paymentlink.com\", \n\n12\n\n \"originalDueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n13\n\n \"dueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n14\n\n \"installment\": 1, \n\n15\n\n \"orderId\": \"1413870513134-01\", \n\n16\n\n \"observation\": \"BF 2024 customer invoice.\", \n\n17\n\n \"transactionId\": \"7583E36F101C461094AB6CA68FA8EE2C\", \n\n18\n\n \"numberOfInstallments\": 1, \n\n19\n\n \"creditAccountId\": \"11111111111_CPF\" \n\n20\n\n} \n\n`\n\nYou can also confirm the invoice payment through your store Admin (**Apps > Customer Credit > Account Details**).\n\n\n\n## Cancelling a Customer Credit invoice\n\nIf you wish to cancel a Customer Credit invoice that has been issued but no longer needs to be paid, for example when an order is cancelled, you can use the [Cancel invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23delete-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-) endpoint.\n\n> An invoice that already has a paid status can no longer be canceled.\n\nSee an example of canceling the invoice `7583E36F101C461094AB6CA68FA8EE2C-01` on account `111111111_CPF`:\n\n**DEL - Cancel invoice**\n\n`1\n\nhttps://{accountName}.{environment}.com.br/api/creditcontrol/accounts/11111111111_CPF/invoices/7583E36F101C461094AB6CA68FA8EE2C-01 \n\n`\n\n> The success of this call is confirmed by the **200 OK** status and the empty response body.\n\nTo confirm the invoice was canceled, use the [Retrieve invoice by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api%23get-/api/creditcontrol/accounts/-creditAccountId-/invoices/-invoiceId-) endpoint.\n\nResponse body example\n\n`1\n\n{ \n\n2\n\n \"id\": \"7583E36F101C461094AB6CA68FA8EE2C-01\", \n\n3\n\n \"friendlyId\": \"IBjuAsrJ-1\", \n\n4\n\n \"status\": \"Cancelled\", \n\n5\n\n \"value\": 9.63, \n\n6\n\n \"accountId\": \"11111111111_CPF\", \n\n7\n\n \"creditValue\": 0.0, \n\n8\n\n \"createdAt\": \"2024-03-03T06:52:53.1314379Z\", \n\n9\n\n \"resolvedAt\": \"2024-05-08T18:43:14.7046593Z\", \n\n10\n\n \"updatedAt\": \"2024-05-08T18:43:14.8765325Z\", \n\n11\n\n \"paymentLink\": \"https://www.paymentlink.com\", \n\n12\n\n \"originalDueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n13\n\n \"dueDate\": \"2024-04-02T06:52:53.1314379Z\", \n\n14\n\n \"installment\": 1, \n\n15\n\n \"orderId\": \"1413870513134-01\", \n\n16\n\n \"observation\": \"BF 2024 customer invoice.\", \n\n17\n\n \"transactionId\": \"7583E36F101C461094AB6CA68FA8EE2C\", \n\n18\n\n \"numberOfInstallments\": 1, \n\n19\n\n \"creditAccountId\": \"11111111111_CPF\" \n\n20\n\n} \n\n`\n\nYou can also confirm the invoice cancellation through your store Admin (**Apps > Customer Credit > Account Details**).\n\n\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/customer-credit-integration-guide/managing-a-customer-credit-invoice.md)\n\n[Managing a Customer Credit account« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice//docs/guides/managing-a-customer-credit-account)[External MarketplaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice//docs/guides/external-marketplace-integration-guide)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Checking Customer Credit invoice details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23checking-customer-credit-invoice-details)\n\n[Checking invoice details on a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23checking-invoice-details-on-a-customer-credit-account)\n\n[Checking details of all Customer Credit invoices in a VTEX store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23checking-details-of-all-customer-credit-invoices-in-a-vtex-store)\n\n[Updating invoice details on a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23updating-invoice-details-on-a-customer-credit-account)\n\n[Postponing the due date of a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23postponing-the-due-date-of-a-customer-credit-invoice)\n\n[Confirming payment of a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23confirming-payment-of-a-customer-credit-invoice)\n\n[Cancelling a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23cancelling-a-customer-credit-invoice)\n\nWas this helpful?\n\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/customer-credit-integration-guide/managing-a-customer-credit-invoice.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Checking Customer Credit invoice details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23checking-customer-credit-invoice-details)\n\n[Checking invoice details on a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23checking-invoice-details-on-a-customer-credit-account)\n\n[Checking details of all Customer Credit invoices in a VTEX store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23checking-details-of-all-customer-credit-invoices-in-a-vtex-store)\n\n[Updating invoice details on a Customer Credit account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23updating-invoice-details-on-a-customer-credit-account)\n\n[Postponing the due date of a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23postponing-the-due-date-of-a-customer-credit-invoice)\n\n[Confirming payment of a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23confirming-payment-of-a-customer-credit-invoice)\n\n[Cancelling a Customer Credit invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-a-customer-credit-invoice/docs/guides/managing-a-customer-credit-invoice%23cancelling-a-customer-credit-invoice)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_685e1500
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation business guidelines marketing assets in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\n[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\n[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-design-guidelines)\n\n[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-engineering-guidelines)\n\n[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-docs-guidelines)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[App monetization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\n[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\n[User Experience guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-design-guidelines)\n\n[Engineering guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-engineering-guidelines)\n\n[Documentation guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-docs-guidelines)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/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-business-guidelines-marketing-assets/docs/app-development)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-app-store)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n[Marketing guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)\n\nMarketing guidelines\n\nLearn how to prepare the App Page used to promote your app at the VTEX App Store\n\n> The App Store is now accessible within the Admin in the Extensions Hub. If the Extensions Hub is not yet installed in your store, you can request assistance from our team by [opening a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM). For more information, please refer to the [Extensions Hub](https://read.calvincode.net/reader?url=https://help.vtex.com/es/tracks/extensions-hub--AW7klkYMh557y5IUOgzco/2LDRvGujYsumxi7IlE7CEJ) track and [release note](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/extensions-hub-our-new-place-to-promote-apps-and-partners-inside-vtex-admin).\n\nOnce you have [developed your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-an-app), you have to prepare the App Page used to promote your app at the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/). The App Page is the first point of contact for merchants to learn more about your app and decide whether it suits their business.\n\n\n\nMake sure to present your solutions professionally by adhering to the following principles:\n\n* Clearly describe your app's value proposition, key benefits, and how merchants can benefit from it.\n* Choose a product name that indicates the purpose of the app.\n* Use high-quality images (icons and screenshots) and videos (if applicable).\n\nIf we identify areas for improvement, we will contact you before listing your app on the VTEX App Store.\n\nRefer to the following sections to improve your App Page and increase its adoption on the VTEX App Store.\n\n> We recommend following these best practices while setting up the files that compose an app's marketing assets. Please refer to [this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-preparing-your-app-distribution%23step-2---setting-the-public-folder) for more information.\n\n## Tone & Voice\n\nChoose to favor Serious and Authority tones. We understand they capture the reliability and expertise our system's voice should have.\n\n| Tone and Voice | Description |\n| -------------- | ---------------------------------------------------------------------------------------- |\n| Serious | Speak firmly, respectfully, and honestly - always with a more serious tone than playful. |\n| Authority | Speak with mastery, proficiency, and expertise. |\n\nTo see more about VTEX's tone and voice, go to [UX Writing Guidelines](https://read.calvincode.net/reader?url=https://uxwriting.vtex.com/docs/principles/goals-principles/%23tone-and-voice) and [VTEX Brand Guide](https://read.calvincode.net/reader?url=https://brand.vtex.com/voice-and-tone/) pages.\n\n## Images\n\nImages are a tool to express the visual identity of your app, make users learn more about the app, and reinforce your brand in the VTEX environment. The principles of a pack of images for the app are the following:\n\n* Use high-quality images of your app's UI to show the users how it behaves.\n* Add one icon that represents your app. This icon will appear in search results, the first page of the VTEX App Store, and the App's page.\n* Upload up to ten and at least three screenshots (app's images).\n* For storefront apps, combine Admin and storefront images to illustrate your app's experience for both Merchants and Shoppers.\n* Add different mobile and desktop screenshots to improve the user experience depending on the screen.\n\n### Icon\n\nYour app icon is one of the first elements developers and merchants see when they install your app. It expresses the visual identity and reinforces your brand in the VTEX App Store environment.\n\n\n\n#### Attributes\n\nIcon artwork can populate the entire asset space, or you can design and position artwork elements, such as logos, onto the keyline grid. When placing your artwork, use keylines as a guideline, not a hard rule.\n\nWhen creating your artwork, ensure it conforms to the following:\n\n* Final size: 1024px x 1024px.\n* File type: 32-bit PNG.\n* Color space: sRGB.\n* Format: Square image, without rounded corners.\n* The background of your icon must be a solid color.\n* The icon design must be simple and avoid unnecessary visual details. This will help merchants understand your app's purpose and ensure a better fit on smaller screens.\n* The icon must not exceed 768px of the total space available in the icon size, which is equivalent to a 128px margin on each side.\n\n\n\nAfter the asset is uploaded, our platform dynamically applies the rounded mask to ensure consistency across all app icons.\n\n\n\nOn the left-hand side is your new icon asset. The following two images on the right-hand side show the dynamic processing of the icon.\n\n#### Sizing\n\nWhen dealing with minimalistic artwork, use the full asset space as the background. Use the keylines as guides for positioning artwork elements (e.g., logos).\n\n\n\nDo not force your logo or artwork to fit the full asset space. Instead, utilize the keyline grid.\n\n\n\nBelow we have examples of icon elements that mislead users and violate our guidelines.\n\n\n\n#### Brand adaptation\n\nIf shapes are critical to a logo, do not force the artwork to fully bleed. Instead, place it on the new keyline grid.\n\n\n\nFrom left to right: original icon asset, new icon asset (recommended adaptation), new icon rendered on the App Store.\n\nIf possible, pick a background color for your asset that is appropriate for your brand and does not include any transparency. Transparent assets will display the background color of the App Store UI.\n\n### Screenshots\n\nUse screenshots to visually represent your app's key features and purpose.\n\n\n\n#### Do's and Don'ts\n\n* Provide three to five images showing the app on a Desktop and Mobile screen.\n* Choose images of the app's interface and behavior, as well as the app's available configurations on the Admin panel.\n* Use the PNG format.\n* The image's size must be up to 700 x 400 pixels.\n* Ensure the text in your images is localized according to the app's applicable market.\n* Screenshots must highlight the purpose, actions, and benefits of the app.\n* Do not use images that reveal actual usernames and accounts. Opt to take images with fictional or blurred information.\n* Do not fully maximize the window when taking a screenshot. It can damage the quality of the image.\n\n## Licenses\n\nLicenses are written documents that contain your app's Terms and Conditions (T&C). They establish the direct business relationship between you, the developer, and the retailer that installs the app.\n\n### Do's and Don'ts\n\n* Seek legal advice for the writing of your T&C.\n* Prepare a Personal Data Governance Program, which includes clauses in its T&C on the subject, depending on the applicable legislation, and tools that allow data subjects to exercise their rights.\n* Consider wording limiting liability clauses.\n* Remember to cover Intellectual Property issues.\n* Offer the T&C in your User's language (Expected in English, Portuguese, and Spanish).\n* Analyze the consumer laws of the countries where you operate, and offer consumers the rights provided.\n* Review specific legislation related to your business, such as those issued by central banks if you are in financial services.\n* Make it clear how to hire your service: free, freemium, or premium, for example. Also, review the regulations regarding the payment methods you will accept.\n\n> The recommendations presented here are intended to serve as guidelines for third-party developers and do not represent a legal recommendation. VTEX is not responsible for direct, indirect, moral, punitive damages, consequential damages, or loss of profits arising from the use and/or compliance with these guidelines. Hiring legal advice is necessary and recommended for the final writing of terms and conditions for applications.\n\n## Messaging\n\nThe textual content of your App Page must clearly and concisely highlight your app's value proposition and features so merchants can easily understand what they can do and achieve with your app.\n\nRemember, your App Page is your main marketing tool and touchpoint with merchants.\n\n### Name - Required\n\nThe name of an app is decisive for how merchants will find your app on the VTEX App Store.\n\n\n\n#### Do's and Don'ts\n\n* The app name must be a maximum of 26 characters.\n* Keep it concise and descriptive. Ensure that it alludes to the experiences the app provides.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ------------- | -------------------------------------------------------------------------------------- |\n| Live Shopping | Live Shopping - The app that allows you to live stream events on your store's website. |\n\n* Capitalize the first letter of each word.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ------------- | ------------- |\n| Live Shopping | Live shopping |\n\n* Use _&_ instead of _And_.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ----------------- | ------------------- |\n| Reviews & Ratings | Reviews and Ratings |\n\n* Do not include the word _VTEX_.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| -------------- | ------------------- |\n| Abandoned Cart | VTEX Abandoned Cart |\n\n* Do not use punctuation, such as period, comma, exclamation point, question mark, semicolon, colon, or underscore unless it's part of the actual company name.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| -------------- | --------------- |\n| Social Selling | Social Selling! |\n\n* Do not include the app version number.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ------------------ | ---------------------- |\n| Google Tag Manager | Google Tag Manager 2.x |\n\n### Headline\n\nThe headline should describe the value proposition of your app in a concise sentence. It is shown on the App Page and square cards of apps.\n\n\n\n\n\n### Do's and Don'ts\n\n* The headline must have at most 120 characters.\n* Capture your app's key value proposition concisely.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------- |\n| Engage with customers through live broadcasts, real-time chat, and product promotion.Create live broadcasts on your store, increase sales, and boost customer interaction in real-time. | Live broadcasts with customers.Create Live streaming and sell more. |\n\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ----------------------------------------------------------------- | ------------------------------------------------------------------------------------ |\n| _Set_ shipping address based on user browser's or IP Geolocation. | This app _attempts to determine_ the users' location and set their shipping address. |\n\nConsider using verbs that reference the actions users will be able to take with your app and the benefits it will deliver.\n\n* `Integrate data` | `create wishlists` | `monitor performance`.\n* `Increase revenue` | `deliver convenient experiences`.\n* Avoid repeating the application name.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------ |\n| Integrate your store with Google's navigation and conversion tracking platform. | _Google Tag Manager_ is the app to integrate your store with Google's navigation and conversion tracking platform. |\n\n### Overview\n\nThe overview is the description of the app and should be an engaging message that focuses on how your app can benefit merchants in a clear and precise way.\n\n\n\n#### Do's and Don'ts\n\n* Write a short overview limited to a maximum of 200 characters.\n* The app description must give a glimpse of your app's benefits and functionalities, not a step-by-step explanation of how it works.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Integrate with WordPress to bring blog data to your VTEX IO store and create a blog \"homepage\", category pages, and blog post pages. | The Wordpress Integration app provides a way to bring in blog data from the Wordpress API and create a blog homepage, category pages, and blog post pages on your store, using your existing store header, footer, and styling. |\n\n* Make sure you are addressing for whom your app is, what need it solves, and how uniquely you solve it.\n\n> Numerous value proposition frameworks can be used as a reference in this task, such as the following: _Our \\[product\\] help(s) \\[audience\\] who wants to \\[jobs to be done\\] by \\[verb e.g. reducing, avoiding\\] + \\[a user pain or gain\\]_.\n\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------- |\n| With The Live Shopping app, create live stream events on your store's website, promote product collections, increase sales, and enhance user experience simultaneously while interacting via live chat. | Live shopping is an app to stream live events on your store in real-time. |\n\n* Use the active voice to give the user a sense of action.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- |\n| Offer an exclusive payment method to selected clients. With Customer Credit, you grant credit, determine limits, and manage invoices. | With Customer Credit, the credit will be granted, limits determined, and invoices will be managed. |\n\n* Avoid technical and jargon language.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| ----------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------- |\n| Interact with customers in real-time by generating personalized experiences through real-time chat and the interactive like button. | Interact with customers by managing the event's live chat in the events list by clicking on the desired live event's arrow button. |\n\n### Features\n\nIn `features`, provide a list of your app's main features. It is included at the bottom of the overview.\n\n\n\n#### Do's\n\n* Highlight which tasks can be performed within the app.\n* Write concise and brief descriptions (no more than 15 - 20 words).\n* Use bullet points to make the content easy to scan.\n* Describe what makes your app unique.\n**Show example**\n\n| ✅ Do | ❌ Don't |\n| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Stream & Sell with the VTEX Live Shopping app. No need to hire a separate streaming platform.Highlight products in the live stream to increase sales.Add to cart alert: Show which products are trending and encourage the audience to add these products to their shopping cart. | Stream and sell with the VTEX Live Shopping app without hiring a separate streaming platform. Also, highlight products during the live stream to increase sales. |\n\n### Website URL\n\nThe Website URL is a hyperlink to your website that redirects users to your corporate or app page. Website hyperlinks will be displayed in the sidebar of the App Page. This is an interesting component for presenting your solution in more depth to retailers browsing the VTEX App Store.\n\n#### Do\n\n* Enter a valid URL in this field to direct them to a landing page, \"About Us\" page, or your corporate website.\n\n### Video\n\nUse videos to demonstrate how your app behaves in different scenarios. Videos are exciting resources that complement [images](#images) as an educational tool that shows your app's main benefits and features.\n\n\n\n\n\n#### Do's\n\n* Feature videos of a maximum of 2 minutes.\n* Make a video showing the main features and benefits of your app.\n* Localize your video audio and or transcription according to your audience.\n* Make visually compelling videos to attract attention from potential buyers of your app.\n\nFor example, check out the [video for the Live Shopping app](https://read.calvincode.net/reader?url=https://apps.vtex.com/liveshopping/p).\n\n### Metric description\n\n> Metric descriptions are required only for apps whose pricing is based on one or more metrics. If this is not the case, please do not fill out this field.\n\nFor each metric declared in the `billingOptions` field (found in the app's `manifest.json` file), you must include a simple description of how it works. This description will help the extension buyer understand what each metric does and how it will impact the application billing. For more information about variable rate charging using metrics, check the [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%23setting-the-app-as-public) article.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-business-guidelines-marketing-assets.md)\n\n[App monetization« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets//docs/guides/vtex-io-documentation-business-guidelines-app-monetization)[User Experience guidelinesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets//docs/guides/vtex-io-documentation-design-guidelines)\n\nSee also\n\n[User Experience guidelinesApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-design-guidelines)[Submitting your app to the VTEX App StoreApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)[App Store GuidelinesApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)[Preparing your app for distributionApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Tone & Voice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23tone--voice)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23images)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23icon)[Screenshots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23screenshots)\n\n[Licenses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23licenses)\n\n[Do's and Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23dos-and-donts)\n\n[Messaging](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23messaging)\n\n[Name - Required](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23name-required)[Headline](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23headline)[Do's and Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23dos-and-donts)[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23overview)[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23features)[Website URL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23website-url)[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23video)[Metric description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23metric-description)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store/vtex-io-documentation-business-guidelines-marketing-assets.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Tone & Voice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23tone--voice)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23images)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23icon)[Screenshots](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23screenshots)\n\n[Licenses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23licenses)\n\n[Do's and Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23dos-and-donts)\n\n[Messaging](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23messaging)\n\n[Name - Required](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23name-required)[Headline](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23headline)[Do's and Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23dos-and-donts)[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23overview)[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23features)[Website URL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23website-url)[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23video)[Metric description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets%23metric-description)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_cb9b7384
|
[
{
"role": "system",
"content": "You are a VTEX 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 tracking changes in lighthouse performance score in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/docs/api-reference)\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-tracking-changes-in-lighthouse-performance-score/docs/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-tracking-changes-in-lighthouse-performance-score/docs/storefront-development)\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-tracking-changes-in-lighthouse-performance-score/docs/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-tracking-changes-in-lighthouse-performance-score/docs/troubleshooting)\n\n[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-tracking-changes-in-lighthouse-performance-score/updates/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/updates/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/store-framework-managing-performance)\n\n[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\n[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\n\n[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-enabling-order-form-optimization)\n\n[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\n[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\n[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-optimizing-image-rendering)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/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-tracking-changes-in-lighthouse-performance-score/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/store-framework-managing-performance)\n\n[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\nTracking changes in Lighthouse performance score\n\n> In this tutorial, we'll use [Lighthouse Scoring Calculator](https://read.calvincode.net/reader?url=https://googlechrome.github.io/lighthouse/scorecalc/%23version=6), a tool created by Google that allows you to play with Lighthouse performance metrics and define which thresholds you should aim for to achieve the desired Performance Score.\n\nIt's possible that a change you expected to cause a considerable increase in the _Performance Score_ doesn't affect it at all. Conversely, a seemingly small change may affect the score significantly. The same applies in reverse for possible regressions in performance.\n\nIn the following sections, we'll explore some of the factors that might be the reason for this. However, before proceeding, it's important to remember that:\n\n1. The _Performance Score_ is not linear. Actually, **the _Performance Score_ is a weighted average** of the following six in the lab metrics:\n\n\n\n1. **The _Metrics' Scores_ are not linear.** Lighthouse metrics follow their own rules. To better illustrate that, take the following example: imagine you have a _Largest Contentful Paint (LCP)_ of 8s. You work on some improvements, and you reduce _LCP_ by 2 seconds. When you look at the _Metric Score_ you notice it went from 3 to 13, increasing the overall _Performance Score_ by 2 points (from 76 to 78).\n\n\n\nYou're not satisfied yet, so you work on more changes and you manage to take _LCP_ from 6s to 4s, which also corresponds to a reduction of 2s. However, this time, when you look at the _Metric Score_, you notice it went from 13 to 50, improving the overall _Performance Score_ by 10 points (from 78 to 88).\n\n\n\nNotice that in both cases, there was a reduction of 2s in the _LCP_ time. However, in the first case, this improvement led to a gain of 10 points (from 3 to 13) in the _Metric Score_. Meanwhile, in the second case, the same reduction of 2s led to a gain of 37 points (from 13 to 50).\n\nWith that in mind, let's dive deeper and explore some other reasons for \"unexpected\" behaviors from Lighthouse.\n\n## Going from nothing to nothing\n\nWhen you have a metric that scores too low, a seemingly significant change may not affect the _Performance Score_ as expected.\n\nTo better illustrate that, let's investigate the _Largest Contentful Paint (LCP)_ metric.\n\n_LCP_ has a weight of 25% on the _Performance Score_. Therefore, to affect the overall _Performance Score_, the _LCP_ score must be at least 2, which would correspond to 1 point (rounding up 2\\*0.25=0,5) in the _Performance Score_.\n\n> When calculating the _Performance Score_, decimal values greater than 0.5 are rounded up to the next largest whole number.\n\nWith that in mind, suppose _LCP_ went from 12s to 8s.\n\n\n\nNotice that, even if this could be considered a significant improvement, any LCP time greater than approximately 8s yields a _Performance Score_ of 0\\. So, in this example, the _LCP_ score went from 0 to 3, leading to a gain equivalent to 1 in the _Performance Score_ (rounding up 3\\*0.25=0.75).\n\nIn this sense, to have an idea of when the _Metric Score_ is too slow, we recommend that you take a look at the maximum values for starting punctuating with each metric.\n\n\n\n> Notice that the metrics scores will be 0 for any value above the given limits.\n\nWe also recommend being attentive to the following values:\n\n| Good | Needs improvement | Poor | |\n| --------------------------------- | ----------------- | --------------- | ----------- |\n| **First Contentful Paint (FCP**) | 0 - 1000ms | 1000ms - 3000ms | Over 3000ms |\n| **Speed Index (SI)** | 0 - 4300ms | 4400ms - 5800ms | Over 5800ms |\n| **Largest Contentful Paint(LCP)** | 0 - 2500ms | 2500ms - 4000ms | Over 4000ms |\n| **Time to Interactive (TTI)** | 0 - 3800ms | 3900ms - 7300ms | Over 7300ms |\n| **Total Blocking Time (TBT)** | 0 - 300ms | 300ms - 600ms | Over 600ms |\n| **Cumulative Layout Shift(CLS)** | 0 - 0.1 | 0.1 - 0.25 | Over 0.25 |\n\n## Cascading effect\n\nIf you're struggling with the Lighthouse Performance audit, we recommend that you pay attention to _First Contentful Paint (FCP)._\n\nThe _FCP_ metric measures how long it takes to display the very first piece of content of the page.\n\nIf _FCP_ time is too long, it will affect almost all of the other metrics, dragging the _Performance Score_ way down.\n\nA slow _FCP_ time might mean that, for some reason, the server is taking too long to respond. It might also mean that **Server-Side Rendering (SSR) is not working.**\n\nIf SSR is not working correctly, the page needs to download, parse, and execute all of its JS files so it can finally display any content at all.\n\n\n\nNotice that many metrics, such as _SI_, _LCP_, _TTI_, depend on the content being displayed as soon as possible. Consequently, they are directly affected by _FCP_, making this metric extremely important for the overall _Performance Score_.\n\nTake the following example:\n\n\n\n## Variabilities from run to run\n\nIf the _Performance Score_ of your page keeps changing, keep in mind that different network conditions might be affecting the score and triggering cascading effects.\n\nFor example, if you run Lighthouse when the page is taking a bit too long to respond, most of the metrics might be affected. That will generate a much worse score.\n\nIdeally, the root cause must be fixed. But, in general, we recommend that you [**run the test around five times and pick the median value.**](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/lighthouse/variability%23run%5Flighthouse%5Fmultiple%5Ftimes)\n\n[An in-depth explanation of score variability can be found here.](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/lighthouse/variability)\n\n## Perceived performance matters\n\nWeb performance is a relative term. From the user's point of view, it's a perception of how he experiences page loading and how responsive a page feels.\n\nSome metrics, especially _Largest Contentful Paint (LCP)_, _Speed Index (SI)_, and _Cumulative Layout Shift (CLS)_, are based on perception rather than pure speed. In broad terms, they track how long it takes for the content above-the-fold to be visibly ready.\n\nThese metrics are affected by conditions that don't necessarily make the page slower. That's why sometimes you may have the feeling that the _Performance Score_ changed without any apparent reason. They can be affected, for example, by elements that shift around, images without pre-set dimensions, large images, modal windows, components added via JS, etc.\n\nNotice that these three metrics have a huge impact on the overall _Performance Score_ and account for 45 points of the total.\n\n\n\n## Everything is connected\n\nSometimes metrics can be conflicting between them and something that should improve one metric impacts another, lowering the overall _Performance Score_.\n\nFor example, lazy-loading images might improve the _Time to Interactive (TTI)_ metric because JS is loaded earlier. However, by delaying the time taken to render the largest element of the page, the _Largest Contentful Paint (LCP)_ is negatively affected.\n\nThe advice here, which applies to other cases as well, is to keep in mind which metrics you are expecting to improve and to mind potential drawbacks in the others.\n\nBesides that, to paint a clearer picture of what is happening, track individual measurements instead of only the total _Performance Score_.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/boosting-performance/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score.md)\n\n[Enabling performance settings« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score//docs/guides/vtex-io-documentation-enabling-performance-settings)[Lazy loading componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score//docs/guides/vtex-io-documentation-using-the-fold-blocks)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Going from nothing to nothing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23going-from-nothing-to-nothing)\n\n[Cascading effect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23cascading-effect)\n\n[Variabilities from run to run](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23variabilities-from-run-to-run)\n\n[Perceived performance matters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23perceived-performance-matters)\n\n[Everything is connected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23everything-is-connected)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/boosting-performance/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Going from nothing to nothing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23going-from-nothing-to-nothing)\n\n[Cascading effect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23cascading-effect)\n\n[Variabilities from run to run](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23variabilities-from-run-to-run)\n\n[Perceived performance matters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23perceived-performance-matters)\n\n[Everything is connected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score%23everything-is-connected)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_57cae73a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides add merchant context data to the cart in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\nAdding merchant context information to the cart\n\nThe shopping cart gathers information on the products the customer chooses while browsing a store, such as prices, shipping costs, payment methods, delivery methods, etc. This data may include item prices, shipping value, payment, and delivery methods, among others.\n\nThis guide will describe how to add relevant information related to a specific order to a shopping cart via API.\n\n## Getting shopping cart information\n\nThe first step is to get the `orderFormId` of the shopping cart to which you want to add the merchant context information. For more information, read the [Getting cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-cart-information-by-id) guide.\n\n## Adding merchant context information to the shopping cart\n\nTo add merchant context information to the shopping cart, you need to use the [Add merchant context data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/addmerchantcontextdata) endpoint. In this request, you must send the `orderFormId` through the URL address, as in the example below:\n\n`https://{accountName}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a/attachments/merchantContextData`\n\nAdditionally, you need to send the request with the merchant context information within the `salesAssociateData` object. See a request body example containing the vendor (seller) identification code:\n\n`1\n\n{ \n\n2\n\n \"salesAssociateData\": { \n\n3\n\n \"salesAssociateId\": \"seller123\" \n\n4\n\n } \n\n5\n\n} \n\n`\n\nAfter sending the request, the endpoint will return the response body containing the merchant context data in the shopping cart, as in the example below:\n\n`1\n\n... \n\n2\n\n\"merchantContextData\": { \n\n3\n\n \"salesAssociateData\": { \n\n4\n\n \"salesAssociateId\": \"seller123\" \n\n5\n\n } \n\n6\n\n } \n\n7\n\n... \n\n`\n\n> ️ For more information about the meaning of each field available in the shopping cart, see the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error codes\n\nThe following errors may appear as a message in the response body.\n\n### 400 - Bad Request\n\n* **Message error example (code ORD002)**: `\"Invalid order form\"`. The `orderFormId` information is not valid.\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD002\", \n\n5\n\n \"message\": \"Invalid order form\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"5d9f54e6-7db4-46d6-bca9-deeb278b8b98\" \n\n9\n\n} \n\n`\n\n### 404 - Not Found\n\n* `Message error example: \"The requested URL was not found on the server\"`: Check if the URL is correct.\n\n`1\n\n<body> \n\n2\n\n <h1>404 Not Found</h1> \n\n3\n\n <p>The requested URL was not found on this server.</p> \n\n4\n\n</body> \n\n`\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-quick-start-guides/add-merchant-context-information-to-the-cart.md)\n\n[Adding payment information to the cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart//docs/guides/adding-payment-information-to-the-cart)[ConfigurationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart//docs/guides/configuration-section-api-quick-start-guides)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/GeorgeLimaDev)\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding merchant context information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23adding-merchant-context-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23404-not-found)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-quick-start-guides/add-merchant-context-information-to-the-cart.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding merchant context information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23adding-merchant-context-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart%23404-not-found)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_1da69cec
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides adding telesales impersonated email using the session manager in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/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/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/session-manager)\n\n[Session data aggregation: create and transform calls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/session-data-aggregation-create-and-transform-calls)\n\n[Session data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/session-data-available-from-vtex-apps)\n\n[Adding telesales impersonated email using the Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/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/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/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/adding-telesales-impersonated-email-using-the-session-manager/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/adding-telesales-impersonated-email-using-the-session-manager/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/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/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/session-manager)\n\n[Session data aggregation: create and transform calls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/session-data-aggregation-create-and-transform-calls)\n\n[Session data available from VTEX apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/session-data-available-from-vtex-apps)\n\n[Adding telesales impersonated email using the Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/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/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/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/adding-telesales-impersonated-email-using-the-session-manager/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/adding-telesales-impersonated-email-using-the-session-manager/docs/guides)\n\nIntegration Guides\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/session-manager)\n\n[Adding telesales impersonated email using the Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager)\n\nAdding telesales impersonated email using the Session Manager\n\nFor B2B ecommerce operations, telesales operators must be able to conclude purchases on behalf of customers, by \"impersonating\" them. This is because, in this scenario, it is common for sales to be made on the platform, but not directly by the customer.\n\nIn order to allow this type of selling, VTEX offers the telesales feature, through which an operator \"takes the place\" of the final customer during the process of choosing the products and the checkout. The operator takes over the customer's user, with limited permissions, and is able to make purchases.\n\n## Telesales Toolbar\n\nThe [telesales toolbar](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/telesales-toolbar--tutorials%5F5500) is the most straightforward way to use the telesales feature. A top bar appears on the store's frontend once the registered operator logs in to the store environment. It is displayed in all site areas, except on the [My Orders screen](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-my-account-works--2BQ3GiqhqGJTXsWVuio3Xh%23orders).\n\nThese are the steps required to use the telesales toolbar:\n\n1. [Create a telesales user](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/como-criar-um-usuario-de-televendas--frequentlyAskedQuestions%5F4227).\n2. [Make a purchase via telesales](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/comprar-em-nome-do-cliente-pelo-televendas--4gsnClNy1iUCkSK6y0GI2O).\n\nAlso you can [customize the telesales toolbar](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/usando-e-customizando-toolbar-de-televendas--tutorials%5F5500).\n\n## Session API\n\nAlthough the telesales toolbar is the simplest option to allow \"impersonated\" purchases, you can use the Session Manager API to achieve the same effect, but with greater control by the store.\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/session-manager) is a system that tracks the current browsing session of all end customers in VTEX stores. Its API allows the store to gather relevant session information, automatically captured and stored in a safe and easily accessible location.\n\nFor more complex B2B operations, building an integration directly with the Session Manager API may be interesting. In this case, instead of impersonating the customer through the telesales toolbar, the store inserts the customer's email address to be impersonated into the Session Manager’s information.\n\nIf the session administrator has permission to impersonate customers, each impersonated user’s ID and email will be loaded into the session, and the operator can make purchases on their behalf.\n\n### Installing the vtex.impersonate-session app\n\nA session is made up of JSON objects, which are fed with information from a series of apps installed in the store. One of these apps is the `vtex.impersonate-session`, which allows impersonating customers.\n\nThis app is not installed by default in VTEX stores. So, first of all, you need to install it. For this, you must use VTEX CLI. If it is not yet installed on your computer, install it by running the command below on your terminal:\n\n`1\n\nyarn global add vtex \n\n`\n\n> Learn more about [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). Once the CLI is installed, log into your store by running the command:\n\n`1\n\nvtex login \n\n`\n\nNow, let's install the `vtex.impersonate-session` app. Type the following command:\n\n`1\n\nvtex install vtex.impersonate-session \n\n`\n\nThe app is already installed in your store, and the customer impersonation feature has been enabled.\n\n### Using Session Manager to impersonate customers\n\nThe `vtex.impersonate-session` app, like all apps with session dependencies, monitors changes to their inputs and modifies session parameters through their outputs.\n\nIt receives the `vtex-impersonated-customer-email` parameter through a direct `POST` or cookie and tries to impersonate the user who owns this email by using the administrator’s credentials in the session. If these credentials are allowed to impersonate customers (in other words, if the operator has the telesales role), the ID and email of the impersonated user are loaded into the session.\n\nThese are the request's inputs:\n\n* `public`: `vtex-impersonated-customer-email`\n* `cookie`: `vtex-impersonated-customer-email`\n* `authentication`: `adminUserEmail`\n\nAnd these are the outputs returned by the app:\n\n* `impersonate`: `storeUserId`, `storeUserEmail`, `canImpersonate`, `account`\n\nSee an example of an object sent in the request:\n\n`1\n\n{ \n\n2\n\n \"public\": { \n\n3\n\n \"vtex-impersonated-customer-email\": { \n\n4\n\n \"value\": \"client@gmail.com\" \n\n5\n\n }, \n\n6\n\n \"authentication\": { \n\n7\n\n \"value\": \"operator@gmail.com\" \n\n8\n\n } \n\n9\n\n } \n\n10\n\n} \n\n`\n\nExample response body:\n\n`1\n\n\"public\": { \n\n2\n\n \"vtex-impersonated-customer-email\": { \n\n3\n\n \"value\": \"client@gmail.com\" \n\n4\n\n }, \n\n5\n\n \"authentication\": { \n\n6\n\n \"value\": \"operator@gmail.com\" \n\n7\n\n } \n\n8\n\n }, \n\n9\n\n \"impersonate\": { \n\n10\n\n \"canImpersonate\": { \n\n11\n\n \"value\": \"true\" \n\n12\n\n }, \n\n13\n\n \"account\" : { \n\n14\n\n \"value\": \"myStore\" \n\n15\n\n } \n\n16\n\n } \n\n`\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/session-manager/adding-telesales-impersonated-email-using-the-session-manager.md)\n\n[Session data available from VTEX apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager//docs/guides/session-data-available-from-vtex-apps)[Tax ServiceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager//docs/guides/tax-service-integration-guide)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Telesales Toolbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager%23telesales-toolbar)\n\n[Session API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager%23session-api)\n\n[Installing the vtex.impersonate-session app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager%23installing-the-vteximpersonate-session-app)[Using Session Manager to impersonate customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager%23using-session-manager-to-impersonate-customers)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/session-manager/adding-telesales-impersonated-email-using-the-session-manager.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Telesales Toolbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager%23telesales-toolbar)\n\n[Session API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager%23session-api)\n\n[Installing the vtex.impersonate-session app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager%23installing-the-vteximpersonate-session-app)[Using Session Manager to impersonate customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-telesales-impersonated-email-using-the-session-manager/docs/guides/adding-telesales-impersonated-email-using-the-session-manager%23using-session-manager-to-impersonate-customers)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_a5316eff
|
[
{
"role": "system",
"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 ProductSummarySKUName app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/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/ProductSummarySKUName/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/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/ProductSummarySKUName/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/ProductSummarySKUName/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/ProductSummarySKUName/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/ProductSummarySKUName/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/ProductSummarySKUName/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/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/ProductSummarySKUName/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/vtex-io-apps)\n\nProduct Summary SKU Name\n\n[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\nProduct Summary SKU Name is a block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-summary) responsible for rendering the selected SKU's name.\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary-sku-name` block to your store theme as a child of `product-summary.shelf`. For example:\n\n`1\n\n \"product-summary.shelf\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-summary-image\", \n\n4\n\n \"product-summary-name\", \n\n5\n\n+ \"product-summary-sku-name\", \n\n6\n\n \"product-summary-attachment-list\", \n\n7\n\n \"product-summary-space\", \n\n8\n\n \"product-summary-column#1\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ---------------- |\n| skuNameContainer |\n\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/ProductSummarySKUName/docs/apps/vtex.product-summary)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName/docs/apps/vtex.product-summary@2.91.0/ProductSummarySKUName%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_5f26ba4b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides define payment methods displayed on vtex sales app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app)\n\n[Change VTEX Sales App language](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/change-vtex-sales-app-language)\n\n[Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/hide-anonymous-customer-option)\n\n[Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\n[Enable the Observation field in the order screen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/enable-the-remarks-field-in-the-order-screen)\n\n[Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/sales-associate-code)\n\n[Enable cart transfer and capture between devices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/force-stock-availability)\n\n[Add extra text to the order summary print](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/add-extra-text-to-the-order-print)\n\n[Hide Print order and Reprint receipt buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/hide-print-order-and-reprint-receipt-buttons)\n\n[Enable partial cancellation for Debit or Credit Direct sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/hide-cancellation-buttons)\n\n[Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app)\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app)\n\n[Change VTEX Sales App language](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/change-vtex-sales-app-language)\n\n[Hide anonymous customer option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/hide-anonymous-customer-option)\n\n[Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\n[Enable the Observation field in the order screen](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/enable-the-remarks-field-in-the-order-screen)\n\n[Enable the sales associate code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/sales-associate-code)\n\n[Enable cart transfer and capture between devices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/enable-cart-transfer-between-devices)\n\n[Force stock availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/force-stock-availability)\n\n[Add extra text to the order summary print](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/add-extra-text-to-the-order-print)\n\n[Hide Print order and Reprint receipt buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/hide-print-order-and-reprint-receipt-buttons)\n\n[Enable partial cancellation for Debit or Credit Direct sales](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/enable-partial-cancellation)\n\n[Hide cancellation buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/hide-cancellation-buttons)\n\n[Allow manual prices on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/allow-manual-prices-on-vtex-sales-app)\n\n[Integration VTEX Sales App Local stock sale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/integration-vtex-sales-app-local-stock-sale)\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides)\n\nVTEX Sales App\n\n[How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/how-to-customize-vtex-sales-app)\n\n[Define payment methods displayed on VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app)\n\nDefine payment methods displayed on VTEX Sales App\n\nAfter creating a payment condition as described in the [VTEX Sales App - Payments](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-sales-app-payments--43B4Nr7uZva5UdwWEt3PEy/2liigRors32hzqBNs2M1Oa) guide, we need to create the filters that will define which payment methods will appear at inStore’s checkout.\n\nYou must do this by inserting a JavaScript object in the `checkout-instore-custom.js` file. Check out the [How to customize VTEX Sales App](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/how-to-customize-vtex-sales-app) guide for further information on how to access this file.\n\n## Edit the `checkout-instore-custom.js` file\n\nThere are two options for defining which payment methods will be displayed on VTEX Sales App. You can set global payment methods, that is, payment methods that any VTEX Sales App user will be able to see, or payment methods per vendor, which means only specific users will be able to see them.\n\n### Define global payment methods\n\n1. The object that contains the payment filters is called `window.PAYMENTS_FILTER_GLOBAL`. If this object does not already exist in the code, you should insert it, as described below.\n\nThe `window.PAYMENTS_FILTER_GLOBAL` object should contain the following properties:\n\n`` 1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"h-0\": \"Attribute\", \n\n4\n\n \"h-1\": \"Type\", \n\n5\n\n \"h-2\": \"Description\", \n\n6\n\n \"0-0\": \"`removeFilters`\", \n\n7\n\n \"0-1\": \"array\", \n\n8\n\n \"0-2\": \"You should add payment conditions that **will not** be displayed on VTEX Sales App in this array\", \n\n9\n\n \"1-0\": \"`filters`\", \n\n10\n\n \"1-1\": \"array\", \n\n11\n\n \"1-2\": \"You should add payment conditions that **will** be displayed on VTEX Sales App in this array\" \n\n12\n\n }, \n\n13\n\n \"cols\": 3, \n\n14\n\n \"rows\": 2 \n\n15\n\n} \n\n ``\n\nYou must identify each payment condition by their **payment condition ID**. Check [Where to find the payment condition ID](#where-to-find-the-payment-condition-id) for more details.\n\nThe code should look similar to the example below.\n\n`1\n\n{ \n\n2\n\n \"codes\": [ \n\n3\n\n { \n\n4\n\n \"code\": \"\\nwindow.PAYMENTS_FILTER_GLOBAL = {\\n removeFilters: [\\n '6', // Boleto Bancário\\n '45', // Direct debit\\n ],\\n filters: [\\n '2', '4', // Credit card\\n '202' // Cash\\n '125' // Pix\\n ]\\n};\", \n\n5\n\n \"language\": \"javascript\" \n\n6\n\n } \n\n7\n\n ] \n\n8\n\n} \n\n`\n\nIn this example, we are excluding the conditions “Boleto bancário” (ID = 6) and \"Direct debit\" (ID = 45); and we are including “Credit card” (IDs = 2 and 4), “Cash” (ID = 202) and \"Pix\" (ID = 125). The first two will not be displayed at checkout, while the last two will be displayed.\n\n1. Still in the `checkout-instore-custom.js` file, you need to add a reference to the object created within the `window.INSTORE_CONFIG` object.\n\nTo do this, include the following line of code inside the `window.INSTORE_CONFIG` object:\n\n`1\n\npayments: window.PAYMENTS_FILTER_GLOBAL \n\n`\n\nThe `window.INSTORE_CONFIG` object should then look like the example below:\n\n`1\n\nwindow.INSTORE_CONFIG = { \n\n2\n\n payments: window.PAYMENTS_FILTER_GLOBAL, \n\n3\n\n}; \n\n`\n\n> Do not remove any of the other properties present in the `window.INSTORE_CONFIG` object to avoid breaking other functionalities.\n\n1. After making changes in the code, make sure you press the `Save` button.\n\n### Define payment methods per sales associate\n\nAfter you define the global payment methods that will be displayed in your store, you can override this information with the specific payment methods you want to remove for specific sales associates.\n\n1. You must declare a constant object in the `checkout-instore-custom.js` file. Inside it, you can use `removeFilters` and `filters` properties described in the [Define global payment methods](#define-global-payment-methods) section to define the payment methods that will be displayed for this user. \nThe example below determines that the user whose email is `john@email.com` will not see the Cash payment method option on VTEX Sales App.\n\n`1\n\nconst vendorConfig = { \n\n2\n\n 'john@email.com': { \n\n3\n\n payments: { \n\n4\n\n removeFilters: [ \n\n5\n\n '202', // Cash \n\n6\n\n ], \n\n7\n\n }, \n\n8\n\n }, \n\n9\n\n} \n\n`\n\n1. Add the following functions to your `checkout-instore-custom.js` file. They will observe if the sales associate has a specific configuration associated with them, then set the specific payment methods filter associated with them, and repeat this validation every time a different user logs in.\n\n`1\n\nfunction hasVendorConfig(vendor) { \n\n2\n\n const email = vendor && vendor.username \n\n3\n\n return ( \n\n4\n\n email && \n\n5\n\n vendorConfig[email] && \n\n6\n\n vendorConfig[email].payments && \n\n7\n\n (vendorConfig[email].payments.filters || \n\n8\n\n vendorConfig[email].payments.removeFilters) \n\n9\n\n ) \n\n10\n\n} \n\n11\n\n \n12\n\nfunction setPaymentsFilter(vendor) { \n\n13\n\n const email = vendor && vendor.username \n\n14\n\n if (hasVendorConfig(vendor)) { \n\n15\n\n const pFilters = vendorConfig[email].payments \n\n16\n\n if (pFilters.filters) { \n\n17\n\n window.INSTORE_CONFIG.payments = window.INSTORE_CONFIG.payments || {} \n\n18\n\n window.INSTORE_CONFIG.payments.filters = pFilters.filters \n\n19\n\n } \n\n20\n\n if (pFilters.removeFilters) { \n\n21\n\n window.INSTORE_CONFIG.payments = window.INSTORE_CONFIG.payments || {} \n\n22\n\n window.INSTORE_CONFIG.payments.removeFilters = pFilters.removeFilters \n\n23\n\n } \n\n24\n\n } else { \n\n25\n\n window.INSTORE_CONFIG.payments = window.PAYMENTS_FILTER_GLOBAL \n\n26\n\n } \n\n27\n\n} \n\n28\n\n \n29\n\nfunction onVendorChange(vendor) { \n\n30\n\n setPaymentsFilter(vendor) \n\n31\n\n} \n\n32\n\n \n33\n\ndocument.addEventListener( \n\n34\n\n 'vendorIdentified', \n\n35\n\n function (event) { \n\n36\n\n const data = event.data \n\n37\n\n const vendor = data.vendor \n\n38\n\n onVendorChange(vendor) \n\n39\n\n }, \n\n40\n\n false \n\n41\n\n) \n\n42\n\n \n43\n\nonVendorChange(getVendor()) \n\n`\n\n1. After making changes in the code, make sure you press the `Save` button.\n\n### Where to find the payment condition ID\n\nAs explained above, the implementation of payment filters requires listing the payment condition IDs in the `window.PAYMENTS_FILTER_GLOBAL` object.\n\nYou can find the ID of each condition in the **Payments** module. In the main menu of the VTEX Admin, click on **Payments** and then on **Settings**.\n\nIn the **Payment conditions** tab, you will find the ID next to each of the conditions. In the example below, we see that the payment condition ID for Cash is `202`.\n\n\n\nIf we wanted to include Cash as a payment condition to be displayed at the inStore checkout, this would be the value we would add to the `filters` array, inside the `window.PAYMENTS_FILTER_GLOBAL` object of the `checkout-instore-custom.js` file.\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Sales-App/how-to-customize-vtex-sales-app/define-payment-methods-displayed-on-vtex-sales-app.md)\n\n[Hide anonymous customer option« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app//docs/guides/hide-anonymous-customer-option)[Enable the Observation field in the order screenNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app//docs/guides/enable-the-remarks-field-in-the-order-screen)\n\nContributors\n\n1\n\n[](https://github.com/karenkrieger)\n\nON THIS PAGE\n\n[Edit the checkout-instore-custom.js file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app%23edit-the-checkout-instore-customjs-file)\n\n[Define global payment methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app%23define-global-payment-methods)[Define payment methods per sales associate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app%23define-payment-methods-per-sales-associate)[Where to find the payment condition ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app%23where-to-find-the-payment-condition-id)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Sales-App/how-to-customize-vtex-sales-app/define-payment-methods-displayed-on-vtex-sales-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Edit the checkout-instore-custom.js file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app%23edit-the-checkout-instore-customjs-file)\n\n[Define global payment methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app%23define-global-payment-methods)[Define payment methods per sales associate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app%23define-payment-methods-per-sales-associate)[Where to find the payment condition ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/define-payment-methods-displayed-on-vtex-sales-app/docs/guides/define-payment-methods-displayed-on-vtex-sales-app%23where-to-find-the-payment-condition-id)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_94ab224c
|
[
{
"role": "system",
"content": "You are a VTEX 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 linking an app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-installing-an-app)\n\n[Listing an account’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-listing-an-accounts-apps)\n\n[Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-linking-an-app)\n\n[Deprecating an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-deprecating-an-app)\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n[Installing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-installing-an-app)\n\n[Listing an account’s apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-listing-an-accounts-apps)\n\n[Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-linking-an-app)\n\n[Deprecating an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-deprecating-an-app)\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/app-development)\n\nManaging apps\n\n[Linking an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-linking-an-app)\n\nLinking an app\n\nFor development, an app can be linked to a **development workspace** so that any local code change can be automatically synced and made available in that corresponding workspace.\n\n> Linking an app to a [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace) is not possible.\n\n## Instructions\n\n1. Open the terminal and log in to your VTEX account.\n\n`1\n\nvtex login {account} \n\n`\n\n1. Change to a **development workspace**.\n\n`1\n\nvtex use {workspace} \n\n`\n\n1. Change to your app's directory.\n\n`1\n\ncd {directory} \n\n`\n\n1. Link your app to the current workspace by running the following command:\n\n`1\n\nvtex link \n\n`\n\nOnce your local files are uploaded and synced to your development environment, you should see the following message: `App linked successfully`. Use `https://{workspace}--{account}.myvtex.com`, where `workspace` is the development workspace in use and `account` is the name of your VTEX account, to check your local version of the app.\n\nNotice that the synced app will only be available within the specified development workspace.\n\nIf you are comfortable with your changes and want to make your changes publicly available, please refer to [this](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available) guide.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-linking-an-app.md)\n\n[Listing an account’s apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app//docs/guides/vtex-io-documentation-listing-an-accounts-apps)[Deprecating an appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app//docs/guides/vtex-io-documentation-deprecating-an-app)\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-linking-an-app/docs/guides/vtex-io-documentation-linking-an-app%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/configuring-workspaces/vtex-io-documentation-linking-an-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app/docs/guides/vtex-io-documentation-linking-an-app%23instructions)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_c331a7ee
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore molecules toggle 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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-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-toggle-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-toggle-field/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-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-toggle-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-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-toggle-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-toggle-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-toggle-field/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-overview)\n\nToggleField\n\nGroups a Toggle input and its corresponding Label.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/ToggleField)\n\nThe `ToggleField` component wraps a [Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle) input and its corresponding [Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-label).\n\nExample\n\nCode\n\nLabel\n\nToggle\n\nChecked\n\nDisabled\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { ToggleField } 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/ToggleField/styles.scss'; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Data attributes\n\nYou can target and override `ToggleField` styles using the following data attributes:\n\n`data-fs-toggle-field`\n\n`data-fs-toggle-field-label`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| ---------------- | -------------------------- | -------------------------------------------------------------------------------------- | --------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-toggle-field |\n| **id\\*** | string | ID to identify input and corresponding label. | |\n| **label\\*** | string | The text displayed to identify the input. | |\n| **displayLabel** | false \\| true | Controls whether the label will be displayed or not. | true |\n| **disabled** | false \\| true | Specifies that this input should be disabled. | |\n| **variant** | \"horizontal\" \\| \"vertical\" | Controls the component's direction. | horizontal |\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/toggle-field.mdx)\n\n[Toggle« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle)[TooltipNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-tooltip)\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-toggle-field/docs/guides/faststore/molecules-toggle-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23import-styles)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-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/toggle-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-toggle-field/docs/guides/faststore/molecules-toggle-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23import-styles)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-toggle-field/docs/guides/faststore/molecules-toggle-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_1c47e57c
|
[
{
"role": "system",
"content": "You are a VTEX 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 the weni by vtex cli in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-the-weni-by-vtex-cli/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/api-reference)\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-the-weni-by-vtex-cli/docs/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-the-weni-by-vtex-cli/docs/storefront-development)\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-the-weni-by-vtex-cli/docs/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-the-weni-by-vtex-cli/docs/troubleshooting)\n\n[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-the-weni-by-vtex-cli/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/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-the-weni-by-vtex-cli/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/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-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/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-the-weni-by-vtex-cli/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/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-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/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/using-the-weni-by-vtex-cli/docs/guides)\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/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli)\n\nUsing the Weni by VTEX CLI\n\nLearn how to use Weni by VTEX CLI\n\nThis guide will walk you through using the Weni by VTEX CLI to create, deploy, and manage AI-powered agents, enhancing your customer service capabilities. By the end of this guide, you will be able to install the CLI, configure your project, and deploy your first agent.\n\nWith the CLI, you can:\n\n* Create, deploy, and manage multiple AI agents\n* Add custom tools to the agents\n* Update agent configuration and behavior\n\n> To use the Weni by VTEX CLI, you must have: a Weni by VTEX Platform account; an account at [weni.ai](https://read.calvincode.net/reader?url=https://weni.ai/en); and at least one project in your account.\n\nThe content is organized as follows:\n\n* [Installing the CLI](#step-1---installing-the-cli)\n* [Getting started with your project](#getting-started-with-your-project)\n* [Troubleshooting](#troubleshooting)\n* [Contributing to Weni by VTEX CLI](#contributing-to-weni-cli)\n\n## Step 1 - Installing the CLI\n\nThere are two installation methods:\n\n* A [quick installation](#install-via-pip) with `pip`.\n* A [manual installation](#install-via-poetry) with `Poetry`, for development purposes.\n\n### Install via pip\n\nTo install the CLI using `pip`, open the terminal and run the following command:\n\n`1\n\npip install weni-cli \n\n`\n\n### Install via Poetry\n\nTo install the CLI manually, follow these steps:\n\n1. Clone the repository by running the following command:\n\n`1\n\ngit clone https://github.com/weni-ai/weni-cli.git \n\n2\n\ncd weni-cli \n\n`\n\n1. Install dependencies and make the CLI executable by running the following command:\n\n`1\n\npoetry shell \n\n2\n\npoetry install \n\n`\n\n## Step 2 - Verifying Installation\n\nTo verify that Weni by VTEX CLI is installed, type the following command in your terminal:\n\n`1\n\nweni \n\n`\n\nIf the installation was successful, your terminal should display something like this:\n\n> An error occurred while loading the image https://github.com/vtexdocs/dev-portal-content/main/docs/guides/Weni-by-VTEX/CLI/assets/weni-installation-verification.png\n\n### Troubleshooting\n\nIf you encounter any issues:\n\n1. Check our [GitHub Issues](https://read.calvincode.net/reader?url=https://github.com/weni-ai/weni-cli/issues)\n2. Create a new issue with: \n * Your operating system \n * Python version (`python --version`) \n * Error message \n * Steps to reproduce\n\n### Getting started with your project\n\n#### Step 1 - Log in to your Weni by VTEX account\n\n1. Open the terminal and run the following command:\n\n`1\n\nweni login \n\n`\n\nThis should open your browser on the login page for authentication. If that does not happen, you can open the URL shown in the terminal.\n\n1. Log in using your Weni by VTEX account and password.\n\n#### Step 2 - List your projects\n\nList your projects by running the following command:\n\n`1\n\nweni project list \n\n`\n\nThis will show all projects you have access to and, next to each of them, its universally unique identifier (UUID).\n\n#### Step 3 - Select a project\n\nSelect the project you want to work on by running the following command:\n\n`1\n\nweni project use your-project-uuid \n\n`\n\nReplace `your-project-uuid` with the UUID from the project list.\n\n#### Step 4 - Verify the current project\n\nTo verify you're working on the correct project, you can run the following command:\n\n`1\n\nweni project current \n\n`\n\nYou will see the project's UUID in the terminal output.\n\n#### Step 5 - Initialize a new agent\n\nTo create an agent, run the following command:\n\n`1\n\nweni init \n\n`\n\nThis command performs the following actions:\n\n* Creates the necessary folder structure for your agent.\n* Sets up a pre-built CEP (Complex Event Processing) tool.\n* Creates an `agent_definition.yaml` file with the initial configuration. You can edit this file to customize your agent's behavior.\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 description: \"Function to get the address from the postal code\" \n\n17\n\n parameters: \n\n18\n\n - cep: \n\n19\n\n description: \"postal code\" \n\n20\n\n type: \"string\" \n\n21\n\n required: true \n\n`\n\n##### Understanding the source configuration\n\nIn the YAML above, there are two fields nested within the `source` field:\n\n* `path`: This field specifies the directory containing your tool implementation. \n * The command automatically creates a `tools` directory and a folder called `get_address` nested within it. \n * In this path, you can find the files `main.py`, `requirements.txt`, and `test_definition.yaml`.\n* `entrypoint`: This field informs the system which class to use. \n * Using `main.GetAddress` indicates that the system finds the file named `main.py`, uses the `GetAddress` class inside the file and that the class must inherit from the `Tools` base class.\n\nYour project structure should look like this:\n\n`1\n\nmy-agent-project/ \n\n2\n\n├── agent_definition.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#### Step 6 - Implement the tool manually (if `weni init` fails)\n\nIf the command doesn't work, you can implement this tool manually following the next steps:\n\n1. Create the tool directory\n\n`1\n\n mkdir -p tools/get_address \n\n2\n\n cd tools/get_address \n\n`\n\n1. Create the file `tools/get_address/main.py` and insert the following:\n\n`1\n\n from weni import Tool \n\n2\n\n from weni.context import Context \n\n3\n\n from weni.responses import TextResponse \n\n4\n\n import requests \n\n5\n\n \n6\n\n \n7\n\n class 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\n* The class name `GetAddress` must match the class name in the entrypoint\n* The file name `main.py` must match the file name in the entrypoint\n* The class must inherit from `Tool` and implement the `execute` method\n1. Create the `requirements.txt` file\n\n`1\n\n requests==2.32.3 \n\n`\n\n#### Step 7 - Add credentials and global files (optional)\n\nIf you have credentials and global files, place these files in `tools/get_address` during local runs:\n\n`1\n\n# .env \n\n2\n\napi_key=your-development-api-key \n\n`\n\n`1\n\n# .globals \n\n2\n\nBASE_URL=https://api.example.com \n\n`\n\n#### Step 7 - Deploy the agent\n\nDeploy your agent by running the following command:\n\n`1\n\nweni project push agent_definition.yaml \n\n`\n\n## Advanced Configuration\n\n#### Custom Parameters\n\nYou can add more parameters to your tools:\n\n`1\n\nparameters: \n\n2\n\n - format: \n\n3\n\n description: \"Response format (json or text)\" \n\n4\n\n type: \"string\" \n\n5\n\n required: false \n\n6\n\n default: \"json\" \n\n`\n\n#### Multiple Tools\n\nAgents can have multiple tools:\n\n`1\n\ntools: \n\n2\n\n - get_address: \n\n3\n\n # tool definition \n\n4\n\n - validate_cep: \n\n5\n\n # another tool definition \n\n`\n\n## Contributing to Weni by VTEX CLI\n\nThis guide will help you get started with contributing to the project.\n\n### Development Setup\n\n#### Prerequisites\n\n* Python >= 3.12\n* Poetry >= 1.8.5\n* Git\n\n#### Setting Up Development Environment\n\n1. Fork the repository on GitHub\n2. Clone your fork: \n`1 \ngit clone https://github.com/YOUR_USERNAME/weni-cli.git \n2 \ncd weni-cli \n`\n3. Install dependencies: \n`1 \npoetry install \n`\n4. Create a new branch: \n`1 \ngit checkout -b feature/your-feature-name \n`\n\n### Development Guidelines\n\n#### Code Style\n\n* Follow PEP 8 guidelines\n* Use meaningful variable and function names\n* Add docstrings to functions and classes\n* Keep functions focused and concise\n\n#### Testing\n\n1. Write tests for new features: \n`1 \ndef test_your_feature(): \n2 \n # Your test code here \n3 \n assert expected == actual \n`\n2. Run tests: \n`1 \npoetry run pytest \n`\n3. Check coverage: \n`1 \npoetry run pytest --cov \n`\n\n#### Documentation\n\n1. Update documentation for new features\n2. Add docstrings to new functions\n3. Update README.md if needed\n4. Add examples when relevant\n\n### Making Changes\n\n#### Workflow\n\n1. Create a feature branch\n2. Make your changes\n3. Write or update tests\n4. Update documentation\n5. Run tests locally\n6. Commit your changes\n7. Push to your fork\n8. Create a Pull Request\n\n#### Commit Messages\n\nFollow conventional commits:\n\n* `feat:` New features\n* `fix:` Bug fixes\n* `docs:` Documentation changes\n* `test:` Adding or updating tests\n* `chore:` Maintenance tasks\n\nExample:\n\n`1\n\ngit commit -m \"feat: add support for custom headers in requests\" \n\n`\n\n### Pull Requests\n\n#### PR Guidelines\n\n1. Create one PR per feature/fix\n2. Include tests\n3. Update documentation\n4. Reference issues if applicable\n5. Keep changes focused and minimal\n\n#### PR Template\n\n`1\n\n### Description \n\n2\n\nBrief description of changes \n\n3\n\n \n4\n\n### Type of Change \n\n5\n\n- [ ] Bug fix \n\n6\n\n- [ ] New feature \n\n7\n\n- [ ] Documentation update \n\n8\n\n- [ ] Other (specify) \n\n9\n\n \n10\n\n### Testing \n\n11\n\nDescribe testing done \n\n12\n\n \n13\n\n### Documentation \n\n14\n\nList documentation updates \n\n`\n\n### Review Process\n\n1. Automated checks must pass\n2. Code review by maintainers\n3. Documentation review\n4. Changes requested if needed\n5. Approval and merge\n\n### Getting Help\n\n* Create an issue for bugs\n* Ask questions in discussions\n* Join our community channels\n\n### Development Tools\n\n#### Recommended VSCode Extensions\n\n* Python\n* YAML\n* markdownlint\n* GitLens\n\n#### Useful Commands\n\n`1\n\n# Format code \n\n2\n\npoetry run black . \n\n3\n\n \n4\n\n# Run linter \n\n5\n\npoetry run flake8 \n\n6\n\n \n7\n\n# Run tests \n\n8\n\npoetry run pytest \n\n9\n\n \n10\n\n# Build documentation \n\n11\n\npoetry run mkdocs serve \n\n`\n\n### Release Process\n\n1. Version bump\n2. Update CHANGELOG\n3. Create release PR\n4. Tag release\n5. Deploy to PyPI\n\n### Community\n\n* Be respectful and inclusive\n* Help others when possible\n* Share knowledge\n* Follow our Code of Conduct\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/using-the-weni-by-vtex-cli.md)\n\n[Limitations of the PII data architecture during closed beta« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli//docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)[Weni by VTEX CLI Command ReferenceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli//docs/guides/weni-by-vtex-cli-command-reference)\n\nSee also\n\nContributors\n\n1\n\n[](https://github.com/mariananantua)\n\nON THIS PAGE\n\n[Step 1 - Installing the CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23step-1-installing-the-cli)\n\n[Install via pip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23install-via-pip)[Install via Poetry](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23install-via-poetry)\n\n[Step 2 - Verifying Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23step-2-verifying-installation)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23troubleshooting)[Getting started with your project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23getting-started-with-your-project)\n\n[Advanced Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23advanced-configuration)\n\n[Contributing to Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23contributing-to-weni-by-vtex-cli)\n\n[Development Setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-setup)[Development Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-guidelines)[Making Changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23making-changes)[Pull Requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23pull-requests)[Review Process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23review-process)[Getting Help](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23getting-help)[Development Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-tools)[Release Process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23release-process)[Community](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23community)\n\nWas this helpful?\n\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/using-the-weni-by-vtex-cli.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Step 1 - Installing the CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23step-1-installing-the-cli)\n\n[Install via pip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23install-via-pip)[Install via Poetry](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23install-via-poetry)\n\n[Step 2 - Verifying Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23step-2-verifying-installation)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23troubleshooting)[Getting started with your project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23getting-started-with-your-project)\n\n[Advanced Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23advanced-configuration)\n\n[Contributing to Weni by VTEX CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23contributing-to-weni-by-vtex-cli)\n\n[Development Setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-setup)[Development Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-guidelines)[Making Changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23making-changes)[Pull Requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23pull-requests)[Review Process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23review-process)[Getting Help](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23getting-help)[Development Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23development-tools)[Release Process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23release-process)[Community](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-the-weni-by-vtex-cli/docs/guides/using-the-weni-by-vtex-cli%23community)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_67f40409
|
[
{
"role": "system",
"content": "You are a VTEX 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 content internationalization in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-content-internationalization/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/api-reference)\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-content-internationalization/docs/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-content-internationalization/docs/storefront-development)\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-content-internationalization/docs/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-content-internationalization/docs/troubleshooting)\n\n[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-content-internationalization/updates/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-content-internationalization/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-content-internationalization/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/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/storefront-content-internationalization/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/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/storefront-content-internationalization/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/storefront-content-internationalization/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/storefront-content-internationalization/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/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/storefront-content-internationalization/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/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/storefront-content-internationalization/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/updates/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-content-internationalization/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-content-internationalization/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/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/storefront-content-internationalization/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/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/storefront-content-internationalization/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/storefront-content-internationalization/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/storefront-content-internationalization/docs/guides/vtex-io-multi-language-stores)\n\n[Internationalizing product prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-internationalizing-product-prices)\n\n[Disabling automatic translation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-disabling-automatic-translation)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization)\n\n[Translating Catalog content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/catalog-internationalization)\n\n[Overwriting the Messages app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-overwriting-the-messages-app)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/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/storefront-content-internationalization/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/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/storefront-content-internationalization/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/store-framework)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/vtex-io-multi-language-stores)\n\n[Translating storefront content](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization)\n\nTranslating storefront content\n\nLearn how to translate text messages from a frontend app.\n\nA message is any website text content set as translatable, and Messages is the VTEX IO app responsible for providing message translations for rendering.\n\nAs a background, it's important to know that every text set as translatable during the development of a storefront component is automatically translated either by the _storefront app's definitions_ (declared in the app's `/messages` folder) or by the _automatic translation service_ (when the storefront app doesn't include any specific translation of a message).\n\nHowever, considering literal translations and cultural factors, some translations might be unsatisfactory.\n\nHence, you may want to overwrite a translation provided by the automatic translation service or by the app's definitions with a more specific or representative content of your store.\n\nFor example, you may want to set a special login message for Spanish-speaking users from Argentina.\n\nConsidering this case, in the following step-by-step, we'll teach you how to overwrite a storefront message with exclusive content for your store through the Messages app.\n\n## Instructions\n\nFollow this step-by-step to translate text messages exported from an app (declared in the app's `messages` folder).\n\n1. [Install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) the `vtex.admin-graphql-ide@3.x` app using your terminal.\n2. Access the Admin and go to **Store Setting > Storefront > GraphQL IDE**.\n3. From the dropdown list, choose the `vtex.messages` app.\n4. Write the following mutation command in the text box that is displayed:\n\n`1\n\nmutation Save($saveArgs: SaveArgsV2!) { \n\n2\n\n saveV2(args: $saveArgs) \n\n3\n\n} \n\n`\n\n1. Then, click on _Query Variables_ at the bottom of the page. Now, your screen may look like the following:\n\n\n\n1. To fill in the _Query Variables_ box, you must provide the following parameters:\n* `to`: target translation locale.\n* `messages`: a list of the messages you want to translate, containing the following parameters: \n * `srcLang`: source message locale. This variable must contain the value `en-DV`, no matter which locale is rendered on the app's interface. \n * `srcMessage`: the `id` of your message string declared in the app's `messages` folder. \n * `context`: the name of the storefront app that declared the message being overwritten. \n * `targetMessage`: the desired translation for the message string.\n\nTake the following example:\n\n`1\n\n{ \n\n2\n\n \"saveArgs\": { \n\n3\n\n \"to\": \"en-US\", \n\n4\n\n \"messages\": [ \n\n5\n\n { \n\n6\n\n \"srcLang\": \"en-DV\", \n\n7\n\n \"srcMessage\": \"store/search.placeholder\", \n\n8\n\n \"context\": \"vtex.store-components@3.x\", \n\n9\n\n \"targetMessage\": \"My personalized Search message\" \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n} \n\n`\n\n> In VTEX IO, translations of storefront components are kept in a `/messages` folder inside the app's root folder. For example, the English translation of the `search.placeholder` message from the `store-components` app is declared [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-components/blob/master/messages/en.json%23L2). Hence, in this example, we just overwrote this message with \"My personalized Search message\" through the Messages app.\n\n1. After adjusting your query, click the play button to run the declared mutation. The expected response is as follows:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"saveV2\": true \n\n4\n\n } \n\n5\n\n} \n\n`\n\n1. (Optional) If you want to check your changes on the GraphQL IDE, check the \" Checking your changes\" section.\n\nNow, no further actions are needed on your part. Once you receive the expected response, you are ready to check out the desired changes in your store!\n\nTo better understand the full process of overwriting an app message translation, check the following gif:\n\n\n\n## Checking your changes\n\nIf you have already performed the desired mutations, you can check your changes through a query in the GraphQL IDE.\n\n1. In the **GraphQL admin IDE**, after choosing the `vtex.messages` app, write the following query command in the text box that is displayed:\n\n`1\n\nquery GetTranslation($args: TranslateWithDependenciesArgs!) { \n\n2\n\n translateWithDependencies(args: $args) \n\n3\n\n} \n\n`\n\n1. Then, click on _Query Variables_ at the bottom of the page.\n2. To fill in the _Query Variables_ box, you must provide the following parameters:\n* `from`: source message locale.\n* `messages`: a list of the messages you want to check translations, containing the following parameters: \n * `content`: the `id` of your message string declared in the app's `messages` folder. \n * `context`: the name of the storefront app that declared the message being overwritten.\n* `to`: target translation locale.\n* `depTree`: the dependency tree as in `\"[{\\\"id\\\": \\\"{context}\\\"}]\"`.\n\nTake the following example:\n\n`1\n\n{ \n\n2\n\n\"args\": { \n\n3\n\n \"indexedByFrom\": [ \n\n4\n\n { \n\n5\n\n \"from\": \"en-DV\", \n\n6\n\n \"messages\": [ \n\n7\n\n { \n\n8\n\n \"content\": \"store/search.placeholder\", \n\n9\n\n \"context\": \"vtex.store-components@3.x\" \n\n10\n\n } \n\n11\n\n ] \n\n12\n\n } \n\n13\n\n ], \n\n14\n\n \"to\": \"en-US\", \n\n15\n\n \"depTree\": \"[{\\\"id\\\": \\\"vtex.store-components@3.x\\\"}]\" \n\n16\n\n } \n\n17\n\n} \n\n`\n\n1. After adjusting your query, click the play button to run it. The expected response is the translated message in the target locale.\n\nFor the given example, the expected response is as follows:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"translateWithDependencies\": [ \n\n4\n\n \"My personalized Search message\" \n\n5\n\n ] \n\n6\n\n } \n\n7\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/Storefront-Guides/vtex-io-multi-language-stores/storefront-content-internationalization.md)\n\n[Disabling automatic translation« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization//docs/guides/vtex-io-documentation-disabling-automatic-translation)[Translating Catalog contentNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization//docs/guides/catalog-internationalization)\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/storefront-content-internationalization/docs/guides/storefront-content-internationalization%23instructions)\n\n[Checking your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization%23checking-your-changes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-multi-language-stores/storefront-content-internationalization.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/storefront-content-internationalization/docs/guides/storefront-content-internationalization%23instructions)\n\n[Checking your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-content-internationalization/docs/guides/storefront-content-internationalization%23checking-your-changes)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4b370f85
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides affiliates program app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/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/affiliates-program-app/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.session-client)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/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/affiliates-program-app/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/affiliates-program-app/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/guides/functional-apps)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/guides/affiliates-program-app)\n\nAffiliates Program\n\n> For the **Affiliates Program app**, an affiliate is different from the standard definition of [affiliate in VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/o-que-e-afiliado--4bN3e1YarSEammk2yOeMc0). In the app's context, an affiliate is anyone who associates with a VTEX store to promote sales while receiving a commission.\n\nThe [Affiliates Program app](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/aplicativo-affiliates-program--7IpHHHcjjWxdmSRMw1FMPQ) creates a specific URL of your VTEX store for each of your affiliates, and every URL is targeted with a parameter that identifies the affiliate. When an affiliate shares their URL with shoppers, and they buy something through that link, the affiliate earns a commission over sales.\n\nThe image below is an example of an affiliate’s page to be shared with shoppers:\n\n\n\nThe app also creates a profile page for the affiliate to keep track of orders and commissions, as you will see in the next section. Affiliates do not need access to your VTEX store Admin in order to access their profile page, which looks like the following image:\n\n\n\nThe **Affiliates Program app’s** main characteristics and behavior are the following:\n\n* The app [provides pages and dashboards](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/aplicativo-affiliates-program--7IpHHHcjjWxdmSRMw1FMPQ%23vtex-admin-pages) in your VTEX Admin, allowing your store to manage affiliates, orders, and commissions.\n* The merchant using a VTEX store can register an affiliate by filling out a form. More information on the next section.\n* The merchant using a VTEX store configures a default affiliates’ commission percentage over all products. It is possible to configure a specific commission for an SKU, and that configuration is prioritized over the default value.\n* The [affiliates’ URLs can be customized](#affiliates-pages-customization) to show specific products and guide the customer’s user experience.\n\n### Affiliates Program in VTEX Admin\n\nAfter installing and configuring the app, you will find three pages in your VTEX Admin:\n\n* [Affiliate Management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/aplicativo-affiliates-program--7IpHHHcjjWxdmSRMw1FMPQ%23affiliate-management): allows you to add new affiliates and manage the existing ones. You can add a new affiliate by clicking on the button `Add affiliate` and filling out the form.\n\n\n\n* [Orders Management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/aplicativo-affiliates-program--7IpHHHcjjWxdmSRMw1FMPQ%23order-management): provides information about affiliates’ orders. The page enables you to filter data in multiple ways and export it via email. \n\n* [Commissions Management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/aplicativo-affiliates-program--7IpHHHcjjWxdmSRMw1FMPQ%23commission-management): allows you to manage affiliates’ commissions and import information using files with . CSV or . XLSX extension. \n\n\n## Compatibility\n\nThe Affiliates Program app is compatible only with stores using [VTEX IO](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/4yB9wSl79cArd68aRBnBZ2), so make sure you fit the criteria. Stores using [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj) or [Headless CMS](https://read.calvincode.net/reader?url=https://www.faststore.dev/docs/headless-cms-overview) are not compatible.\n\n## Installation\n\nTo install the Affiliates Program app, follow the steps below:\n\n1. In the VTEX App Store, log into your VTEX store’s account.\n2. Go to the [Affiliates Program app](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-affiliates/p) page.\n3. Click on `GET APP`.\n4. In your cart in the VTEX App Store, click on `PLACE ORDER`.\n5. Click on `GO TO INSTALL PAGE`.\n6. In the VTEX Admin, click on `INSTALL`.\n\nThe app settings will appear in your VTEX Admin under _Other > Affiliates_, and you will see a page like the image below:\n\n> If using the [New VTEX Admin](https://read.calvincode.net/reader?url=https://content.vtex.com/join-new-admin-beta-program-en/), you will find the app settings under _Apps > Affiliates_.\n\n\n\nIn **Settings**, you will define for how long the lead will be valid and set a default commission percentage. To do so, follow the steps below:\n\n1. Fill in the **Lead duration in days** field with the number of days you wish to configure the lead. It is the lead that sets the priority of an affiliate to receive commissions. \n> Every affiliate has its own unique identification code, which is the `Affiliate ID` . When a shopper buys something through the affiliate's URL, the `Affiliate ID` is linked to the shopper for the period configured in this step - 60 days by default. If within the lead duration that shopper makes a second purchase, whether by accessing the store in an organic way, or through another affiliate's URL, the `Affiliate ID` of the first affiliate is prioritized and ensures commission. Note that the `Affiliate ID` for the app's context is not the `Affiliate ID` in the standard definition of [affiliate in VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/o-que-e-afiliado--4bN3e1YarSEammk2yOeMc0).\n2. Fill in the **Default value to be used for sku commission** field with the percentual you want to set to determine the affiliates’ commission over sales. Use numbers only, decimals are not allowed.\n3. Click on `SAVE`.\n\nThe following message will be displayed:\n\n> _Your information was submitted successfully._\n\n## Configuration\n\nYou will need to access your VTEX store’s code to set up the app and the affiliate’s URL, as shown in the following sections.\n\n### Set up the Affiliates Program app\n\nOpen your store's **Store Theme** app directory in your code editor and add the Affiliates Program app to your theme's `manifest.json` file inside `peerDependencies` , as shown below:\n\n`1\n\n\"peerDependencies\": { \n\n2\n\n \"vtex.affiliates\": \"1.x\" \n\n3\n\n } \n\n`\n\nWhen you add the Affiliates Program app as a dependency, the app exports theme blocks used to create pages on the storefront: `affiliate` , `affiliate-profile` , and `affiliate-form` . These pages will be available with a default layout:\n\n* **Affiliate’s page:** the page the affiliate sends to shoppers based on your VTEX store storefront. The URL is `{storeName.com}/affiliates/{affiliateSlug}`.\n* **Affiliates profile page:** a page where the affiliate can see orders made through their URL and analyze a dashboard with different metrics. The URL is `{storeName.com}/affiliates/{affiliateSlug}/profile`.\n* **Affiliate’s form:** a page with a form to be filled by anyone who wants to become an affiliate. The URL is `{storeName.com}/affiliate/form`.\n\nTo access the first two pages, you will have to configure an affiliate to be able to replace `{affiliateSlug}` with a valid slug.\n\n### Set up a shareable URL\n\nFor the affiliate to be able to share their URL, you will need to add the `affiliate-url-monitoring` block into the header of your theme. That block seeks parameters with a valid affiliate slug to add the affiliate’s information to the purchase.\n\nTo do so, check out the example below:\n\nAfter that, the affiliate will share a URL with the parameter **targeting** with their slug as value so that the affiliate’s information is associated with the sale. See an example in the table below:\n\n| Example URL | Behavior |\n| --------------------------------------------------- | ------------------------------------------------------------------------------------------ |\n| https://storeName.com/product/p | URL without the **targeting** parameter, which does not identify the affiliate. |\n| https://storeName/product/p?targeting=affiliateName | URL with the **targeting** parameter, which links the shopper’s purchase to the affiliate. |\n\n \nIt is possible to change the parameter property used for the affiliate to share the URL by changing the code in [props](#props). You can also change it in VTEX Admin, by accessing _CMS > [Site Editor](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/site-editor-overview--299Dbeb9mFczUTyNQ9xPe1) \\> Blocks > Affiliate Monitoring_ and editing the `Parameter` field, as shown in the image below:\n\n> If using the [New VTEX Admin](https://read.calvincode.net/reader?url=https://content.vtex.com/join-new-admin-beta-program-en/), go to _Storefront > Site Editor > Blocks > Affiliate Monitoring_.\n\n\n\n## Advanced configurations\n\nYou can customize the appearance and content of the affiliate’s page - `{storeName.com}/affiliates/{affiliateSlug}` , as explained in the next sections:\n\n* [Affiliate’s page customization](#affiliates-pages-customization)\n* [Props](#props)\n* [CSS customization](#css-customization)\n\n### Affiliate’s pages customization\n\nThe default implementation of the affiliate’s page is the following:\n\n| Block | Route |\n| -------------------------- | ------------------------ |\n| store.affiliates interface | /affiliates/:slug |\n| store.affiliates-profile | affiliates/:slug/profile |\n| store.affiliate-form | affiliate/form |\n\nTo customize these pages, follow the steps below:\n\n1. Open your store's **Store Theme** app directory in your code editor.\n2. Go to `store/blocks`.\n3. Create the following files: \n * `affiliates.jsonc` \n * `affiliates-profile.jsonc` \n * `affiliates-form.jsonc`\n4. Copy the respective block’s code – you will find them below.\n**affiliates.jsonc code**\n\n```\n\n{\n\"store.affiliates\": {\n\"blocks\": [\"affiliate-validator\"]\n},\n\"affiliate-validator\": {\n\"props\": {\n\"Valid\": \"affiliate-template\",\n\"Invalid\": \"affiliate-invalid-template\"\n}\n},\n\"affiliate-template\": {\n\"children\": [\n\"affiliate-store-name\",\n\"flex-layout.row#banner\",\n\"affiliate-profile-button\",\n\"search-result-layout.customQuery#affiliate\"\n]\n},\n\"flex-layout.row#banner\": {\n\"children\": [\"image#affiliate-banner\"]\n},\n\"image#affiliate-banner\": {\n\"props\": {\n\"src\": \"https://upload.wikimedia.org/wikipedia/commons/thumb/a/a9/VTEX_Logo.svg/400px-VTEX_Logo.svg.png\"\n}\n},\n\"search-result-layout.customQuery#affiliate\": {\n\"props\": {\n\"querySchema\": {\n\"skusFilter\": \"ALL_AVAILABLE\",\n\"simulationBehavior\": \"default\",\n\"queryField\": \"137\",\n\"mapField\": \"productClusterIds\",\n\"facetsBehavior\": \"Dynamic\"\n}\n},\n\"blocks\": [\n\"search-result-layout.desktop\",\n\"search-result-layout.mobile\",\n\"search-not-found-layout\"\n]\n},\n\"affiliate-invalid-template\": {\n\"children\": [\"rich-text#invalid-affiliate\"]\n},\n\"rich-text#invalid-affiliate\": {\n\"props\": {\n\"textAlignment\": \"CENTER\",\n\"textPosition\": \"CENTER\",\n\"text\": \"Affiliate does not exist or has not been approved\",\n\"font\": \"t-heading-1\"\n}\n}\n}\n\n\n```\n\n**affiliates-profile.jsonc code**\n\n```\n\n{\n\"store.affiliates-profile\": {\n\"children\": [\"affiliate-profile\"]\n},\n\"affiliate-profile\": {\n\"children\": [\"affiliate-profile-topbar\", \"affiliate-profile-validator\"]\n},\n\"affiliate-profile-validator\": {\n\"props\": {\n\"Valid\": \"flex-layout.row#profile\",\n\"Invalid\": \"rich-text#profileerror\"\n}\n},\n\"rich-text#profileerror\": {\n\"props\": {\n\"text\": \"### Faça o login com a conta correta do afiliado para acessar as informações\",\n\"textAlignment\": \"CENTER\",\n\"textPosition\": \"CENTER\"\n}\n},\n\"flex-layout.row#profile\": {\n\"children\": [\"flex-layout.col#profile\"]\n},\n\"flex-layout.col#profile\": {\n\"children\": [\n\"affiliate-profile-title\",\n\"affiliate-profile-totalizer\",\n\"affiliate-profile-table\"\n]\n}\n}\n\n\n```\n\n**store.affiliate-form.jsonc code**\n\n```\n\n{\n\"store.affiliate-form\": {\n\"children\": [\"affiliate-form\"]\n}\n}\n\n\n```\n\n1. Paste the code in the corresponding file. For example, paste the `store.affiliates` JSON in the `affiliates.jsonc` file.\n2. Customize the code as you wish.\n3. Repeat steps 4 to 6 for each of the three blocks.\n4. Deploy the changes.\n\n### Props\n\nYou will have to configure two specific component types with props for them to work correctly.\n\n`affiliate-validator` and `affiliate-profile-validator props`\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------------------------- | -------------------------- |\n| valid | string | Set the block name that will be rendered if the affiliate is valid. | affiliate-template |\n| invalid | string | Set the block name that will be rendered if the affiliate is invalid. | affiliate-invalid-template |\n\n`affiliate_url_monitoring` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | -------------------------------------------------------------------------- | ------------- |\n| parameter | string | Parameter name that will be used to validate the URL the affiliate shared. | targeting |\n\n### CSS customization\n\nIf you wish to apply CSS customizations to the Affiliates Program app blocks, check out [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| affiliateStoreName |\n| affiliateProfileTitle |\n| profileButtonContainer |\n\n## Email templates\n\nThe Affiliates Program app allows your VTEX store to export spreadsheets with information about the affiliates' orders and commissions. Exported spreadsheets will be sent via email to the VTEX Admin [user](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/managing-users--tutorials%5F512).\n\nFor this configuration, you need to create two email templates on the [Message Center](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/understanding-the-message-center--tutorials%5F84):\n\n* Affiliate Orders Export Template\n* Commissions By Sku Export Template\n\nTo create a new custom email template, follow the steps below:\n\n1. In your VTEX Admin, go to _Customer > Message Center > Templates_.\n2. Click on the `New Template` button.\n3. Check the `Enable sending emails` flag.\n4. Fill in the fields that appear. \n> You can use the image below as a reference, but use your information.\n\n\n\n 5\\. Copy the **Affiliate Orders Export Template** code - you will find it below. 6\\. Paste it in the `Html` section. 7\\. Change it as you wish. > You can scroll down the page to check the preview. \n1. Click on `Save`.\n\nAfter creating the _Affiliate Orders Export Template_, repeat the process to create the _Commissions By Sku Export Template_. Use the image below as an example for step 4\\. On step 5, copy the **Commissions By Sku Export Template** code, which can be found at the end of this section.\n\n\n\n**Affiliate Orders Export Template**\n\n`1\n\n <!DOCTYPE html> \n\n2\n\n<html lang=\"pt-br\"> \n\n3\n\n \n4\n\n<head> \n\n5\n\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"> \n\n6\n\n <meta name=\"viewport\" content=\"initial-scale=1.0\"> \n\n7\n\n \n8\n\n <meta name=\"format-detection\" content=\"telephone=no\"> \n\n9\n\n \n10\n\n <title>{{_accountInfo.TradingName}}</title> \n\n11\n\n <style type=\"text/css\"> \n\n12\n\n p { \n\n13\n\n font-family: Fabriga, -apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue, helvetica, ubuntu, roboto, noto, segoe ui, arial, sans-serif; \n\n14\n\n }; \n\n15\n\n .vtex-button { \n\n16\n\n border-width: .125rem; \n\n17\n\n border-style: solid; \n\n18\n\n font-weight: 500; \n\n19\n\n vertical-align: middle; \n\n20\n\n padding: 0; \n\n21\n\n line-height: 1; \n\n22\n\n border-radius: .25rem; \n\n23\n\n min-height: 2.5rem; \n\n24\n\n box-sizing: border-box; \n\n25\n\n font-family: Fabriga, -apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue, helvetica, ubuntu, roboto, noto, segoe ui, arial, sans-serif; \n\n26\n\n font-size: 1rem; \n\n27\n\n text-transform: uppercase; \n\n28\n\n letter-spacing: 0; \n\n29\n\n background-color: #134cd8; \n\n30\n\n border-color: #134cd8; \n\n31\n\n color: #fff; \n\n32\n\n cursor: pointer; \n\n33\n\n }; \n\n34\n\n </style> \n\n35\n\n</head> \n\n36\n\n \n37\n\n<body marginwidth=\"0\" marginheight=\"0\" bgcolor=\"#fff\" style=\"padding:0px 0px;color:#333;\" leftmargin=\"0\" topmargin=\"0\"> \n\n38\n\n \n39\n\n <table width=\"100%\" height=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" align=\"left\" valign=\"top\"> \n\n40\n\n <tbody> \n\n41\n\n <tr> \n\n42\n\n <td align=\"center\" valign=\"top\"> \n\n43\n\n <table width=\"100%\" style=\"max-width: 36rem;\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" \n\n44\n\n border=\"0\" valign=\"top\"> \n\n45\n\n <tbody> \n\n46\n\n <tr> \n\n47\n\n <td> \n\n48\n\n <div \n\n49\n\n style=\"border:1px solid #e3e4e6;border-radius:8px;margin-top:1rem;margin-bottom:1rem;padding-top:3rem;padding-right:3rem;padding-bottom:3rem;padding-left:3rem\"> \n\n50\n\n <img src=\"https://master--qamarketplace.myvtex.com/_v/public/assets/v1/published/vtex.messages-templates@0.1.12/public/react/cdbfb2a8b730a7ee840752d7af7ddc1c.png\" \n\n51\n\n width=\"77px\" height=\"28px\" \n\n52\n\n style=\"display:block;outline:none;border:none;text-decoration:none\" \n\n53\n\n class=\"CToWUd\" /> \n\n54\n\n <p style=\"font-size:24px;color:#25354d;margin-bottom:32px\"> \n\n55\n\n <strong>Planilha de pedidos de afiliados exportada</strong></p> \n\n56\n\n <p style=\"font-size:16px;color:#3f3f40;margin-bottom:32px\"> \n\n57\n\n Olá,</p> \n\n58\n\n <p style=\"font-size:16px;color:#3f3f40\"> \n\n59\n\n Segue o link para baixar a planilha pedidos de afiliados. \n\n60\n\n </p> \n\n61\n\n <div style=\"margin-bottom: 24px\"> \n\n62\n\n <a href=\"{{link}}\" download> \n\n63\n\n <button \n\n64\n\n style=\"border-width: .125rem; border-style: solid; font-weight: 500; vertical-align: middle; padding: 0; line-height: 1; border-radius: .25rem; min-height: 2.5rem; box-sizing: border-box; font-family: Fabriga, -apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue, helvetica, ubuntu, roboto, noto, segoe ui, arial, sans-serif; font-size: 1rem; text-transform: uppercase; letter-spacing: 0; background-color: #134cd8; border-color: #134cd8; color: #fff; cursor: pointer;\" \n\n65\n\n type=\"button\"> \n\n66\n\n <div style=\"display: flex; align-items: center; justify-content: center; height: 100%; padding-left: 1.5rem; padding-right: 1.5rem; padding-top: 0.25rem; padding-bottom: 0.25rem;\"> \n\n67\n\n Baixar Planilha \n\n68\n\n </div> \n\n69\n\n </button> \n\n70\n\n </a> \n\n71\n\n </div> \n\n72\n\n <p style=\"margin-bottom:4px;font-size:16px;color:#3f3f40\"> \n\n73\n\n Abraços,</p> \n\n74\n\n <p style=\"margin-top:0px;font-size:16px;color:#3f3f40\"> \n\n75\n\n VTEX</p><br /> \n\n76\n\n <p style=\"font-size:12px;color:#727273;margin-bottom:0px\"> \n\n77\n\n O link para download é válido por 24 horas. Após esse tempo, será necessário realizar a exportação novamente. \n\n78\n\n </p> \n\n79\n\n <div \n\n80\n\n style=\"color:#e3e4e6;border-top:1px solid #e3e4e6;border-bottom:0px solid #e3e4e6;margin-bottom:2rem;margin-top:1rem\"> \n\n81\n\n </div> \n\n82\n\n <p style=\"font-size:12px;color:#727273;margin-bottom:0px\"> \n\n83\n\n Esse email é enviado automaticamente e não recebe respostas. \n\n84\n\n </p> \n\n85\n\n <p style=\"font-size:12px;color:#727273;margin-top:.25rem;margin-bottom:0px\"> \n\n86\n\n Precisa de ajuda? <a href=\"https://help.vtex.com/?locale=pt\" alt=\"VTEX Help\" \n\n87\n\n style=\"font-weight:bold;color:#3F3F40\">Fale Conosco</a> \n\n88\n\n </p><br /> \n\n89\n\n <p style=\"font-size:12px;color:#727273;margin-bottom:0px\"> \n\n90\n\n © VTEX Praia de Botafogo, 300, 3º Andar, Botafogo, Rio de Janeiro, RJ, \n\n91\n\n 22250-040 \n\n92\n\n </p> \n\n93\n\n </div> \n\n94\n\n </td> \n\n95\n\n </tr> \n\n96\n\n </tbody> \n\n97\n\n </table> \n\n98\n\n </td> \n\n99\n\n </tr> \n\n100\n\n </tbody> \n\n101\n\n </table> \n\n102\n\n \n103\n\n \n104\n\n</body> \n\n105\n\n</html> \n\n`\n\n \n**Commissions By Sku Export Template**\n\n`1\n\n<!DOCTYPE html> \n\n2\n\n<html lang=\"pt-br\"> \n\n3\n\n \n4\n\n<head> \n\n5\n\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=UTF-8\"> \n\n6\n\n <meta name=\"viewport\" content=\"initial-scale=1.0\"> \n\n7\n\n \n8\n\n <meta name=\"format-detection\" content=\"telephone=no\"> \n\n9\n\n \n10\n\n <title>{{_accountInfo.TradingName}}</title> \n\n11\n\n <style type=\"text/css\"> \n\n12\n\n p { \n\n13\n\n font-family: Fabriga, -apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue, helvetica, ubuntu, roboto, noto, segoe ui, arial, sans-serif; \n\n14\n\n }; \n\n15\n\n .vtex-button { \n\n16\n\n border-width: .125rem; \n\n17\n\n border-style: solid; \n\n18\n\n font-weight: 500; \n\n19\n\n vertical-align: middle; \n\n20\n\n padding: 0; \n\n21\n\n line-height: 1; \n\n22\n\n border-radius: .25rem; \n\n23\n\n min-height: 2.5rem; \n\n24\n\n box-sizing: border-box; \n\n25\n\n font-family: Fabriga, -apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue, helvetica, ubuntu, roboto, noto, segoe ui, arial, sans-serif; \n\n26\n\n font-size: 1rem; \n\n27\n\n text-transform: uppercase; \n\n28\n\n letter-spacing: 0; \n\n29\n\n background-color: #134cd8; \n\n30\n\n border-color: #134cd8; \n\n31\n\n color: #fff; \n\n32\n\n cursor: pointer; \n\n33\n\n }; \n\n34\n\n </style> \n\n35\n\n</head> \n\n36\n\n \n37\n\n<body marginwidth=\"0\" marginheight=\"0\" bgcolor=\"#fff\" style=\"padding:0px 0px;color:#333;\" leftmargin=\"0\" topmargin=\"0\"> \n\n38\n\n \n39\n\n <table width=\"100%\" height=\"100%\" cellpadding=\"0\" cellspacing=\"0\" border=\"0\" align=\"left\" valign=\"top\"> \n\n40\n\n <tbody> \n\n41\n\n <tr> \n\n42\n\n <td align=\"center\" valign=\"top\"> \n\n43\n\n <table width=\"100%\" style=\"max-width: 36rem;\" align=\"center\" cellpadding=\"0\" cellspacing=\"0\" \n\n44\n\n border=\"0\" valign=\"top\"> \n\n45\n\n <tbody> \n\n46\n\n <tr> \n\n47\n\n <td> \n\n48\n\n <div \n\n49\n\n style=\"border:1px solid #e3e4e6;border-radius:8px;margin-top:1rem;margin-bottom:1rem;padding-top:3rem;padding-right:3rem;padding-bottom:3rem;padding-left:3rem\"> \n\n50\n\n <img src=\"https://master--qamarketplace.myvtex.com/_v/public/assets/v1/published/vtex.messages-templates@0.1.12/public/react/cdbfb2a8b730a7ee840752d7af7ddc1c.png\" \n\n51\n\n width=\"77px\" height=\"28px\" \n\n52\n\n style=\"display:block;outline:none;border:none;text-decoration:none\" \n\n53\n\n class=\"CToWUd\" /> \n\n54\n\n <p style=\"font-size:24px;color:#25354d;margin-bottom:32px\"> \n\n55\n\n <strong>Planilha de comissionamento por SKU exportada</strong></p> \n\n56\n\n <p style=\"font-size:16px;color:#3f3f40;margin-bottom:32px\"> \n\n57\n\n Olá,</p> \n\n58\n\n <p style=\"font-size:16px;color:#3f3f40\"> \n\n59\n\n Segue o link para baixar a planilha de comissionamento por SKU. \n\n60\n\n </p> \n\n61\n\n <div style=\"margin-bottom: 24px\"> \n\n62\n\n <a href=\"{{link}}\" download> \n\n63\n\n <button \n\n64\n\n style=\"border-width: .125rem; border-style: solid; font-weight: 500; vertical-align: middle; padding: 0; line-height: 1; border-radius: .25rem; min-height: 2.5rem; box-sizing: border-box; font-family: Fabriga, -apple-system, BlinkMacSystemFont, avenir next, avenir, helvetica neue, helvetica, ubuntu, roboto, noto, segoe ui, arial, sans-serif; font-size: 1rem; text-transform: uppercase; letter-spacing: 0; background-color: #134cd8; border-color: #134cd8; color: #fff; cursor: pointer;\" \n\n65\n\n type=\"button\"> \n\n66\n\n <div style=\"display: flex; align-items: center; justify-content: center; height: 100%; padding-left: 1.5rem; padding-right: 1.5rem; padding-top: 0.25rem; padding-bottom: 0.25rem;\"> \n\n67\n\n Baixar Planilha \n\n68\n\n </div> \n\n69\n\n </button> \n\n70\n\n </a> \n\n71\n\n </div> \n\n72\n\n <p style=\"margin-bottom:4px;font-size:16px;color:#3f3f40\"> \n\n73\n\n Abraços,</p> \n\n74\n\n <p style=\"margin-top:0px;font-size:16px;color:#3f3f40\"> \n\n75\n\n VTEX</p><br /> \n\n76\n\n <p style=\"font-size:12px;color:#727273;margin-bottom:0px\"> \n\n77\n\n O link para download é válido por 24 horas. Após esse tempo, será necessário realizar a exportação novamente. \n\n78\n\n </p> \n\n79\n\n <div \n\n80\n\n style=\"color:#e3e4e6;border-top:1px solid #e3e4e6;border-bottom:0px solid #e3e4e6;margin-bottom:2rem;margin-top:1rem\"> \n\n81\n\n </div> \n\n82\n\n <p style=\"font-size:12px;color:#727273;margin-bottom:0px\"> \n\n83\n\n Esse email é enviado automaticamente e não recebe respostas. \n\n84\n\n </p> \n\n85\n\n <p style=\"font-size:12px;color:#727273;margin-top:.25rem;margin-bottom:0px\"> \n\n86\n\n Precisa de ajuda? <a href=\"https://help.vtex.com/?locale=pt\" alt=\"VTEX Help\" \n\n87\n\n style=\"font-weight:bold;color:#3F3F40\">Fale Conosco</a> \n\n88\n\n </p><br /> \n\n89\n\n <p style=\"font-size:12px;color:#727273;margin-bottom:0px\"> \n\n90\n\n © VTEX Praia de Botafogo, 300, 3º Andar, Botafogo, Rio de Janeiro, RJ, \n\n91\n\n 22250-040 \n\n92\n\n </p> \n\n93\n\n </div> \n\n94\n\n </td> \n\n95\n\n </tr> \n\n96\n\n </tbody> \n\n97\n\n </table> \n\n98\n\n </td> \n\n99\n\n </tr> \n\n100\n\n </tbody> \n\n101\n\n </table> \n\n102\n\n \n103\n\n \n104\n\n</body> \n\n105\n\n \n106\n\n</html> \n\n`\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/functional-apps/affiliates-program-app.md)\n\n[Assembly Options« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app//docs/guides/assembly-options-app)[Layout AppsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app//docs/guides/layout-apps)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Compatibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23compatibility)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23configuration)\n\n[Set up the Affiliates Program app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23set-up-the-affiliates-program-app)[Set up a shareable URL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23set-up-a-shareable-url)\n\n[Advanced configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23advanced-configurations)\n\n[Affiliate’s pages customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23affiliates-pages-customization)[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23props)[CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23css-customization)\n\n[Email templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23email-templates)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/functional-apps/affiliates-program-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Compatibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23compatibility)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23configuration)\n\n[Set up the Affiliates Program app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23set-up-the-affiliates-program-app)[Set up a shareable URL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23set-up-a-shareable-url)\n\n[Advanced configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23advanced-configurations)\n\n[Affiliate’s pages customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23affiliates-pages-customization)[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23props)[CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23css-customization)\n\n[Email templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/affiliates-program-app/docs/guides/affiliates-program-app%23email-templates)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_6e5dd6b8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides erp integration set up order processing in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides)\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-guide)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing)\n\nSet up order processing\n\nIn this step, you will send order updates from your ERP or WMS to VTEX.\n\n## Before you begin\n\nWhen an order is processed in an external fulfillment platform such as an ERP or WMS, it's not enough to set up order integration. VTEX should also receive order updates when applicable.\n\nDuring handling an order can be [changed](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/change-making-changes-to-an-order--3d1XLIgPQcwaKGyMiWaYog?locale=en), [cancelled](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/4ts2ItvjYo8wm5gg76miS3) or [invoiced](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/orders--2xkTisx4SXOWXQel8Jg8sa/2WgQrlHTyVo4hLjhUs1LMT). These events should be notified as illustrated in the diagram below.\n\n\n\nIf your freight carrier is integrated with VTEX, all you need to do is inform its identifier and tracking number when invoicing the order and order tracking information will be set up. Otherwise you should add the order tracking updates you want customers to see separately, as seen in the diagram below.\n\n\n\n## Change order\n\nChanging items is a feature that allows your store to modify the items or prices of an order. With this feature, the store can handle eventual changes in orders motivated by customer mistakes, product unavailability, and the inclusion of discounts, among other things. 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%23).\n\nCheck this [Change order guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order) to learn how you can implement this feature to your integration.\n\n## Change seller\n\nIf your store is a marketplace, your integration must also be prepared to change which seller is assigned to fulfill a given order. Learn more about the circumstances and limitations of this type of process in the article [How to use the Change Seller feature](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-use-the-change-seller-feature--5TBAwO2kOAMw44uyaaQMQO%23).\n\nTo learn how to implement this in your integration, check the [Change seller integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-seller).\n\n## Cancel order\n\nThe [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint in the Orders API allows you to cancel an order. Optionally, you can add more information by creating a note in the order timeline using the [Create note](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api%23post-/notes) endpoint in the VTEX DO API.\n\nThe order cancellation can be confirmed through the orders feed.\n\n> Keep in mind that the OMS [order flow](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/order-flow-on-the-oms--tutorials%5F196) does not allow an order to be cancelled after it has been invoiced and that order cancellations cannot be reversed.\n\n## Invoice order\n\nThe [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) endpoint in the Orders API allows you to notify VTEX that you are ready to ship the order and add invoice information to the order.\n\n> Note that invoice information includes tracking number and URL. However this is not required to send the invoice to VTEX. It may be added later.\n\n## Order tracking\n\nOrder tracking information is directly related to an order's invoice. An order's tracking number and URL may be sent to VTEX when [first invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/invoice), or later, with the [Update order's partial invoice API request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23patch-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-).\n\n### Tracking messages\n\nOnce an order was invoiced and has their tracking number and URL, if the designated carrier is integrated with VTEX, VTEX can log tracking messages and send them to your customers. If your freight carrier is not integrated with VTEX, you should add the tracking messages using the [Update order tracking status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23put-/api/oms/pvt/orders/-orderId-/invoice/-invoiceNumber-/tracking) endpoint of the Orders API.\n\n## Wrapping up\n\nIf you have done things correctly, you should have set up order processing. This includes sending notifications to VTEX when orders are changed, cancelled or invoiced, as well as when tracking updates are available from non-integrated freight carriers.\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/erp-integration-guide/erp-integration-set-up-order-processing.md)\n\n[Import products« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing//docs/guides/erp-integration-import-products)[Update or delete informationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing//docs/guides/erp-integration-updating-and-deleting-information)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23before-you-begin)\n\n[Change order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23change-order)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23cancel-order)\n\n[Invoice order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23invoice-order)\n\n[Order tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23order-tracking)\n\n[Tracking messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23tracking-messages)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23wrapping-up)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/erp-integration-set-up-order-processing.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23before-you-begin)\n\n[Change order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23change-order)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23cancel-order)\n\n[Invoice order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23invoice-order)\n\n[Order tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23order-tracking)\n\n[Tracking messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23tracking-messages)\n\n[Wrapping up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-processing/docs/guides/erp-integration-set-up-order-processing%23wrapping-up)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_7a6274e1
|
[
{
"role": "system",
"content": "You are a VTEX 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 1 developnativeintegrationswithpixelapps in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/docs/api-reference)\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-1-developnativeintegrationswithpixelapps/docs/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-1-developnativeintegrationswithpixelapps/docs/storefront-development)\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-1-developnativeintegrationswithpixelapps/docs/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-1-developnativeintegrationswithpixelapps/docs/troubleshooting)\n\n[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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-pixel-app)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n\n[2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\n[3\\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n\n[4\\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)\n\n[5\\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-6-listeningtostoreevents)\n\n[6\\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n\n[7\\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\n[What is a Pixel app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-pixel-app)\n\n[1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n\n[2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n\n[3\\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n\n[4\\. Writing the head and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)\n\n[5\\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-6-listeningtostoreevents)\n\n[6\\. Structuring the documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n\n[7\\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/create-master-data-crud-app)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/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-1-developnativeintegrationswithpixelapps/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-getting-started)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps)\n\nPixel apps\n\nIn this tutorial, you'll learn how to create a custom integration with a third-party solution by developing your own [**Pixel app**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app).\n\nPixel apps are responsible for running scripts on all pages of a store website. You can use them to load JavaScript resources into your web pages and extend the core functionalities of your website.\n\n* [Part 1\\. Setting up your development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\n* [Part 2\\. Cloning the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-3-cloningtheboilerplaterepository)\n* [Part 3\\. Configuring your app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-4-configuringyourappsettings)\n* [Part 4\\. Writing the header and body scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-5-writingtheheaderandbodyscripts)\n* [Part 5\\. Listening to store events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-listeningtostoreevents)\n* [Part 6\\. Structuring documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-7-structuringthedocumentation)\n* [Part 7\\. Making your Pixel app publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)\n\n## Before you begin\n\nBefore taking this tutorial, check our [list of Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pixel-apps/) and make sure the integration you're looking for is not already available.\n\nAlso, if you're wondering whether to **create a Pixel app** or **customize an HTML tag with Google Tag Manager**, keep in mind that the first option is always the most recommended. Creating a new app allows for more freedom during development and may also help other users interested in the same solution.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Getting-Started/vtex-io-documentation-1-developnativeintegrationswithpixelapps.md)\n\n[Best practices« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps//docs/guides/vtex-io-documentation-developing-custom-storefront-components)[What is a Pixel appNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps//docs/guides/vtex-io-documentation-pixel-app)\n\nSee also\n\n[1\\. Setting up your development environmentApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-2-basicsetuptodevelopinvtexio)\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-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps%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/Getting-Started/vtex-io-documentation-1-developnativeintegrationswithpixelapps.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-1-developnativeintegrationswithpixelapps/docs/guides/vtex-io-documentation-1-developnativeintegrationswithpixelapps%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_90e47475
|
[
{
"role": "system",
"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 intelligent search events api headless 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/intelligent-search-events-api-headless/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/api-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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/storefront-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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/troubleshooting)\n\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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/intelligent-search-events-api-headless/)\n\nEvents\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/intelligent-search-events-api-headless/)\n\nEvents\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/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/intelligent-search-events-api-headless/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet list of the possible facets for a given query« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/api-reference/intelligent-search-api%23get-/facets/-facets-)[PoSave EventsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless/docs/api-reference/intelligent-search-events-api-headless%23post-/event)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0b1916da
|
[
{
"role": "system",
"content": "You are a VTEX 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 pci dss compliance in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-pci-dss-compliance/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-pci-dss-compliance/docs/api-reference)\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-pci-dss-compliance/docs/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-pci-dss-compliance/docs/storefront-development)\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-pci-dss-compliance/docs/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-pci-dss-compliance/docs/troubleshooting)\n\n[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-pci-dss-compliance/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/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-pci-dss-compliance/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-pci-dss-compliance/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/payments-integration-guide)\n\n[PCI - DSS Compliance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/payments-integration-pci-dss-compliance)\n\nPCI - DSS Compliance\n\nAlthough the Payment Provider Protocol is public, not everyone can simply use it.\n\nTo do so, clients or partners that process payments with credit, debit, and co-branded cards must have the [Payment Card Industry - Data Security Standard certification](https://read.calvincode.net/reader?url=https://www.pcisecuritystandards.org/documents/PCI%5FDSS-QRG-v3%5F2%5F1.pdf) (PCI - DSS). It is an international certification that guarantees that a service can process transactions safely, protecting customers' information.\n\n> An alternative solution for partners that want to process card transactions and do not have a PCI-DSS certification in the developing environment of the connector is to implement Secure Proxy in their integrations. For more information, check the [Secure Proxy article](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-secure-proxy). In VTEX, we only allow clients or partners that configure level 1 in the PCI - DSS certification to integrate into our system. In other words, the partner must process more than six million transactions per year.\n\nIf your provider just processes payments with “boleto bancário”, promissory or any other payment that involves redirect, PCI - DSS certification is not necessary. In this case, the provider can contact the VTEX Sales Team directly to start the integration.\n\n> The PCI-DSS certification is **only** necessary for clients or partners that process payments with **credit**, **debit**, and **co-branded** cards and do not use [Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-secure-proxy) in their integrations.\n\nBy “clients or partners”, we mean the agent that will indeed receive and process the transactions. In some cases, there are clients associated with tech services that develop and offer an affiliation infrastructure, but it does not operate anything. In this case, the one that must be certificated by the PCI - DSS is **the partner that will process the transactions**, not the tech service.\n\n## Self-Assessment Questionnaire (SAQ)\n\nThe [Self-Assessment Questionnaire](https://read.calvincode.net/reader?url=https://www.pcisecuritystandards.org/pci%5Fsecurity/completing%5Fself%5Fassessment) (SAQ) is a list of “yes or no” questions designed to help service providers or merchants report the results of their PCI DSS self-assessment.\n\n> The SAQ (Self-Assessment Questionnaire) is not accepted in the VTEX integration process.\n\n## Attestation of Compliance for Onsite Assessments (AOC)\n\nThe Attestation of Compliance for Onsite Assessments ([AOC](https://read.calvincode.net/reader?url=https://www.pcisecuritystandards.org/document%5Flibrary)) is a document that serves as a declaration of the service provider or merchant’s compliance status with the PCI DSS. It is signed by the responsible for the company and a [QSA](https://read.calvincode.net/reader?url=https://www.pcisecuritystandards.org/assessors%5Fand%5Fsolutions/qualified%5Fsecurity%5Fassessors) (Qualified Security Assessor).\n\nThe provider must forward the AOC (Service Provider version) fully completed to VTEX, observing the following points:\n\n* **Company Name**: the “URL” field (Part 1a.) must be the same as that of the company requesting the integration procedure. If it is filled in with another name (example: a company acquired by another), it will be necessary to send extra documentation that proves the relationship between the companies, and that the PCI DSS evaluated the provider's service URL.\n* **Signature**: document signed by the company representative and the QSA.\n* **Expiration Date**: the validity of the AOC is 1 year after the signing date. The AOC issued more than 11 months ago must not be sent to VTEX, that is, less than 30 days before its expiration date.\n\n> The AOC (Merchant version) is not accepted in the VTEX integration process.\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/payments-integration-pci-dss-compliance.md)\n\n[Antifraud Provider Protocol« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance//docs/guides/how-the-integration-protocol-between-vtex-and-antifraud-companies-works)[Secure ProxyNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance//docs/guides/payments-integration-secure-proxy)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Self-Assessment Questionnaire (SAQ)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/payments-integration-pci-dss-compliance%23self-assessment-questionnaire-saq)\n\n[Attestation of Compliance for Onsite Assessments (AOC)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/payments-integration-pci-dss-compliance%23attestation-of-compliance-for-onsite-assessments-aoc)\n\nWas this helpful?\n\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-pci-dss-compliance.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Self-Assessment Questionnaire (SAQ)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/payments-integration-pci-dss-compliance%23self-assessment-questionnaire-saq)\n\n[Attestation of Compliance for Onsite Assessments (AOC)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-pci-dss-compliance/docs/guides/payments-integration-pci-dss-compliance%23attestation-of-compliance-for-onsite-assessments-aoc)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_5b46572b
|
[
{
"role": "system",
"content": "You are a VTEX 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 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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-an-account-orderform-configuration/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-an-account-orderform-configuration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-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/get-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/get-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/get-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/get-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/get-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/get-an-account-orderform-configuration/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-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/get-an-account-orderform-configuration/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/checkout-api-overview)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-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/get-an-account-orderform-configuration/docs/guides/get-an-account-orderform-configuration)\n\nGet 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 check the following settings applied currently to every orderForm in a specific account:\n\n* `paymentConfiguration`: payment configuration information. \n * ` requiresAuthenticationForPreAuthorizedPaymentOption`: determines whether pre-authorized payments require authentication. \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.\n* `decimalDigitsPrecision`: number of price digits.\n* `minimumValueAccumulated`: minimum cart value.\n* `apps`: apps configuration information. \n * `id`: app ID. \n * `fields`: app fields information. \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\n## Getting an account's orderForm configuration\n\nTo get an account orderForm configuration, you need to use the [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorderformconfiguration) 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\nAfter sending the request, the endpoint will return the response body containing the current account orderForm configuration, as shown in the example below:\n\n`1\n\n{ \n\n2\n\n \"paymentConfiguration\": { \n\n3\n\n \"requiresAuthenticationForPreAuthorizedPaymentOption\": false, \n\n4\n\n \"allowInstallmentsMerge\": null, \n\n5\n\n \"blockPaymentSession\": null, \n\n6\n\n \"paymentSystemToCheckFirstInstallment\": null, \n\n7\n\n \"defaultPaymentSystemToApplyOnUserOrderForm\": null \n\n8\n\n }, \n\n9\n\n \"taxConfiguration\": null, \n\n10\n\n \"minimumQuantityAccumulatedForItems\": 1, \n\n11\n\n \"decimalDigitsPrecision\": 2, \n\n12\n\n \"minimumValueAccumulated\": 0, \n\n13\n\n \"apps\": [ \n\n14\n\n { \n\n15\n\n \"fields\": [ \n\n16\n\n \"cart-extra-context\", \n\n17\n\n \"cart-type\" \n\n18\n\n ], \n\n19\n\n \"id\": \"cart-extra-context\", \n\n20\n\n \"major\": 1 \n\n21\n\n }, \n\n22\n\n { \n\n23\n\n \"fields\": [ \n\n24\n\n \"orderIdMarketplace\", \n\n25\n\n \"paymentIdMarketplace\" \n\n26\n\n ], \n\n27\n\n \"id\": \"marketplace-integration\", \n\n28\n\n \"major\": 1 \n\n29\n\n }, \n\n30\n\n { \n\n31\n\n \"fields\": [ \n\n32\n\n \"marketplacePaymentMethod\" \n\n33\n\n ], \n\n34\n\n \"id\": \"cn-centauro-integration\", \n\n35\n\n \"major\": 1 \n\n36\n\n }, \n\n37\n\n { \n\n38\n\n \"fields\": [ \n\n39\n\n \"quantity\", \n\n40\n\n \"deadlines_1\", \n\n41\n\n \"interestRate\" \n\n42\n\n ], \n\n43\n\n \"id\": \"customer-credit\", \n\n44\n\n \"major\": 1 \n\n45\n\n }, \n\n46\n\n { \n\n47\n\n \"fields\": [ \n\n48\n\n \"affiliateId\" \n\n49\n\n ], \n\n50\n\n \"id\": \"affiliates\", \n\n51\n\n \"major\": 1 \n\n52\n\n } \n\n53\n\n ], \n\n54\n\n \"allowMultipleDeliveries\": false, \n\n55\n\n \"allowManualPrice\": true, \n\n56\n\n \"savePersonalDataAsOptIn\": false, \n\n57\n\n \"maxNumberOfWhiteLabelSellers\": null, \n\n58\n\n \"maskFirstPurchaseData\": null, \n\n59\n\n \"recaptchaValidation\": null, \n\n60\n\n \"maskStateOnAddress\": null \n\n61\n\n} \n\n`\n\nIf you need to update any of your account's orderForm settings, access the [Update an account's orderForm configuration Dev. Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/update-an-account-orderform-configuration).\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-an-account-orderform-configuration.md)\n\n[Configuration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration//docs/guides/configuration-section-api-quick-start-guides)[Updating an account orderForm configurationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration//docs/guides/update-an-account-orderform-configuration)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Getting an account's orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/get-an-account-orderform-configuration%23getting-an-accounts-orderform-configuration)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/get-an-account-orderform-configuration%23error-codes)\n\n[401 - Unauthorized](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/get-an-account-orderform-configuration%23401-unauthorized)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/get-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/get-an-account-orderform-configuration.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting an account's orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/get-an-account-orderform-configuration%23getting-an-accounts-orderform-configuration)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/get-an-account-orderform-configuration%23error-codes)\n\n[401 - Unauthorized](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/get-an-account-orderform-configuration%23401-unauthorized)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-an-account-orderform-configuration/docs/guides/get-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_46fe52cb
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX session client session client graphql api app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client)\n\n[Session Client GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/functional-apps)\n\n[AB Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtexarg.abtester)\n\n[Abandoned Cart Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.abandoned-cart-service)\n\n[Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.badges)\n\n[Broadcaster](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.broadcaster)\n\n[Catalog Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.catalog-images)\n\n[Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.checkout-ui-custom)\n\n[Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.checkout-ui-settings)\n\n[Messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.messages)\n\n[Product Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.product-context)\n\n[Pickup point selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtexbr.pickup-selector)\n\n[Rewriter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.rewriter)\n\n[Responsive Values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.responsive-values)\n\n[Search GraphQL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.search-graphql)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client)\n\n[Session Client GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api)\n\n[Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.store-icons)\n\n[Store Sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.store-sitemap)\n\n[VTEX Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.telemarketing)\n\n[Assembly Options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/assembly-options-app)\n\n[Affiliates Program](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/affiliates-program-app)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/vtex-io-apps)\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/guides/functional-apps)\n\n[Session Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client)\n\nSession Client GraphQL API\n\n[vtex.session-client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client)\n\nVersion: 1.0.5\n\nLatest version: 1.0.5\n\nThis API manages the [vtex\\_session cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23vtexsession-cookie), which holds session-related data for users. Developers can either interact with the API endpoints directly or declare this app as a dependency to leverage its [React functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client%23react-hooks).\n\n## Schema overview\n\n### Query\n\nsession\n\npossibleType\n\npossibleType\n\nQuery\n\nString version\n\nsession(items \\[String\\]) : Session\n\nSessionError\n\nString type\n\nString message\n\nSessionSuccess\n\nString! id\n\nSessionNamespaces namespaces\n\nSession\n\n| Field | (argument) | Type | Description |\n| ----------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------- |\n| **session** | [Session](#session) | Retrieves the vtex\\_session cookie content if successful. The [Get session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/session-manager-api%23get-/api/sessions) endpoint from the Session Manager API is an equivalent implementation in REST. The Session union has two possible types: SessionError and SessionSuccess. | |\n| items | \\[String\\] | Specifies the items from the vtex\\_session cookie that will be returned in the response. Each string defines the namespace and value of the items, with the \"{namespace}.{value}\" format. If this argument isn't declared, the response will have all the items in the namespace field. Example: \\[\"store.channel\", \"store.countryCode\", \"impersonate.canImpersonate\"\\]. | |\n\n### Mutation\n\nupdateSession\n\npossibleType\n\npossibleType\n\nMutation\n\nupdateSession(fields SessionFieldsJSONInput!, items \\[String\\]) : Session\n\nSessionError\n\nString type\n\nString message\n\nSessionSuccess\n\nString! id\n\nSessionNamespaces namespaces\n\nSession\n\n| Field | (argument) | Type | Description |\n| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **updateSession** | [Session](#session) | Updates fields in the public namespace of the vtex\\_session cookie and returns the updated content. The [Edit session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/session-manager-api%23patch-/api/sessions) endpoint from the Session Manager API is an equivalent implementation in REST. The Session union has two possible types: SessionError and SessionSuccess. | |\n| fields | SessionFieldsJSONInput! | A JSON object with the public fields to be updated. Since this is equivalent to a PATCH request, the request will have the following behavior with this field: Fields that exist in the cookie and aren't declared in this field will not be changed.Fields that exist in the cookie and are declared in this field will have their values updated.Fields that don't exist in the cookie and are declared in this field will be created.Example: { \"foo\": 123, \"baz\": \"abc\" }. | |\n| items | \\[String\\] | Specifies the items from the vtex\\_session cookie that will be returned in the response. Each string defines the namespace and value of the items. If this argument isn't declared, the response will have all the items in the namespace field. Example: \\[\"store.channel\", \"store.countryCode\", \"impersonate.canImpersonate\"\\].Tip: To only show the updated fields in the response, use the public namespace along with the field name. Example: \\[\"public.supportedLocales\"\\]. | |\n\n## Schema description\n\n> Arguments must be provided by the user. Required fields are marked with an exclamation mark (`!`).\n\n### SessionError\n\n| Field | (argument) | Type | Description |\n| ----------- | ---------- | ---------------------- | ----------- |\n| **type** | String | Session error type. | |\n| **message** | String | Session error message. | |\n\n[Session](#session) 🔽\n\n### SessionSuccess\n\n| Field | (argument) | Type | Description |\n| -------------- | ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |\n| **id** | String! | Session ID. | |\n| **namespaces** | SessionNamespaces | Namespaces object with the content of the vtex\\_session cookie. Each namespace has fields with specific information about the session. Check all the possible namespaces in the [Sessions System documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23vtexsession-cookie). | |\n\n[Session](#session) 🔽\n\n### Session\n\n| Type | Description |\n| ------------------------------------- | ------------------------------------------------------------------------------------ |\n| **[SessionError](#sessionerror)** | Returned when a session error occurs. It provides the error type and message. |\n| **[SessionSuccess](#sessionsuccess)** | Returned when the operation succeeds. It includes the content of the session cookie. |\n\n[Query](#query) 🔼\n\n[Mutation](#mutation) 🔼\n\n[Session Client« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client)[Store IconsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.store-icons)\n\nSee also\n\n[Vtex.session ClientVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Schema overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api%23schema-overview)\n\n[Query](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api%23query)[Mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api%23mutation)\n\n[Schema description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api%23schema-description)\n\n[SessionError](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api%23sessionerror)[SessionSuccess](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api%23sessionsuccess)[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.session-client/session-client-graphql-api/docs/apps/vtex.session-client/session-client-graphql-api%23session)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_342e40a7
|
[
{
"role": "system",
"content": "You are a VTEX 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 edition app in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app)\n\n[Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-sponsor-account)\n\n[Becoming a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-becoming-a-sponsor-account)\n\n[Developing an Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-configuring-an-edition-app)\n\n[Updating Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-updating-edition-apps)\n\n[Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/seller-portal-edition-app)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/app-development)\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/managing-edition-apps)\n\n[Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app)\n\nEdition App\n\nLearn what Edition Apps are and how they can streamline the setup of specific VTEX accounts.\n\nAn Edition App represents a bundle of settings, policies, backend, and frontend apps that are encapsulated into a single app. These apps are created and exported by a [Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-sponsor-account), with the primary objective of streamlining the installation of multiple essential apps for quickly setting up a specific group of accounts.\n\n\n\n## List of native Edition Apps\n\nThe `vtex` account currently provides the following native Edition Apps:\n\n* Edition Store (`vtex.edition-store@5.x`) - installs all the necessary apps to develop a store with the [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3).\n* Edition Business (`vtex.edition-business@0.x`) - installs all the necessary apps to build a store with the [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/6OCY6S9tqBXPD5mgpbBInC).\n\nThere are currently four versions of the Edition Store available. Next, you can better understand their differences regarding the apps installed by default in the manifest’s [dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-dependencies).\n\n| Version | vtex.checkout 0.x | vtex.checkout 1.x and 2.x | [vtex.store-sitemap](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-sitemap) | [vtex.search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) |\n| ------- | ----------------- | ------------------------- | ------------------------------------------------------------------------------ | ---------------------------------------------------------------- |\n| 2.x | ✅ | ❌ | ❌ | ❌ |\n| 3.x | ✅ | ❌ | ✅ | ❌ |\n| 4.x | ❌ | ✅ | ✅ | ❌ |\n| 5.x | ❌ | ✅ | ✅ | ✅ |\n\n> If you are [migrating from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io) or are using the 2.x version and want to update, it is not necessary to install the 5.x version **if your store already has the Search apps installed**. You can install either the 3.x or 4.x versions, depending on your specific needs. If you are not sure which version to set in your store, please [open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support) to the VTEX Support team.\n\nIf you are interested in creating your own Edition App, please refer to the [Developing an Edition App](#developing-an-edition-app) section.\n\n## Changing the Edition App of an account\n\nTo change the Edition App installed in an account, you are required to [open a support ticket](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk). This process is crucial to prevent potential critical issues that could arise from misconfiguration.\n\n## Developing an Edition app\n\nAny VTEX account that meets the [requirements needed to be a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account) can develop and release its own Edition Apps. This capability is particularly valuable for complex account families, such as those under the same brand or holding.\n\nA Sponsor Account can extend a native `vtex` Edition App by creating a new customized version that caters to the specific needs of its account family.\n\nFor more detailed instructions on developing an Edition App, please refer to 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### Dependencies and inherited apps\n\nAll Edition apps must depend, either directly or indirectly, on either `vtex.edition-business` or `vtex.edition-store`.\n\nApps included as [dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-dependencies) within an Edition App are considered inherited apps. Moreover, all apps bundled within an Edition App must share the same [vendor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest) as the Edition App itself.\n\n> Sponsored Accounts can't modify apps and configurations installed through an Edition App. Only the Sponsor Account has the permission to make changes by releasing a new version of its Edition App and requesting a reinstallation.\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/Reference/concepts/vtex-io-documentation-edition-app.md)\n\n[Edition Apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app//docs/guides/managing-edition-apps)[Sponsor AccountNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app//docs/guides/vtex-io-documentation-sponsor-account)\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 native Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app%23list-of-native-edition-apps)\n\n[Changing the Edition App of an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app%23changing-the-edition-app-of-an-account)\n\n[Developing an Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app%23developing-an-edition-app)\n\n[Dependencies and inherited apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app%23dependencies-and-inherited-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/Reference/concepts/vtex-io-documentation-edition-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[List of native Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app%23list-of-native-edition-apps)\n\n[Changing the Edition App of an account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app%23changing-the-edition-app-of-an-account)\n\n[Developing an Edition app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app%23developing-an-edition-app)\n\n[Dependencies and inherited apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app/docs/guides/vtex-io-documentation-edition-app%23dependencies-and-inherited-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_1c293ed7
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation customizing your stores typography in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-styling)\n\n[Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\n[Contributing with new CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n[Customizing your store's icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-icons)\n\n[Customizing your store’s typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-typography)\n\n[Interactively inspecting storefront blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\n[Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-styling)\n\n[Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\n\n[Contributing with new CSS Handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n[Customizing your store's icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-icons)\n\n[Customizing your store’s typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-typography)\n\n[Interactively inspecting storefront blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\n[Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/store-framework-styling)\n\n[Customizing your store’s typography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-typography)\n\nCustomizing your store’s typography\n\nEffectively communicating with users requires careful consideration of your store's typography. It serves as a visual representation of your store's identity through distinctive styles, encompassing factors like font size and spacing.\n\n> For additional information on customizing your store’s typography using the CMS, refer to the [Customizing your store’s typography](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/customizing-your-stores-typography--2R0ByIjvJtuz99RK3OL5WP) guide.\n\n## Before you begin\n\nBefore following this guide, ensure that you:\n\n* Review the [Best practices for using CSS handles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23best-practices) article.\n* Set up the [Assets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-assets-builder/) builder in your Store Theme app's `manifest.json` file.\n* Set up the Styles builder to version `2.x` in your Store Theme app's `manifest.json` file. Note that previous versions of the Styles builder do not support the customization outlined in this guide.\n\nmanifest.json\n\n`1\n\nbuilders{ \n\n2\n\n... \n\n3\n\n \"assets\": \"0.x\", \n\n4\n\n \"styles\": \"2.x\" \n\n5\n\n} \n\n`\n\n## Instructions\n\n1. Open your Store Theme app in your preferred code editor.\n2. Create a new folder named `fonts` within the `assets` directory.\n3. Place the font files inside the `assets/fonts/` folder. Ensure font files have the extensions: `.ttf` or `.woff`.\n4. In the `styles/configs` folder, create a new file named `font-faces.css`.\n5. Use the `@font-face` rule to declare the desired CSS properties for your website's typography. For example:\n\nfont-faces.css\n\n`1\n\n@font-face { \n\n2\n\n font-family: 'MyHelvetica'; \n\n3\n\n src: url(assets/fonts/MyHelvetica.woff2), url(assets/fonts/MyHelvetica.ttf); \n\n4\n\n font-weight: bold; \n\n5\n\n} \n\n`\n\n> Fonts uploaded on the Assets Builder can be referenced in your CSS files by specifying their file path in the `src` property.\n\n### Using font faces\n\nThe `font-faces.css` file is a global configuration. Utilize the declared font faces using the `font-family` property to specify the desired font for a particular component. Here's an example:\n\n| styles/configs/font-faces.css1@font-face {2 font-family: \"Roboto\";3 font-style: normal;4 font-weight: 400;5 src: local(\"Roboto\"), local(\"Roboto-Regular\"),6 url(\"assets/fonts/roboto-v20-latin-regular.woff2\") format(\"woff2\"),7 url(\"assets/fonts/roboto-v20-latin-regular.woff\") format(\"woff\");8}910@font-face {11 font-family: \"Roboto\";12 font-style: normal;13 font-weight: 500;14 src: local(\"Roboto Medium\"), local(\"Roboto-Medium\"),15 url(\"assets/fonts/roboto-v20-latin-500.woff2\") format(\"woff2\"),16 url(\"assets/fonts/roboto-v20-latin-500.woff\") format(\"woff\");17} | styles/css/vtex.minicart.css1.closeIconContainer::before {2 content: \"My cart\";3 font-size: 24px;4 line-height: 32px;5 font-family: Roboto;6 color: #000;7 font-weight: 500;8} |\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/Storefront-Guides/styling-your-store/vtex-io-documentation-customizing-your-stores-typography.md)\n\n[Customizing your store's icons« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography//docs/guides/vtex-io-documentation-customizing-your-stores-icons)[Interactively inspecting storefront blocksNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography//docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-typography%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-typography%23instructions)\n\n[Using font faces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-typography%23using-font-faces)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/styling-your-store/vtex-io-documentation-customizing-your-stores-typography.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-typography%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-typography%23instructions)\n\n[Using font faces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-your-stores-typography/docs/guides/vtex-io-documentation-customizing-your-stores-typography%23using-font-faces)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0e21bb1f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides erp integration updating and deleting information in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-guide)\n\n[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-set-up-catalog)\n\n[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-import-prices)\n\n[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-import-inventory)\n\n[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/import-customer-data)\n\n[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-set-up-order-integration)\n\n[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-import-products)\n\n[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-set-up-order-processing)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information)\n\n[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/faq-erp-integration)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides)\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-guide)\n\n[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information)\n\nUpdate or delete information\n\nAs you may have noticed when browsing through our [API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference) in the previous steps of this guide, most of the endpoints used have `PUT` / `DELETE` counterparts. These endpoints may be used as needed in your migration scripts or integration middleware to update and delete information. Check the links below to learn more.\n\n## Product updates\n\nYou may use automations that trigger API requests to your VTEX catalog whenever there are changes to you ERP catalog. Another alternative is to use one of the different [methods of importing or editing products manually](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-product).\n\nYour store's catalog may go through different kinds of changes, but in each case, your operation must be prepared to handle them and register them to VTEX.\n\n### New products or SKUs\n\nIn case you have new products or SKUs, you may follow the [product import flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-products%23import-product) mentioned in this guide.\n\n> Before importing new items, make sure your [catalog is set up](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog) to receive the new item when it comes to [category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-departments-categories-and-subcategories), [brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-departments-categories-and-subcategories) and [specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-catalog%23create-departments-categories-and-subcategories).\n\nTo learn more, see our [Catalog API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview) and these detailed integration guides:\n\n* [Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/categories)\n* [Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/brands)\n* [Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/specifications)\n* [Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products)\n* [SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus)\n\n### Updating existing products or SKUs\n\nSee these guides:\n\n* [Update a product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/products%23update-a-product)\n* [Update an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/skus%23update-sku)\n\n### Deactivating old products or SKUs\n\nIf you want a product or SKU to be removed from the catalog shown in your storefront, you may deactivate them. To do this, use the [Update product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/product/-productId-) or [Update SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-) API request setting the `IsActive` field as `false`.\n\n## Pricing updates\n\nTo perform ongoing pricing updates, you may use the same method described previously in this guide: [Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-prices%23set-base-price).\n\n## Inventory updates\n\nTo perform ongoing inventory updates, you may follow the same flow mentioned previously in this guide: [Update SKU Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-import-inventory%23update-sku-inventory).\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/erp-integration-updating-and-deleting-information.md)\n\n[Set up order processing« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information//docs/guides/erp-integration-set-up-order-processing)[FAQ: ERP IntegrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information//docs/guides/faq-erp-integration)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23product-updates)\n\n[New products or SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23new-products-or-skus)[Updating existing products or SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23updating-existing-products-or-skus)[Deactivating old products or SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23deactivating-old-products-or-skus)\n\n[Pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23pricing-updates)\n\n[Inventory updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23inventory-updates)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/erp-integration-updating-and-deleting-information.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23product-updates)\n\n[New products or SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23new-products-or-skus)[Updating existing products or SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23updating-existing-products-or-skus)[Deactivating old products or SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23deactivating-old-products-or-skus)\n\n[Pricing updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23pricing-updates)\n\n[Inventory updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-updating-and-deleting-information/docs/guides/erp-integration-updating-and-deleting-information%23inventory-updates)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_95d38b14
|
[
{
"role": "system",
"content": "You are a VTEX 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 canceling improvements in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-canceling-improvements/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/api-reference)\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-canceling-improvements/docs/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-canceling-improvements/docs/storefront-development)\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-canceling-improvements/docs/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-canceling-improvements/docs/troubleshooting)\n\n[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-canceling-improvements/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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-canceling-improvements/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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-canceling-improvements/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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-canceling-improvements/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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-canceling-improvements/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-canceling-improvements/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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-canceling-improvements/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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-canceling-improvements/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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-canceling-improvements/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/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-canceling-improvements/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-canceling-improvements/docs/guides)\n\nOrders\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements)\n\nOrder canceling improvements\n\nThere are many scenarios where canceling an order is necessary, whether on behalf of sellers, marketplaces or shoppers. To cover multiple scenarios, we made the following improvements in order cancellation:\n\n* [Cancel order requested by shopper](#cancel-order-requested-by-shopper): When the marketplace customer care service cancels an order after a shopper requests it, now the seller is notified about the cancellation reason and whether or not it was made on behalf of the shopper.\n* [Deny cancel order](#deny-cancel-order): After the [cancellation window](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) period – or grace period –, now the seller can deny cancellation requests.\n\nIn each case, both seller and marketplace will be notified about changes, have access to information about each other's reasons for canceling and/or denying a cancel request, and sellers will know when the shopper requested the cancellation.\n\nFor information about this feature in VTEX Admin, see [Declining order cancelation](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/declining-order-cancelation--F2n0h1TeQ5td540Gjyff4).\n\n> In this article, the term marketplace will refer to VTEX marketplace and seller to VTEX seller. For more information, see [Marketplace strategies at VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/marketplace-strategies-at-vtex--tutorials%5F402).\n\n## Permissions\n\nUsing the endpoints mentioned in this article requires having the `Cancel order` [resource](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) associated with the user or integration key. This resource is included in the following [predefined roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy):\n\nFor more information, see [users](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/managing-users--tutorials%5F512) and [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3) at VTEX.\n\n## Cancel order requested by shopper\n\nWith the [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint, now it is possible to indicate if the canceling request was demanded by the shopper or not. This is possible because of the new request body field `requestedByUser`. This is useful for sellers to know when the marketplace cancels an order on behalf of the shopper.\n\nA common scenario is when the shopper contacts the marketplaces customer care service via telephone, for example, and requests an order cancellation. In the cancellation request, the customer care now can inform both marketplace and seller that the cancellation was demanded by the shopper.\n\n> The [order flow](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) for canceling orders remains the same.\n\n### Diagram\n\nThe following image shows the flow when canceling an order on behalf of the shopper:\n\n\n\nThe step by step is the following:\n\n1. The shopper contacts the marketplace customer care service to cancel an order.\n2. The customer care cancels it using the [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint. The request body contains the reason for order cancellation and indicates if it was requested by the shopper.\n3. The cancel order request notifies the seller about the cancellation reason and if the request came from the shopper or not.\n4. VTEX seller cancels the order.\n\n### Cancel order endpoint\n\nSee below the [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint, where `orderId` corresponds to the ID of the order been canceled:\n\n**POST -** `https://{accountName}.{environment}.com.br/api/oms/pvt/orders/{orderId}/cancel`\n\n**cURL**\n\n`1\n\ncurl --request post \\ \n\n2\n\n--url 'https://{accountname}.{environment}.com.br/api/oms/pvt/orders/{orderId}/cancel' \\ \n\n3\n\n--header 'Accept: application/json' \\ \n\n4\n\n--header 'Content-Type: application/json' \\ \n\n5\n\n--header 'X-VTEX-API-AppKey: ' \\ \n\n6\n\n--header 'X-VTEX-API-AppToken: ' \\ \n\n7\n\n--data '{ \n\n8\n\n \"reason\": \"string\", \n\n9\n\n \"requestedByUser\": boolean \n\n10\n\n }' \n\n`\n\n### Request body\n\nSee below a request body example:\n\n`1\n\n{ \n\n2\n\n \"reason\" : \"reason for cancellation\", \n\n3\n\n \"requestedByUser\" : true \n\n4\n\n} \n\n`\n\nThe following table presents the request body fields’ description:\n\n| Field | Type | Description |\n| --------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------- |\n| reason | string | Brief explanation of why the order is being canceled. |\n| requestedByUser | boolean | When set as true, the cancellation was requested by the shopper, and when set as false, the cancellation was not canceled on behalf of the shopper. |\n\n### Response body\n\nSee below a response body example:\n\n`1\n\n{ \n\n2\n\n \"date\": \"2023-08-04T15:45:02.1306363+00:00\", \n\n3\n\n \"orderId\": \"1351761719659-01\", \n\n4\n\n \"receipt\": \"38e0e47da2934847b489216d208cfd91\" \n\n5\n\n} \n\n`\n\nThe following table presents the response body fields’ description:\n\n| Field | Type | Description |\n| ------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| date | string | Date and time of when the platform processed the cancellation request. The format is according to ISO 8601 YYYY-MM-DDThh:mm:ssTZD, meaning a complete date plus hours, minutes, seconds and a decimal fraction of a second. For example, 2023-08-04T15:45:02.1306363+00:00. |\n| orderId | string | ID that identifies the order being canceled. |\n| receipt | string | Protocol code generated by the update. It may be null. |\n\n### Response status codes\n\nThe possible response status codes are shown in the table below:\n\n| Status Code | Description |\n| ------------------------- | -------------------------------------------------------------------------------------------------------------------- |\n| 200 OK | The order was successfully canceled. |\n| 403 Forbidden | Unauthorized request. Update the credentials used in the request and try again. |\n| 404 Not Found | The requested order was not found. Check the order ID and try again. |\n| 429 Too Many Requests | We were unable to process the request due to the high volume of submissions. Wait a few minutes before trying again. |\n| 500 Internal Server Error | An unexpected application error occurred. Review the request data and try again. |\n\n### Order after cancellation\n\nAfter the seller agrees to cancel the order, as requested by the marketplace on behalf of the shopper, it reaches the `canceled` [status](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196). By using one of the endpoints below, both seller and marketplace can retrieve cancellation information:\n\n* GET - [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-)\n* GET - [Retrieve user order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/user/orders/-orderId-)\n\nThe information will be in the `cancellationData` object of the response body, as shown in the example below:\n\n`1\n\n\"cancellationData\": { \n\n2\n\n \"requestedByUser\": true, \n\n3\n\n \"reason\": \"cancelation reason\", \n\n4\n\n \"cancellationDate\": \"2023-08-04T15:45:02.1306363Z\", \n\n5\n\n \"cancellationRequestId\": \"85835ab408514b52aa139e4236ce0c33\" \n\n6\n\n } \n\n`\n\n> Seller and marketplace will get the same order cancellation information.\n\nThe fields’ description are shown below:\n\n| Response body field | Type | Description |\n| --------------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| cancellationData | object | Object with information about the order cancellation. |\n| requestedByUser | boolean | When set as true, the cancellation was requested by the shopper, and when set as false, the cancellation was not canceled on behalf of the shopper. |\n| reason | string | Explanation of why the order was canceled. |\n| cancellationDate | string | Date and time of when the platform processed the cancellation request. The format is according to [ISO 8601](https://read.calvincode.net/reader?url=https://www.w3.org/TR/NOTE-datetime) YYYY-MM-DDThh:mm:ssTZD, meaning a complete date plus hours, minutes, seconds and a decimal fraction of a second. For example, 2023-08-04T15:45:02.1306363+00:00 It could also be 2023-08-04T15:45:02.1306363Z, where Z stands for zone in Time Zone Designator (TZD). Z is equal to +hh:mm or \\-hh:mm. |\n| cancellationRequestId | string | ID that identifies the cancellation operation. |\n\n## Deny cancel order\n\nIn the order flow, there is a [cancellation window](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) period – or grace period – in which an order can be automatically canceled by the shopper. Except for that period, now the seller can deny order cancel requests, regardless if the cancellation request came from the shopper or the marketplace.\n\nA common scenario for using this endpoint is when the marketplace works with sellers whose products are made on demand by each purchase. If a shopper contacts the marketplace customer care service via telephone demanding the order cancellation, and the marketplace cancels the order, now the seller can deny the cancellation request.\n\n> To deny an order cancellation request, the order status in the marketplace and seller must be the following:\n> \n> * **Marketplace status:** `waiting-for-seller-decision`.\n> * **Seller status:** `cancellation-requested`.\n\n### Diagram\n\nThe following image shows the flow of denying an order’s cancel request outside the cancellation window:\n\n\n\nThe step by step is the following:\n\n1. The shopper contacts the marketplace to cancel an order.\n2. After receiving the request, the marketplace sends a cancellation request to the seller. \n> At this point, the [order status](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/order-flow-and-status--tutorials%5F196) for the marketplace is `waiting-for-seller-decision`.\n3. If the order is within the cancellation window period, this order is automatically canceled, which is the platform default behavior. The next steps are for when the order is no longer within the cancellation window.\n4. The seller receives the cancel order request and decides to accept it or not. The next steps are for when the seller decides not to cancel the order.\n5. The seller’s request to deny the order cancellation and that notifies the marketplace, with the reason included.\n6. After the marketplace receives the denial request, the order moves on in the order workflow, from the status below: \n * **For the marketplace**: `payment-approved`. \n * **For the seller**: `ready-for-handling` or `handling`, depending on which was the status before the cancel request.\n7. **Optional:** marketplace can, via webhook, notify a subscribed shopper about the order change in `payment-approved` and `cancellation-request-denied` status. It is also possible for some applications to collect the order cancellation denial reason given by the seller and inform the shopper.\n\n### Deny cancel order endpoint\n\nSee below the endpoint deny order cancellation, where `orderId` corresponds to the ID of the order witches cancellation is being denied:\n\n**POST -** `https://{accountName}.{environment}.com.br/api/orders/pvt/document/{orderId}/deny-cancellation-request`\n\n**cURL**\n\n`1\n\ncurl --request post \\ \n\n2\n\n--url 'https://{accountname}.{environment}.com.br/api/orders/pvt/document/{orderId}/deny-cancellation-request' \\ \n\n3\n\n--header 'Accept: application/json' \\ \n\n4\n\n--header 'Content-Type: application/json' \\ \n\n5\n\n--header 'X-VTEX-API-AppKey: ' \\ \n\n6\n\n--header 'X-VTEX-API-AppToken: ' \\ \n\n7\n\n--data '{ \n\n8\n\n \"cancellationRequestId\": \"cancellationRequestId\", \n\n9\n\n \"denyReason\": \"dIt isnandRIt isasOn\" \n\n10\n\n }' \n\n`\n\n### Request body\n\nSee below a request body example:\n\n`1\n\n{ \n\n2\n\n \"cancellationRequestId\": \"85835ab408514b52aa139e4236ce0c33\", \n\n3\n\n \"denyReason\": \"reason for seller giving deny\" \n\n4\n\n} \n\n`\n\nThe following table presents the request body fields’ description:\n\n| Field | Type | Description | Mandatory |\n| --------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------- |\n| cancellationRequestId | string | Unique identifier of an order requested to be canceled. This ID format is a sequence of numbers and letters. The cancellationRequestId is generated by the endpoint Cancel order, and can be found in the responses of the following endpoints: Get order Retrieve user order details | Yes |\n| denyReason | string | Brief explanation of why the seller will deny order cancellation. | Yes |\n\n### Response body\n\nThe endpoint does not return a response body in the successful `200 OK` response.\n\n### Response status codes\n\nThe possible response status codes are shown in the table below:\n\n| Status Code | Description |\n| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| 200 OK | The order cancellation was successfully denied. |\n| 400 Bad Request | The request was not processed, some possible reasons are: Cancellation request ID not found. Order already canceled. Order workflow not found. Invalid order status. The acceptable status for the seller is cancellation-requested , and for the marketplace is waiting-for-seller-decision. |\n| 403 Forbidden | Unauthorized request. Update the credentials used in the request and try again. |\n| 404 Not Found | The requested order was not found. Check the order ID and try again. |\n| 429 Too Many Requests | We were unable to process the request due to the high volume of submissions. Wait a few minutes before trying again. |\n| 500 Internal Server Error | An unexpected application error occurred. Review the request data and try again. |\n\n### Order after cancellation\n\nAfter the seller denies the cancellation request made by the marketplace outside the cancellation window, the related information can be retrieved both by marketplace and seller using one of the endpoints below:\n\n* GET - [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-)\n* GET - [Retrieve user order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/user/orders/-orderId-)\n\nThe information will be in the `cancellationRequests` array of the response body, as shown in the example below:\n\n`1\n\n\"cancellationRequests\": [ \n\n2\n\n { \n\n3\n\n \"id\": \"85835ab408514b52aa139e4236ce0c33\", \n\n4\n\n \"reason\": \"Cancelation Reason\", \n\n5\n\n \"cancellationRequestDate\": \"2023-07-24T19:44:59.6667459Z\", \n\n6\n\n \"requestedByUser\": true, \n\n7\n\n \"deniedBySeller\": true, \n\n8\n\n \"deniedBySellerReason\": \"reason of deny\", \n\n9\n\n \"cancellationRequestDenyDate\": \"2023-07-24T19:45:03.4550528Z\" \n\n10\n\n } \n\n11\n\n ] \n\n`\n\n> Seller and marketplace will get the same denial cancellation information.\n\nThe fields’ description are shown below:\n\n| Response body field | Type | Description |\n| --------------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| cancellationRequests | array | Array with information regarding the order witches cancellation was denied. |\n| id | string | ID that identifies the original cancellation operation made by the marketplaces or its customer care service using the [Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/cancel) endpoint. |\n| reason | string | Explanation of why there was a request for canceling the order. |\n| cancellationRequestDate | string | Date and time of when the platform processed the cancellation request. The format is [ISO 8601](https://read.calvincode.net/reader?url=https://www.w3.org/TR/NOTE-datetime) YYYY-MM-DDThh:mm:ssTZD, a complete date plus hours, minutes, seconds and a decimal fraction of a second. For example, 2023-08-04T15:45:02.1306363+00:00 It could also be 2023-08-04T15:45:02.1306363Z, where Z stands for zone in Time Zone Designator (TZD), and Z is equal to +hh:mm or \\-hh:mm. |\n| requestedByUser | boolean | When set as true, the cancellation was requested by the shopper, and when set as false, the cancellation was not canceled on behalf of the shopper. |\n| deniedBySeller | boolean | When set as true, the seller denied the order cancellation, and when set as false, the seller did not deny it. |\n| deniedBySellerReason | string | Reason given by the seller for denying order cancellation. |\n| cancellationRequestDenyDate | string | Date and time of when the seller’s request to deny order cancellation was processed. The format is ISO 8601 YYYY-MM-DDThh:mm:ssTZD, a complete date plus hours, minutes, seconds and a decimal fraction of a second. For example, 2023-08-04T15:45:02.1306363+00:00 It could also be 2023-08-04T15:45:02.1306363Z, where Z stands for zone in Time Zone Designator (TZD), and Z is equal to +hh:mm or \\-hh:mm. |\n\nContributors\n\n3\n\n[](https://github.com/mariananantua)\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Orders/order-canceling-improvements.md)\n\n[Change seller« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements//docs/guides/change-seller)[Actions in ordersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements//docs/guides/actions-orders)\n\nContributors\n\n3\n\n[](https://github.com/mariananantua)\n\n[](https://github.com/Isabella-Veloso)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23permissions)\n\n[Cancel order requested by shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23cancel-order-requested-by-shopper)\n\n[Diagram](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23diagram)[Cancel order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23cancel-order-endpoint)[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-body)[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-status-codes)[Order after cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23order-after-cancellation)\n\n[Deny cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23deny-cancel-order)\n\n[Diagram](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23diagram)[Deny cancel order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23deny-cancel-order-endpoint)[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-body)[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-status-codes)[Order after cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23order-after-cancellation)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Orders/order-canceling-improvements.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23permissions)\n\n[Cancel order requested by shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23cancel-order-requested-by-shopper)\n\n[Diagram](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23diagram)[Cancel order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23cancel-order-endpoint)[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-body)[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-status-codes)[Order after cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23order-after-cancellation)\n\n[Deny cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23deny-cancel-order)\n\n[Diagram](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23diagram)[Deny cancel order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23deny-cancel-order-endpoint)[Request body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23request-body)[Response body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-body)[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23response-status-codes)[Order after cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/order-canceling-improvements/docs/guides/order-canceling-improvements%23order-after-cancellation)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_1cbb1082
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides calling commerce apis 3 using vtex io 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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[1\\. Getting the Service app boilerplate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-1-getting-the-service-app-boilerplate)\n\n[2\\. Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n[Calling Commerce APIs - Conclusion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-conclusion)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-io-documentation-clients)\n\nHandling events\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-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/calling-commerce-apis-3-using-vtex-io-clients/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/app-development-guides)\n\n[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[3\\. Using VTEX IO clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients)\n\n3\\. Using VTEX IO clients\n\nNow equipped with knowledge on authenticating API calls in VTEX IO, let's dive into the practical aspect of calling VTEX Core Commerce APIs using native [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). In this guide, we'll specifically leverage the `Catalog` client to retrieve SKU details within the VTEX platform.\n\nIn VTEX IO, Clients act as abstractions for external services, simplifying external requests in backend services. We strogly recommend using pre-built Clients from the [@vtex/clients](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients) package for VTEX Core Commerce services and [developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) for external providers (e.g., [Google Maps API](https://read.calvincode.net/reader?url=https://developers.google.com/maps/apis-by-platform)).\n\n## Installing the `@vtex/clients` package\n\nThe [@vtex/clients](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients) package is a TypeScript library featuring pre-configured Clients for accessing VTEX Core Commerce APIs' capabilities. To use it in your app, change to the `node` folder and install the `@vtex/clients` package by running the command presented in the right panel.\n\n## Configuring the Catalog client\n\nUpdate your app's client `node/clients/index.ts` by importing the `Catalog` Client from the `@vtex/clients` library and exporting it to your `Clients` object. From now on, any function in your app can use the `Catalog` Client via `ctx.clients.catalog`. Also, thanks to TypeScript typing capabilities, autocomplete will become available for the methods exported by the `Catalog` client.\n\n\n\n## Using the Catalog client\n\nNow, let's use the `getSkuById` method from the `Catalog` client to retrieve information from a Stock Keeping Unit (SKU) in the VTEX Catalog. To do so, we will update the `status` route logic to read the `code` parameter as an SKU ID and return SKU details.\n\nOpen the `node/middlewares/status.ts` file and update it as in the following:\n\n* Extract the `catalog` client from the `ctx` received in the middleware functions. Learn more about Destructuring on the [Mozilla docuentation](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Operators/Destructuring%5Fassignment).\n* Extract the variable `code`, which will be used as the `code` parameter of our route (`/_v/status/:code`).\n* Call the `getSkuById` method from the `Catalog` client. This method will internally call the necessary endpoints of the Catalog API, passing the `code` parameter as the SKU ID to be searched. Also, since this is an asynchronous call, ensure to use the `await` to wait for it.\n\n## Declaring the necessary policies\n\nUsually, native Clients are already automatically configured to make authenticated calls using the app token. Nevertheless, you still need to declare that your app will be making requests for some service.\n\nTo do so, open the `manifest.json` file and add the highlighted code in the right panel to the `policies` section. This will allow your app to make calls to the Catalog API.\n\n## Fetching the SKU data\n\nWith the app linked to your development workspace, copy and send a GET request to the public URL that your service is exposing. Paste in the address bar `https://{workspace}--{account}.myvtex.com/_v/status/1` to find information about the SKU ID `1`. The expected result should be a JSON with the SKU data, fetched from the Catalog API.\n\nTerminal\n\n`1\n\ncd node && yarn add @vtex/clients \n\n`\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/Calling Commerce APIs/calling-commerce-apis-3-using-vtex-io-clients.md)\n\n[2\\. Discovering VTEX Commerce APIs and authentication« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients//docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)[Calling Commerce APIs - ConclusionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients//docs/guides/calling-commerce-apis-conclusion)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Installing the @vtex/clients package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23installing-the-vtexclients-package)\n\n[Configuring the Catalog client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23configuring-the-catalog-client)\n\n[Using the Catalog client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23using-the-catalog-client)\n\n[Declaring the necessary policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23declaring-the-necessary-policies)\n\n[Fetching the SKU data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23fetching-the-sku-data)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Calling Commerce APIs/calling-commerce-apis-3-using-vtex-io-clients.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Installing the @vtex/clients package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23installing-the-vtexclients-package)\n\n[Configuring the Catalog client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23configuring-the-catalog-client)\n\n[Using the Catalog client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23using-the-catalog-client)\n\n[Declaring the necessary policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23declaring-the-necessary-policies)\n\n[Fetching the SKU data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-3-using-vtex-io-clients/docs/guides/calling-commerce-apis-3-using-vtex-io-clients%23fetching-the-sku-data)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0414b623
|
[
{
"role": "system",
"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 footer 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-footer/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-footer/docs/api-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-footer/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-footer/docs/storefront-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-footer/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-footer/docs/troubleshooting)\n\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-footer/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-footer/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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.store-footer/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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.store-footer/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.store-footer/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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-footer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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-footer/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-footer/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-footer/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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-footer/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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.store-footer/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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.store-footer/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.store-footer/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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-footer/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/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-footer/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-footer/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-footer/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/basic-components)\n\nFooter\n\nOfficial extension\n\nVersion: 2.27.0\n\nLatest version: 2.27.0\n\nFooter is a store component that shows information about the store such as address, social networks and payment methods. Furthermore, it is possible to add hyperlinks for privacy policy, FAQ, benefits and attendance. This app is used by store theme.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-footer`'s app to your theme's dependencies in the `manifest.json`, for example:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.store-footer: 2.x\" \n\n3\n\n } \n\n`\n\n1. Define the `footer` block. For example:\n\n`1\n\n{ \n\n2\n\n \"footer\": { \n\n3\n\n \"blocks\": [\"footer-layout.desktop\", \"footer-layout.mobile\"] \n\n4\n\n }, \n\n5\n\n \"footer-layout.desktop\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"flex-layout.row#footer-desktop\" \n\n8\n\n ] \n\n9\n\n }, \n\n10\n\n \"footer-layout.mobile\": { \n\n11\n\n \"children\": [ \n\n12\n\n \"flex-layout.row#footer-mobile\" \n\n13\n\n ] \n\n14\n\n }, \n\n15\n\n \"flex-layout.row#footer-desktop\": { \n\n16\n\n \"children\": [ \n\n17\n\n \"social-networks\", \n\n18\n\n \"accepted-payment-methods\", \n\n19\n\n \"powered-by\" \n\n20\n\n ] \n\n21\n\n }, \n\n22\n\n \"flex-layout.row#footer-mobile\": { \n\n23\n\n \"children\": [ \n\n24\n\n \"social-networks\", \n\n25\n\n \"accepted-payment-methods\", \n\n26\n\n \"powered-by\" \n\n27\n\n ] \n\n28\n\n }, \n\n29\n\n \"social-networks\": { \n\n30\n\n \"props\": { \n\n31\n\n \"socialNetworks\": [ \n\n32\n\n { \"url\": \"https://facebook.com/foo\", \"name\": \"Facebook\" }, \n\n33\n\n { \"url\": \"https://twitter.com/foo\", \"name\": \"Twitter\" } \n\n34\n\n ] \n\n35\n\n } \n\n36\n\n }, \n\n37\n\n \"accepted-payment-methods\": { \n\n38\n\n \"props\": { \n\n39\n\n \"paymentMethods\": [\"mastercard\", \"visa\", \"diners club\"] \n\n40\n\n } \n\n41\n\n } \n\n42\n\n} \n\n`\n\n`social-networks`:\n\n| Prop name | Type | Description |\n| -------------- | -------------------- | ------------------------------------ |\n| title | string | Text to show above of list of links |\n| socialNetworks | Array(SocialNetwork) | Array of social networks |\n| showInColor | boolean | Whether the icons are colored or not |\n\nSocialNetwork\n\n| Prop name | Type | Description |\n| --------- | ------ | ---------------------------------------------------------------- |\n| url | string | Link to the social network profile |\n| name | enum | Possible values: facebook, twitter, linkedin, youtube, pinterest |\n\n`accepted-payment-methods`:\n\n| Prop name | Type | Description |\n| -------------- | ------- | ---------------------------------------------- |\n| paymentMethods | Array | Possible values: mastercard, visa, diners club |\n| showInColor | boolean | Whether the icons are colored or not |\n\n`powered-by`:\n\n| Prop name | Type | Description |\n| ----------- | ------- | ------------------------------------ |\n| showInColor | boolean | Whether the icons are colored or not |\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`footer-layout`:\n\n| CSS Handles |\n| ------------------ |\n| footerLayout |\n| footerLayoutSpacer |\n\n`social-networks`:\n\n| CSS Handles |\n| ----------------------- |\n| socialNetworksTitle |\n| socialNetworksContainer |\n| socialNetworkWrapper |\n| socialNetworkLink |\n| socialNetworkImage |\n\n`accepted-payment-methods`:\n\n| CSS Handles |\n| ------------------------------ |\n| acceptedPaymentMethodContainer |\n| paymentMethodIcon |\n| paymentMethodIconImage |\n\n`powered-by`:\n\n| CSS Handles |\n| -------------- |\n| poweredBy |\n| poweredByImage |\n| poweredByLink |\n\n[Breadcrumb« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.breadcrumb)[Google One-Tap LoginNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/guides/google-one-tap-login)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-footer%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/docs/apps/vtex.store-footer%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_70d94eb3
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides cart attachments 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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-section-api-quick-start-guides/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-section-api-quick-start-guides/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-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/cart-attachments-section-api-quick-start-guides/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-section-api-quick-start-guides/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/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/cart-attachments-section-api-quick-start-guides/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-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/cart-attachments-section-api-quick-start-guides/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides/docs/guides/cart-attachments-section-api-quick-start-guides)\n\nCart Attachments\n\nThis section contains the quick start guides of the endpoints described in the [Cart Attachments section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview%23cart-attachments) of the Checkout API Reference.\n\n* [Get client profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-a-client-profile-by-email)\n* [Add client profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-profile)\n* [Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n* [Add client preferences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-client-preferences-to-the-cart)\n* [Add marketing data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-marketing-data-to-the-cart)\n* [Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/add-cart-items)\n* [Add payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-payment-data-to-the-cart)\n* [Add merchant context data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/add-merchant-context-data-to-the-cart)\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/cart-attachments-section-api-quick-start-guides.md)\n\n[Add a service (offering) to a shopping cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides//docs/guides/add-service-to-the-cart)[Getting a customer profile by emailNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cart-attachments-section-api-quick-start-guides//docs/guides/getting-a-customer-profile-by-email)\n\nContributors\n\n1\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\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-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_1d88f0be
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation configuring custom images for the sku selector in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/updates/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/updates/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/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-configuring-custom-images-for-the-sku-selector/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/guides/store-framework)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/guides/store-framework-using-components)\n\n[Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector)\n\nConfiguring custom images for the SKU Selector\n\nBy default, the [SKU selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-skuselector) component uses **thumbnail images of SKU** when rendered.\n\n\n\nThese images that the component uses are taken from the SKU's previously given information in admin's Catalog.\n\nHowever, you can configure the SKU selector to display a **custom image**, meaning an image different than the default one used by the SKU. For example:\n\n\n\nFollow the step-by-step below to see how to apply this configuration in your store.\n\n## Instructions\n\n1. Access the Admin and go to **Catalog > All Products**.\n2. Find the desired product, and click the down arrow button. Then, click **SKU**.\n3. Find the desired SKU and click the corresponding **Edit** button.\n4. Click the **Images** tab.\n5. Click the **Insert** button to add a new SKU image.\n\n\n\n1. Upload the file in the `File` field and set an ID for the recently uploaded file in the `Label` field. Click on **Save** after performing all your changes.\n2. In your theme's code `sku-selector` block, add the `thumbnailImage` prop, whose past value should be the same as the label added in the catalog. For example:\n\n`1\n\n\"sku-selector\":{ \n\n2\n\n \"props\": { \n\n3\n\n \"thumbnailImage\": [\"LabelName\"] \n\n4\n\n } \n\n5\n\n}, \n\n`\n\nAfter completing step 7, you will be able to check a brand new image for your SKU selector.\n\nThe problem is that **this image is link to the SKU** through the catalog information, and therefore will also be rendered in its original format when users select the SKU in question.\n\nThe way out of this scenario is to **hide the custom image** that's linked to the SKU in the `product-images` block.\n\n1. In the `product-images` block you can use the `hiddenImages` prop to activate a sort of image blacklist. This prop's value should be the custom image's label, the same one used in the previous step. For example:\n\n`1\n\n\"product-images\": { \n\n2\n\n \"props\": { \n\n3\n\n \"displayThumbnailsArrows\": true, \n\n4\n\n \"hiddenImages\": [\"LabelName\"] \n\n5\n\n } \n\n6\n\n}, \n\n`\n\n> Remember to replace the value inserted in the brackets with real values, according to your SKU label.\n\nConsequently, you'll be able to configure a customized image exclusively for your SKU selector component, without it affecting your store's layout or that of the SKU images displayed to users.\n\n> _For this configuration to properly work, **all SKU custom images must have the same label value** (which must be the only value given between brackets). Otherwise, even by following the steps above, the SKU selector will continue to render the default images._\n\n### Specifying SKU color variations\n\nOnce you have configured the [custom images](###step-by-step), you should set a specific name to display the SKU color variations.\n\n\n\nFollow the next step-by-step on how to configure the SKU color variations.\n\n1. Access the Admin.\n2. Go to **Catalog** \\> **Categories**.\n3. Choose the desired category and in `ACTIONS` click on **Field(SKU)**\n4. In **Field** click in the group's `Edit`.\n5. In the fields **Name** and **Text** complete with a color variation name which you can check the values in the [SKU Selector component](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-components/blob/e130859a02e5c5d5e9deb9494bde9cfb6a0babc2/react/components/SKUSelector/utils/index.ts%23L50-L72). For example:\n\n\n\n1. Click on `Save` to make your changes available on SKU with thumbnail images.\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-configuring-custom-images-for-the-sku-selector.md)\n\n[Building a Shelf« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector//docs/guides/vtex-io-documentation-building-a-shelf)[Creating a native form for your store usersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector//docs/guides/vtex-io-documentation-creating-a-native-form-for-your-store-users)\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-configuring-custom-images-for-the-sku-selector/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector%23instructions)\n\n[Specifying SKU color variations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector%23specifying-sku-color-variations)\n\nWas this helpful?\n\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-configuring-custom-images-for-the-sku-selector.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-configuring-custom-images-for-the-sku-selector/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector%23instructions)\n\n[Specifying SKU color variations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector%23specifying-sku-color-variations)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_16b0c8bf
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation building a search results page with multiple layouts in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/store-framework-building-pages)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\nBuilding a search results page with multiple layouts\n\nCreating a versatile search results page is crucial for providing a seamless user experience in your online store. In this guide, you will learn how to build a search results page with multiple layouts, allowing users to switch between grid and list views.\n\n\n\n## Before you begin\n\nBefore proceeding, ensure you are familiar with the [Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.flex-layout) and the [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) apps. Also, check the [Building a Horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary) guide to understand how to create similar results on your search results page.\n\n## Instructions\n\n1. Implement the Search Result app in your Store Theme according to the instructions in the [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/) guide.\n2. Declare the `gallery` block responsible for structuring the page layout, and use its `layouts` prop to define the desired layouts for the search results page. For example: \n`1 \n\"gallery\": { \n2 \n \"props\": { \n3 \n \"layouts\": [ \n4 \n { \n5 \n \"name\": \"grid\", \n6 \n \"component\": \"GridSummary\", \n7 \n \"itemsPerRow\": { \n8 \n \"(min-width:1008px)\":4, \n9 \n \"(min-width:623px) and (max-width:1007px)\":3, \n10 \n \"(max-width:622px)\":2 \n11 \n } \n12 \n }, \n13 \n { \n14 \n \"name\": \"list\", \n15 \n \"component\": \"ListSummary\", \n16 \n \"itemsPerRow\": 1 \n17 \n } \n18 \n ], \n19 \n \"ListSummary\": \"product-summary.shelf#listLayout\", \n20 \n \"GridSummary\": \"product-summary.shelf\" \n21 \n } \n22 \n} \n` \nAll three of the `layouts` properties are mandatory and must be provided for each layout. \n| Property | Description | \n| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | \n| name | Specifies the search result layout. It can be grid or list. | \n| component | Defines the parent block responsible for defining the layout's components. For the grid layout, we define the component GridSummary that will then present items vertically and horizontally from each other. For the list layout, we define the ListSummary to show a list of items below one another. | \n| itemsPerRow | Controls how many items per row will be displayed by each layout. You can use media queries to define the layouts' widths properties for desktop, tablet, and phone, such as min-width and max-width, or you can use the layouts' name, such as desktop, tablet and phone. | \nChoosing to use the layouts' name, such as `desktop`, `tablet`, and `phone`, in `itemsPerRow`, you should declare them as the example below: \n`1 \n{ \n2 \n \"component\":\"GridSummary\", \n3 \n \"itemsPerRow\":{ \n4 \n \"desktop\":4, \n5 \n \"tablet\":3, \n6 \n \"phone\":2 \n7 \n } \n8 \n} \n` \nOnce you define the `list` and `grid` layouts, declare which blocks you should use in the code to build the desired pages: \n| Component | Block | \n| ----------- | -------------------------------------- | \n| ListSummary | product-summary.shelf#listLayout block | \n| GridSummary | product-summary.shelf block |\n3. Define the default layout, i.e., which layout will be first presented to customers, using the `defaultGalleryLayout` prop from the `search-result-layout.mobile` and `search-result-layout.desktop` blocks: \n`1 \n\"search-result-layout.desktop\": { \n2 \n \"children\": [ \n3 \n \"flex-layout.row#searchbread\", \n4 \n \"flex-layout.row#searchtitle\", \n5 \n \"flex-layout.row#result\" \n6 \n ], \n7 \n \"props\": { \n8 \n \"pagination\": \"show-more\", \n9 \n \"preventRouteChange\": false, \n10 \n \"defaultGalleryLayout\": \"grid\" \n11 \n } \n12 \n} \n`\n4. Declare the `gallery-layout-switcher` block in the search results template (`store.search`): \n`1 \n\"gallery-layout-switcher\": { \n2 \n \"children\": [ \n3 \n /* \n4 \n * For accessibility purposes, it is fundamental to define the layout options following the same ordering used to declare them in step 2. \n5 \n */ \n6 \n \"gallery-layout-option#grid\", \n7 \n \"gallery-layout-option#list\" \n8 \n ] \n9 \n}, \n10 \n\"gallery-layout-option#grid\": { \n11 \n \"props\": { \n12 \n \"name\": \"grid\" \n13 \n }, \n14 \n \"children\": [ \n15 \n \"icon-grid\", \n16 \n \"responsive-layout.desktop#textOptionGrid\" \n17 \n ] \n18 \n}, \n19 \n\"gallery-layout-option#list\": { \n20 \n \"props\": { \n21 \n \"name\": \"list\" \n22 \n }, \n23 \n \"children\": [ \n24 \n \"icon-inline-grid\", \n25 \n \"responsive-layout.desktop#textOptionList\" \n26 \n ] \n27 \n}, \n28 \n\"responsive-layout.desktop#textOptionGrid\": { \n29 \n \"children\": [ \n30 \n \"rich-text#option-grid\" \n31 \n ] \n32 \n}, \n33 \n\"responsive-layout.desktop#textOptionList\": { \n34 \n \"children\": [ \n35 \n \"rich-text#option-list\" \n36 \n ] \n37 \n}, \n38 \n\"rich-text#option-grid\": { \n39 \n \"props\": { \n40 \n \"text\": \"Grid\", \n41 \n \"textColor\": \"c-auto\", \n42 \n \"blockClass\": \"layout-option\" \n43 \n } \n44 \n}, \n45 \n\"rich-text#option-list\": { \n46 \n \"props\": { \n47 \n \"text\": \"List\", \n48 \n \"textColor\": \"c-auto\", \n49 \n \"blockClass\": \"layout-option\" \n50 \n } \n51 \n} \n` \nEach `gallery-layout-option` block receives the `name` prop with the name of the layout it corresponds to. This is a mandatory prop. Additionally, you can declare other blocks as its children and customize the selected layout option using the `galleryLayoutOptionButton--selected` [CSS Handle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization/).\n5. Add the `gallery-layout-switcher` block as a child of the `search-result-layout.mobile` and `search-result-layout.desktop` blocks to display the switcher button on the page for both devices (mobile and desktop). For example: \n`1 \n\"flex-layout.row#searchinfo\": { \n2 \n \"children\": [\"flex-layout.col#productCount\", \"flex-layout.row#orderByAndSwitcher\"] \n3 \n}, \n4 \n\"flex-layout.row#orderByAndSwitcher\": { \n5 \n \"children\": [\"order-by.v2\", \"gallery-layout-switcher\"], \n6 \n \"props\": { \n7 \n \"horizontalAlign\": \"right\", \n8 \n \"preventHorizontalStretch\": true, \n9 \n \"blockClass\": \"orderByAndSwitcher\", \n10 \n \"colGap\": 3 \n11 \n } \n12 \n} \n13 \n\"flex-layout.col#switcherMobile\": { \n14 \n \"children\": [\"gallery-layout-switcher\"], \n15 \n \"props\": { \n16 \n \"verticalAlign\": \"middle\" \n17 \n } \n18 \n} \n`\n6. [Deploy your theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public).\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts.md)\n\n[Building a Product Details Page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts//docs/guides/vtex-io-documentation-building-a-product-details-page)[Creating a Black Friday page from templateNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts//docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/concepts-1/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts%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_5b9da3ca
|
[
{
"role": "system",
"content": "You are a VTEX 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 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/storefront-implementation/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-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/storefront-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/storefront-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/storefront-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/storefront-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/storefront-implementation/updates/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-implementation/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-implementation/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/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/storefront-implementation/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/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/storefront-implementation/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/storefront-implementation/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/storefront-implementation/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/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/storefront-implementation/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/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/storefront-implementation/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/updates/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-implementation/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-implementation/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/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/storefront-implementation/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/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/storefront-implementation/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/storefront-implementation/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/storefront-implementation/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/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/storefront-implementation/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/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/storefront-implementation/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework)\n\nStore Framework\n\nStore Framework is a front-end development framework designed to enhance and simplify the creation of ecommerce websites within VTEX. Built on the [VTEX IO development platform](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) and [React](https://read.calvincode.net/reader?url=https://reactjs.org/) technology, the framework offers native storefront components in JSON format.\n\nStore Framework relies on the following pillars:\n\n| Aspect | Description |\n| ----------------------------- | ---------------------------------------------------------------------------------------------------- |\n| Composability | Assemble pre-built and custom components to create a storefront tailored to specific business needs. |\n| Flexibility and customization | Adapt storefronts to unique design requirements and functional preferences. |\n| Workspaces | Create multiple store versions and test them to guarantee reliability and deploy changes safely. |\n| A/B tests | Experiment with different versions of a storefront to enhance user experience and performance. |\n| VTEX IO cloud infrastructure | Develop in a fully managed auto-scalable infrastructure. |\n\n## Store Framework architecture\n\nCodebase\n\nBuild process\n\nDeployment\n\nCustomer touchpoint\n\nUser touchpoint\n\nCloud - AWS\n\nVTEX IO apps\n\nBuilder Hub\n\nHousekeeper\n\nPWA\n\nWebstore\n\nCMS / Site Editor\n\nDeveloper Tools\n\nDevelopment workspaces\n\nVTEX IO CLI\n\nA/B tests\n\nProduction workspaces\n\nEdition apps\n\nBuilders\n\nAdmin\n\nGraphQL\n\nReact\n\nStore\n\nNode\n\nPixel\n\nTechnologies\n\nNode\n\nReact\n\nTypescript\n\nGraphQL\n\nThe diagram shows a typical Store Framework architectural flow, which includes the following components:\n\n* **Codebase:** The source code for Store Framework and VTEX IO apps is cloud-native.\n* **Build process:** The process of converting the source code into a deployable application, based on [VTEX IO Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders).\n* **Deployment:** The process of deploying the application to a production environment.\n* **Business user touchpoint:** where administrative users interact with storefront settings, on CMS and Site Editor.\n* **Customer touchpoint:** where customers interact with the storefront, usually on a webstore or PWA.\n\n### Developer Tools\n\nDevelopers using Store Framework can count on a set of tools:\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): Interact with the VTEX platform using our command-line tool.\n* [A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ab-tests): Compare traffic between two workspaces.\n* [Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app): Streamline your setup by installing a preset bundle of settings, policies, backend and frontend apps.\n* [Development workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace): Test and preview your code in workspaces dedicated to development, without affecting the live store.\n* [Production workspaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace): Run tests and quality assurance in a workspace that is ready to handle live traffic.\n* [Builders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders): Connect your apps to our services quickly using VTEX IO Builders.\n\n### Technologies\n\nTo work with this framework, you should be familiar with the following technologies:\n\n* [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io)\n* [React](https://read.calvincode.net/reader?url=https://reactjs.org/)\n* [Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en)\n* [TypeScript](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/)\n* [GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/)\n\n## Quickstart\n\nThis quickstart guide is a brief introduction to the VTEX Store Framework. For more detailed step-by-step documentation, check [Store Framework - Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3).\n\n### 1\\. Initial settings\n\n1. [Install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install). You will need it to run commands in the following steps.\n2. Log in to your VTEX account: \n`1 \nvtex login {accountName} \n`\n3. Open a [support ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/support?/cultureInfo=en-us) to set up your account’s Edition app to `vtex.edition-store@3.x` or higher. Refer to the [Edition App article](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) to identify the most suitable version for your scenario.\n4. Install Intelligent Search (if the account’s Edition app is `vtex.edition-store@4.x` or lower) and integrate it with your store’s catalog according to [this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-2-prerequesites%23step-2-implementing-the-vtex-intelligent-search).\n\n### 2\\. Setting up the project\n\n1. Navigate to a local file directory where you want our [boilerplate store theme](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/store-theme) to be saved: \n`1 \ncd {folderName} \n`\n2. Start a new project: \n`1 \nvtex init \n`\n3. Select `store` by navigating with your arrow keys and pressing `Enter`. When prompted to confirm, type `y` to clone the `minimum-boilerplate-theme` to your folder.\n4. Create a workspace: \n`1 \nvtex use {workspaceName} \n`\n5. Navigate to the `minimum-boilerplate-theme` directory: \n`1 \ncd minimum-boilerplate-theme \n`\n6. Link your local repository with the workspace: \n`1 \nvtex link \n`\n7. Access your workspace: \n`1 \nvtex browse \n`\n\nNow you can make changes to the local repository and test them live in the workspace without altering the store's final public version.\n\n## Next steps\n\n### Customizing your theme\n\n[Building your own store themeLearn how to create your store theme from scratch.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-6-buildingyourownstoretheme)[Building pagesCreate custom pages for your ecommerce.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-product-details-page)[Using componentsLeverage from premade components to build your store theme.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout)[StylingCustomize your store's style.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-contributing-with-new-css-handles)\n\n### Deploying your changes\n\n[Making your theme content publicPublish your new store theme.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public)[Going liveMake your store available to shoppers.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-go-live)\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-io/Storefront-Guides/store-framework.md)\n\n[Tracing the error source« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation//docs/guides/faststore/troubleshooting-tracing-the-error-source)[Store ThemeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation//docs/guides/vtex-io-documentation-store-theme)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Store Framework architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23store-framework-architecture)\n\n[Developer Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23developer-tools)[Technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23technologies)\n\n[Quickstart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23quickstart)\n\n[1\\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%231-initial-settings)[2\\. Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%232-setting-up-the-project)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23next-steps)\n\n[Customizing your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23customizing-your-theme)[Deploying your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23deploying-your-changes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Store Framework architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23store-framework-architecture)\n\n[Developer Tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23developer-tools)[Technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23technologies)\n\n[Quickstart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23quickstart)\n\n[1\\. Initial settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%231-initial-settings)[2\\. Setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%232-setting-up-the-project)\n\n[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23next-steps)\n\n[Customizing your theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23customizing-your-theme)[Deploying your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation/docs/guides/store-framework%23deploying-your-changes)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_6051eade
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides ui customization my authentication in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n[My Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/ui-customization-my-authentication)\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/vtexjs)\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/ui-customization-my-authentication/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n[My Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/ui-customization-my-authentication)\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/vtexjs)\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/ui-customization-my-authentication/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides)\n\nUI Customization\n\n[My Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication/docs/guides/ui-customization-my-authentication)\n\nMy Authentication\n\nThis guide shows the steps to change the appearance of the Authentication tab in My Account using CSS.\n\n> This guide is for stores that do not use VTEX IO, making the customization through CMS. If your store is a VTEX IO store, check the [My Authentication Customization Guide using IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-my-authentication) article.\n\nTo customize the appearance of My Authentication components, first you have to create your own CSS file with the desired customization settings. Below you can find the list of CSS handles and a CSS file example.\n\n\n\n| CSS Handles |\n| ----------------------------------------------------------- |\n| vtex\\_my-authentication\\_box\\_container |\n| vtex\\_my-authentication\\_box\\_header |\n| vtex\\_my-authentication\\_box\\_headerSeparator |\n| vtex\\_my-authentication\\_box\\_content |\n| vtex\\_my-authentication\\_box\\_footer |\n| vtex\\_my-authentication\\_errorAlert\\_container |\n| vtex\\_my-authentication\\_warnAlert\\_container |\n| vtex\\_my-authentication\\_authenticationScreen\\_container |\n| vtex\\_my-authentication\\_authenticationScreen\\_passBox |\n| vtex\\_my-authentication\\_newPassInput\\_container |\n| vtex\\_my-authentication\\_passValidation\\_container |\n| vtex\\_my-authentication\\_passValidation\\_title |\n| vtex\\_my-authentication\\_passValidation\\_content |\n| vtex\\_my-authentication\\_passValidation\\_minLengthNumber |\n| vtex\\_my-authentication\\_passValidation\\_minLength |\n| vtex\\_my-authentication\\_passValidation\\_number |\n| vtex\\_my-authentication\\_passValidation\\_lowerUpper |\n| vtex\\_my-authentication\\_passValidation\\_lower |\n| vtex\\_my-authentication\\_passValidation\\_upper |\n| vtex\\_my-authentication\\_passValidation\\_iconSuccess |\n| vtex\\_my-authentication\\_passValidation\\_iconFailure |\n| vtex\\_my-authentication\\_savePassButton\\_container |\n| vtex\\_my-authentication\\_skeletonEditPassword\\_content |\n| vtex\\_my-authentication\\_skeletonEditPassword\\_button |\n| vtex\\_my-authentication\\_currPassInput\\_container |\n| vtex\\_my-authentication\\_createPassword\\_text |\n| vtex\\_my-authentication\\_codeInput\\_container |\n| vtex\\_my-authentication\\_resendCodeButton\\_container |\n| vtex\\_my-authentication\\_maskedPassword\\_title |\n| vtex\\_my-authentication\\_maskedPassword\\_content |\n| vtex\\_my-authentication\\_loginSessionsBox\\_title |\n| vtex\\_my-authentication\\_loginSessionsBox\\_content |\n| vtex\\_my-authentication\\_skeletonLoginSessions\\_content |\n| vtex\\_my-authentication\\_skeletonLoginSessions\\_button |\n| vtex\\_my-authentication\\_loginSessionsScreen\\_container |\n| vtex\\_my-authentication\\_loginSessions\\_skeleton |\n| vtex\\_my-authentication\\_loginSessions\\_error |\n| vtex\\_my-authentication\\_loginSessions\\_list |\n| vtex\\_my-authentication\\_loginSessions\\_box |\n| vtex\\_my-authentication\\_skeletonLoginSessionsScreen\\_title |\n| vtex\\_my-authentication\\_skeletonLoginSessionsScreen\\_text1 |\n| vtex\\_my-authentication\\_skeletonLoginSessionsScreen\\_text2 |\n| vtex\\_my-authentication\\_loginSession\\_currSession |\n| vtex\\_my-authentication\\_loginSession\\_currSessionIcon |\n| vtex\\_my-authentication\\_loginSession\\_currSessionText |\n| vtex\\_my-authentication\\_loginSession\\_device |\n| vtex\\_my-authentication\\_loginSession\\_lastAccess |\n| vtex\\_my-authentication\\_loginSession\\_originDetails |\n| vtex\\_my-authentication\\_loginSession\\_fullAddress |\n| vtex\\_my-authentication\\_loginSession\\_firstAccess |\n\nThen go to the Admin of your store and do the following steps:\n\n1. Open the Admin and go to the **Storefront** section.\n2. Click **Layout**.\n3. In the **Frontend CMS** left panel, navigate to **CMS** \\> **Files Manager** \\> **.css**.\n4. In the **Files Manager** tab, click on the **Add** button. \n\n5. In the **Files Maintenance** tab, click on the `Localizar` button.\n6. A window with a file explorer will open. Choose the CSS file you created.\n7. Click on the `Salvar arquivo` button. This will upload your CSS file to the CMS of the store. \n\n8. In the **Frontend CMS** left panel, navigate to **CMS** \\> **HTML Templates** \\> **Account**. \n\n9. In the right panel will appear the My Account HTML template. Inside the `<head>` section, insert the tag `<link href=\"https://{accountName}.vteximg.com.br/arquivos/{cssFile}\" rel=\"stylesheet\"></link>`, replacing `{accountName}` for the account name of your store and `{cssFile}` for the name of the CSS file you uploaded. \n\n10. A popup window will show up. In the last field type **yes**.\n11. Click on the `Update Item` button. \n\n12. A new popup window will appear. If there are no errors, the HTML template will be saved. Then click on **Ok**. \n \nAfter updating the HTML template, you should see the changes in the Authentication tab of your store.\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/UI-Customization/my-account/ui-customization-my-authentication.md)\n\n[Integration VTEX Sales App Local stock sale« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication//docs/guides/integration-vtex-sales-app-local-stock-sale)[vtex.jsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ui-customization-my-authentication//docs/guides/vtexjs)\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/UI-Customization/my-account/ui-customization-my-authentication.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_29d79528
|
[
{
"role": "system",
"content": "You are a VTEX 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 gift lists in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-gift-lists/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/api-reference)\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-gift-lists/docs/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-gift-lists/docs/storefront-development)\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-gift-lists/docs/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-gift-lists/docs/troubleshooting)\n\n[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-gift-lists/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/docs/guides/setting-up-the-zoom)\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/docs/guides/configure-the-price-history-control)\n\n[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/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/creating-gift-lists/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/creating-gift-lists/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/storefront-development)\n\n(Legacy) CMS Portal\n\n[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists)\n\nCreating gift lists\n\nThis feature lets you create a shopping list in the online store, which can be associated with an event such as a wedding, bridal shower, birthday, baby shower or simply a wish list. For this to work properly, your agency or the team responsible for the frontend must create the appropriate templates on the Portal module.\n\nThe types of list to be created, and their special features, are chosen by the storekeeper from the platform, as explained in the article [How to create a type of list](https://read.calvincode.net/reader?url=http://help.vtex.com/en/tutorial/creating-a-type-of-list).\n\nEach different list created will have its own uses, but the key objective is for consumers to add the products they want to buy, and to be able to do so by logging in to their account with the store.\n\nLists can also be for others to view products and buy them, to give as presents to the owner of the list. This is the case with wedding lists, bridal showers, baby showers and birthday lists.\n\n## Create link to access the lists section in your store\n\nTo create the html element that gives the customer access to the lists in your store's Home, you must include the code below in your template:\n\n`1\n\n<a href=“/giftlist”>Listas</a> \n\n`\n\nThe `/giftlist` route acts as the Home of the lists for each client. In the `new-Giftlist` template found in the CMS of your store, we have already included the `<vtex.cmc: GiftListSearchV2/>` control inside the `<body>` element on your template. This control renders the search lists created by your clients.\n\nInside the `new-GiftList` template, there is a subtemplate with the name`new-GiftList-Sidebar-nav`. This subtemplate contains the code snippet below and can be found in the `Sub Templates` section within `HTML Templates` in your CMS:\n\n`1\n\n<ul class=\"nav nav-list bs-docs-sidenav giftlist-sidenav\"> \n\n2\n\n <li><a href=\"/giftlist/\"><i class=\"icon-chevron-right\"></i> Buscar uma Lista</a></li> \n\n3\n\n <li><a href=\"/giftlist/create/\"><i class=\"icon-chevron-right\"></i> Criar nova Lista</a></li> \n\n4\n\n <li><a href=\"/giftlist/manage/\"><i class=\"icon-chevron-right\"></i> Gerenciar minhas Listas</a></li> \n\n5\n\n</ul> \n\n`\n\nThis code renders a list with **three links**:\n\n1. **Search a List**: This link takes the customer to the `/giflist` route, where the searches are performed by the lists.\n2. **Create New List**: This link takes the customer to the `/giftlist/create` route, where the customer creates their lists. In the next steps, we'll explain how list creation is done.\n3. **Manage My Lists**: This link takes the customer to the `/giftlist/manage` route, where the customer can manage their lists. In the next steps, we'll explain how list management is done.\n\n## Find a List\n\nTo find a list on the site, click on the link “My List” and complete one of the filter fields, as shown below. This page can vary, depending on how the site is customized, and can, for instance, be limited simply to the fields “Name”, “Sobrenome” and “Data do Evento”.\n\n* **Tipo de lista:** Selection of type of list according to the registration made by the store owner on the platform, as explained in the article [How to create a type of list](https://read.calvincode.net/reader?url=http://help.vtex.com/en/tutorial/creating-a-type-of-list). This field is the only one which, if completed, requires another field to be completed as well, since your site will contain lists of a number of consumers, and if “type of list” returned all the results, a client would have access to your other clients’ lists;\n* **Código da lista:** Code provided when you create a list. This field can only be used to filter a list;\n* **Nome:** First name, defined by the owner of the list. Guests or any users searching for a list will normally use the owner’s first name. This field can be used on its own, to filter lists with the first name of the owner, but if the owner has more than one list, they will all be shown;\n* **Sobrenome:** Last name, defined by the owner of the list. This field can be used on its own, to filter lists in the last name of the owner, but if the owner has more than one list, they will all be shown. If used jointly with the first name and type of list fields, a more specific result will be shown;\n* **Local do evento:** Address where the event will be held. This field can be used on its own to filter lists relating to the address given, but since it can be written in a number of different ways, it is recommended to use it jointly with other fields, to get a more specific result;\n* **Data do evento:** Date when the event will take place. Like the other fields, it may be that there are other lists with events taking place on the same day. If this field is used as a filter on its own, it may return other lists in addition to the one sought.\n\n## Create a new list\n\nTo create a new list on the site, click on the link “My List” (which normally has the path /giftlist), click on “Create new list”, complete the fields, as below, mark the option “Li e estou de acordo com o regulamento” and save. The user must have a register in the store and must log on, because the user will be the owner of the list and by being logged on will associate the list with the user. When you create a list on your site, it is saved on the platform in the E-Commerce module in Relatórios > Listas > Todas as Listas. Below are details of each field in the form for creating a list:\n\n## Create a list\n\n* **Tipo de lista**:Types of list registered by the store owner on the platform.\n* **Nome da lista**:The name of the list is defined by the user when it is created. It depends a lot on the type of list chosen, but normally it is the user’s own name, since it is often used for events like weddings, birthdays, bridal showers and baby showers.\n* **URL da lista:** The link to be used to publicize your list. In this field, just insert the final part of the list address, after the last slash. The default is `http://www.sualoja.com.br/list` \\+ the value you enter in this field.\n* **Quem pode ver esta lista?:** The options for who can see this list vary according to the store owner’s configurations. If it is configured for “_Criador da lista decide_”, you can decide between the options “_somente os participantes desta Lista_” and “_qualquer pessoa_” (only list participants, or anyone). Only the first option will appear if the list visibility is defined as “_Privada_” (Private), and only the second if it is defined as “_Pública_” (Public). The “_Criador da lista decide_” option is important for the user, for example in a wedding gift list, since the couple will want to restrict access to themselves only, while they are choosing the products and managing the list, and open the list for anyone to have access when it is complete.\n* **Upload de imagem:** This field lets an image to be used to represent the event or personalize the list, such as a photo of the bride and groom, for example.\n* **Mensagem:** Allows the list owner to leave a message for the guests if so desired. There is a limit of 1000 characters (including letters, numbers, spaces and punctuation).\n\n## Members\n\n* First name\n* Last name\n* Email address\n\n_To add a new participant, click on the link “incluir participante”. The limit on the number of members included in a list depends on the configuration when the type of list was created. However we recommend that the number be limited to two, since the greater the number of members administering the list, the more likely it is that it will be incorrectly used._\n\n## Delivery address\n\n* Postal code (CEP)\n* Street name\n* Number\n* Unit\n* Bairro\n* Cidade\n* Estado\n* Endereço comercial\n* Quem receberá\n\n_If the user is already registered in the store, the address will appear automatically, but they will have the option to modify the address or register a new address and use this new one. For this, there are links “Modify selected address” and “Deliver to another address”, respectively._\n\n## Regulations\n\nRegulations are defined according to the need of each store to regulate use of the list and indicate how it works on its site. It appears as a read-only text field with a vertical scroll bar. The text to be shown here must be registered in text configuration in admin. For this, follow these steps:\n\n* Access the **Catalog** module\n* Go to Configurações and click on **Textos**\n* Click on **Selecione o ID do texto a Editar**\n* Look for **GifListThermsText**\n* Type the text in the field below the selection field, and save\n\n_For this information to appear in the Regulamento field each time a client creates a list, your agency or frontend customization team must use the control `<vtex.cmc:GiftListFormV2 />` inside of `<body>` element on your template._\n\n## Manage my Lists\n\nTo manage your list, you must be logged on to the site, access the link “Minha Lista” (which normally has the pathway `/giftlist`), click on “Gerenciar minhas Listas” and then select one of the following actions for the list.\n\n### Visualize\n\nThis will give you a macro view of your list, with the information entered when it was created and the products it contains. It will also have links to open the list, i.e. to make it public, if it has been configured as private; to edit and manage it, as explained below; and it may also have a summary of how many products you included and how many have been purchased . There may be other functions, such as buying all the products in the list or printing the list, but this will depend on how the frontend was customized.\n\n### Manage\n\nThis is very similar to the previous action, but can also add more units of the products selected, or exclude them from the list\n\n### Edit\n\nHere the user has the same view as when creating the list. The intention is that the owner of the list can amend any configuration made at the outset.\n\n### Exclude\n\nThis will delete the list. On clicking, a popup will appear to confirm the request.\n\n## Inserting products in a list\n\nAfter creating a list, you can add products by browsing the site and clicking on the button “Adicionar produtos às suas Listas”. This button’s function depends on the use of the control `<vtex.cmc:GiftListInsertSkuV2 />` inside your product template page.\n\n_There is a limit to the number of associations of **300** SKUs per list._\n\n##### **Special features of a List – Gift Card**\n\nItems purchased from your list will generate a credit that will accrue on a voucher automatically generated at the time the list is created. This voucher will work as a form of payment, so that the list owner redeems on purchases on the site any items they wish.\n\nLearn more about the form of payment worth in the article [Gift Card](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/gift-card--tutorials%5F995). Remembering that the types of lists available for site creation should be pre-built on the platform by the retailer.\n\n**Important Note:** Stores that are marketplace (sell sellers products, other partners in your store) are not eligible to use List Voucher.\n\nContributors\n\n4\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\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/creating-gift-lists.md)\n\n[Setting up the zoom« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists//docs/guides/setting-up-the-zoom)[Validating a layout before moving it to productionNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists//docs/guides/validating-a-layout-before-moving-it-to-production)\n\nContributors\n\n4\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/acnmello)\n\n[](https://github.com/jumeyermattosarruda)\n\nON THIS PAGE\n\n[Create link to access the lists section in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23create-link-to-access-the-lists-section-in-your-store)\n\n[Find a List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23find-a-list)\n\n[Create a new list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23create-a-new-list)\n\n[Create a list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23create-a-list)\n\n[Members](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23members)\n\n[Delivery address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23delivery-address)\n\n[Regulations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23regulations)\n\n[Manage my Lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23manage-my-lists)\n\n[Visualize](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23visualize)[Manage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23manage)[Edit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23edit)[Exclude](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23exclude)\n\n[Inserting products in a list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23inserting-products-in-a-list)\n\nWas this helpful?\n\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/creating-gift-lists.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Create link to access the lists section in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23create-link-to-access-the-lists-section-in-your-store)\n\n[Find a List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23find-a-list)\n\n[Create a new list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23create-a-new-list)\n\n[Create a list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23create-a-list)\n\n[Members](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23members)\n\n[Delivery address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23delivery-address)\n\n[Regulations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23regulations)\n\n[Manage my Lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23manage-my-lists)\n\n[Visualize](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23visualize)[Manage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23manage)[Edit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23edit)[Exclude](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23exclude)\n\n[Inserting products in a list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-gift-lists/docs/guides/creating-gift-lists%23inserting-products-in-a-list)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_8b459747
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides store 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/store-components/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/vtex-io-apps)\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/guides/guides/store-components)\n\nStore Components\n\nStore Components is a collection of components that can be used to create or extend other VTEX apps.\n\n[Autocomplete result listRepresents the search bar autocomplete.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/autocompleteresults)[Availability subscriberShows the availability subscriber form displayed when a product is not available.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/availabilitysubscriber)[Back to top buttonRedirects users to the top of the page when clicked.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/backtotopbutton)[ImageAllows adding any image to the store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/image)[Info cardDisplays content combining image and text on your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/infocard)[LogoDisplays an image logo for the store header.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/logo)[NotificationDisplays text content in a bar style or inline.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/notification)[Product brandDisplays either the name or the logo of a product brand.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productbrand)[Product descriptionDisplays a product description.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productdescription)[Product imagesRenders a product image or video.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productimages)[Product nameDisplays the product name and its details, such as SKU or brand.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productname)[Product SKU attributesDisplays a list of the current SKU variations for a product.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/productskuattributes)[Search barShows a search bar that suggests autocomplete options while also displaying the matching products.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/searchbar)[ShareAllows to share a product URL via social media.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/share)[Shipping simulatorEstimates the shipping rate based on a postal code input.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/shippingsimulator)[SKU selectorDisplays every SKU available for a given product.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components/docs/apps/vtex.store-components/skuselector)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-components.md)\n\n[Store Image« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components//docs/apps/vtex.store-image)[Autocomplete Result ListNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-components//docs/apps/vtex.store-components/autocompleteresults)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/store-components.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0cb28da4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex search in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/guides/basic-components)\n\nSearch\n\nOfficial extension\n\nVersion: 2.18.8\n\nLatest version: 2.18.8\n\n[](#contributors-)\n\nThe VTEX Search app handles the new [**Intelligent Search**](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search) solution in IO stores by providing new UI components to enhance the search experience, such as the autocomplete feature.\n\n\n\n## Configuration\n\nThe Search app requires the `vtex.admin-search@1.x` and `vtex.search-resolver@1.x` apps to be installed in your store. For more information, read the [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search) documentation.\n\nTo configure the Search app, see the sections below.\n\n### Adding the Search app to your theme dependencies\n\nAdd the `search` app to your theme dependencies in the `manifest.json` as shown below:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.search\": \"2.x\" \n\n3\n\n } \n\n`\n\nYou can now use all blocks exported by the `search` app. See the full list below:\n\n| Block name | Description |\n| --------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| autocomplete-result-list.v2 | Provides customized autocomplete features in the search bar component, such as top searches, search history, product suggestions, or term suggestions. You can read more about the Intelligent Search [autocomplete feature](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4gXFsEWjF7QF7UtI2GAvhL) in the VTEX Help Center. |\n| search-banner | Renders a customized banner based on the search query. |\n| did-you-mean | Helps users with possible misspelling corrections for the current search query. |\n| search-suggestions | Renders a list of similar search terms for the current search. |\n\n> The `search-banner`, `did-you-mean`, and `search-suggestions` blocks require [Search Result app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) version `3.x` or higher installed in your theme.\n\n### Adding Search blocks to the theme\n\nFirst, declare the `autocomplete-result-list.v2` block as a child block of the [search-bar block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/searchbar), exported by the Store Components app. Example:\n\n`1\n\n{ \n\n2\n\n \"search-bar\": { \n\n3\n\n \"blocks\": [\"autocomplete-result-list.v2\"], \n\n4\n\n \"props\": { \n\n5\n\n \"openAutocompleteOnFocus\": true \n\n6\n\n } \n\n7\n\n } \n\n8\n\n} \n\n`\n\n#### `autocomplete-result-list.v2` props\n\n| Prop name | Type | Description | Default value |\n| ------------------------ | --------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| maxTopSearches | number | Maximum number of items in the top searches list. | 10 |\n| maxHistory | number | Maximum number of items in the search history. | 5 |\n| maxSuggestedProducts | number | Maximum number of items in the suggested products list. | 3 |\n| maxSuggestedTerms | number | Maximum number of items in the suggested terms list. | 3 |\n| autocompleteWidth | number | Autocomplete list width (percentage). This value must be between 0 and 100. | undefined |\n| productLayout | enum | Determines the layout the suggested products list will have when rendered. Possible values are HORIZONTAL and VERTICAL. | undefined |\n| hideTitles | boolean | Determines whether all component titles will be hidden when rendered (true) or not (false). | false |\n| hideUnavailableItems | boolean | Determines whether autocomplete should hide unavailable items (true) or not (false). This prop only hides items that are unavailable according to indexed information, without taking into account simulationBehavior. | false |\n| historyFirst | boolean | Determines whether the search history list should be prioritized over the other lists (true) or not (false). | false |\n| customBreakpoints | object | Determines the maximum number of recommended products per breakpoints. Possible values are md, lg, or xlg. | \\- |\n| simulationBehavior | \"skip\" or \"default\" | If you want faster searches and are not so concern about having the most up-to-date prices and promotions, use \"skip\". | default |\n| HorizontalProductSummary | product-summary block | By default, the mobile autocomplete uses the CustomListItem component to render the suggested products using a horizontal layout. But sending a product-summary block here will render your customized Product Summary component. Read our documentation to learn [how to build a horizontal Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-horizontal-product-summary) component. | undefined |\n\n##### The `customBreakpoints` object\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | -------------------------------------------------------------------------- | ------------- |\n| md | object | Defines the maximum number of recommended products for the md breakpoint. | undefined |\n| lg | object | Defines the maximum number of recommended products for the lg breakpoint. | undefined |\n| xlg | object | Defines the maximum number of recommended products for the xlg breakpoint. | undefined |\n\n##### The `md`, `lg`, and `xlg` objects\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------ | ------------------------------------- | ------------- |\n| width | number | Breakpoint minimum width. | undefined |\n| maxSuggestedProducts | number | Maximum number of suggested products. | undefined |\n\nThe `autocomplete-result-list.v2` block also allows you to add a list of child blocks to it. You can declare a theme block and have it rendered among the autocomplete features. Example:\n\n`1\n\n{ \n\n2\n\n \"autocomplete-result-list.v2\": { \n\n3\n\n \"blocks\": [\"product-summary\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\nNow, you can add the last three search blocks: `search-banner`, `did-you-mean`, and `search-suggestions`.\n\nThese blocks, as opposed to `autocomplete-result-list.v2`, need to be added under the `search-result-layout.desktop` or the `search-result-layout.mobile` blocks, following the Search Results block hierarchy.\n\nOnce added, the blocks can be declared using their respective props for configuration. Example:\n\n`1\n\n{ \n\n2\n\n \"search-result-layout.desktop\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#did-you-mean\", \n\n5\n\n \"flex-layout.row#suggestion\", \n\n6\n\n \"flex-layout.row#banner-one\", \n\n7\n\n \"flex-layout.row#result\" \n\n8\n\n ], \n\n9\n\n \"props\": { \n\n10\n\n \"pagination\": \"show-more\", \n\n11\n\n \"preventRouteChange\": true, \n\n12\n\n \"mobileLayout\": { \n\n13\n\n \"mode1\": \"small\", \n\n14\n\n \"mode2\": \"normal\" \n\n15\n\n } \n\n16\n\n } \n\n17\n\n }, \n\n18\n\n \n19\n\n \"flex-layout.row#did-you-mean\": { \n\n20\n\n \"children\": [\"did-you-mean\"] \n\n21\n\n }, \n\n22\n\n \"flex-layout.row#suggestion\": { \n\n23\n\n \"children\": [\"search-suggestions\"] \n\n24\n\n }, \n\n25\n\n \"flex-layout.row#banner-one\": { \n\n26\n\n \"children\": [\"search-banner#one\"] \n\n27\n\n }, \n\n28\n\n \n29\n\n \"search-banner#one\": { \n\n30\n\n \"props\": { \n\n31\n\n \"area\": \"one\", \n\n32\n\n \"blockClass\": \"myBanner\", \n\n33\n\n \"horizontalAlignment\": \"center\" \n\n34\n\n } \n\n35\n\n } \n\n36\n\n} \n\n`\n\n#### `search-banner` props\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| area | string | Area where the banner will be displayed in the store. This needs to match the predefined area value in the banner configuration. | undefined |\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| horizontalAlignment | string | Defines the horizontal alignment of the banner. Possible values are left, center, or right. | center |\n\n### Catalog integration\n\nAfter installing the app, you need to integrate it with your store's catalog. Go to **Store Settings > Intelligent Search > Integrations** in the VTEX Admin and click **Start integration** to set up the initial indexing of the catalog with Intelligent Search. Learn more about this process at [Setting up Intelligent Search integration with the Catalog](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-intelligent-search-integration-with-the-catalog--3Nt5cIdwISSlzVtnYfLeIH).\n\n\n\nAfterwards, you can follow the indexing status of products on the [Indexing History](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/4flMwTaQL8FRKl1YT58ezH) page.\n\n## App behavior: Improving search experience\n\nTo improve the user's search experience in stores where the Intelligent Search engine is supported, the app have the following options:\n\n* **Stores using Universal Analytics (UA)**: \nThe Search app provides blocks that, when rendered as components, will improve the user's search experience in stores where the Intelligent Search engine is supported. \nThese components use `_q` as the query-string for the search term, meaning that if you want to track user searches in these components, you will need to add the `_q` query-string to the store's Google Analytics. To activate this behavior, refer to [Set up Site Search](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/1012264?hl=en%23zippy=%2Cin-this-article) Google's documentation. \n> Please note that although the Search app's blocks enhance the search experience in VTEX stores, this feature is only compatible with VTEX stores using UA. As UA will be discontinued on July 1st, 2023, **we highly recommend that you update your store to GA4**. For more information on the migration, see the [release notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/2023-05-04-google-tag-manager-new-version) and follow the option below.\n* **Store using Google Analytics 4 (GA4)**: \nInstall the VTEX Google Tag Manager app, which includes the `search` event within the app's data layer. This app is responsible for tracking the user's search activity. For instructions on setting up Google Tag Manager, consult the [Setting up Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager) documentation.\n\n## Customization\n\nIn order to apply CSS customizations to 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| searchBanner |\n| didYouMeanPrefix |\n| didYouMeanTerm |\n| suggestionsList |\n| suggestionsListItem |\n| suggestionsListLink |\n| itemListSubItemLink |\n| itemListLink |\n| itemListLinkTitle |\n\n[Rich Text« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.rich-text)[SuggestionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search/suggestions)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[DidYouMeanVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search@2.18.8/DidYouMean)[SuggestionsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search@2.18.8/Suggestions)[AutocompleteVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search@2.18.8/Autocomplete)[BannerVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search@2.18.8/Banner)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search%23configuration)\n\n[Adding the Search app to your theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search%23adding-the-search-app-to-your-theme-dependencies)[Adding Search blocks to the theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search%23adding-search-blocks-to-the-theme)[Catalog integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search%23catalog-integration)\n\n[App behavior: Improving search experience](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search%23app-behavior-improving-search-experience)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search/docs/apps/vtex.search%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_dca82383
|
[
{
"role": "system",
"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 bazaarvoice 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.bazaarvoice/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/api-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.bazaarvoice/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.bazaarvoice/docs/storefront-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.bazaarvoice/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.bazaarvoice/docs/troubleshooting)\n\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.bazaarvoice/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/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.bazaarvoice/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.bazaarvoice/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/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.bazaarvoice/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.bazaarvoice/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.bazaarvoice/docs/vtex-io-apps)\n\nBazaarvoice\n\nOfficial extension\n\nVersion: 2.4.2\n\nLatest version: 2.4.2\n\n[](#contributors)\n\n## Description\n\nThis is a Bazaarvoice first party integration app that is responsible for showing the components related to Bazaarvoice Reviews in your store.\n\n:loudspeaker: **Disclaimer:** Don't fork this project; use, contribute, or open issue with your feature request.\n\n## Release schedule\n\n| Release | Status | Initial Release | Maintenance LTS Start | End-of-life | Store Compatibility |\n| ------- | ------------------- | --------------- | --------------------- | ----------- | ------------------- |\n| \\[1.x\\] | **Current Release** | 2019-06-14 | 2.x | | |\n\nSee our [LTS policy](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/awesome-io%23lts-policy) for more information.\n\n## Table of Contents\n\n* [Usage](#usage) \n * [Configuration](#configuration) \n * [Styles API](#styles-api) \n * [CSS namespaces](#css-namespaces)\n* [Troubleshooting](#troubleshooting)\n* [Contributing](#contributing)\n* [Tests](#tests)\n\n## Usage\n\nTo use the bazaarvoice components add the [product reviews](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/product-review-interfaces/tree/master/example) blocks into your theme as you would with any other block.\n\n#### Configuration\n\nYou can set some options of the Reviews component in the CMS:\n\n| Prop name | Type | Description | Default value |\n| ------------------------------------- | ------ | ---------------------------------------------------------- | ----------------------- |\n| Quantity of reviews per page | number | the number of reviews that a review page will have | 10 |\n| Quantity of reviews on the first page | number | the number of reviews that the first review page will have | Same as the value above |\n\n### Styles API\n\nThis app provides some CSS classes as an API for style customization.\n\nTo use this CSS API, you must add the `styles` builder and create an app styling CSS file and add `vtex.bazaarvoice` to your theme `peerDependencies`.\n\n1. Add the `styles` builder to your `manifest.json`:\n\n`1\n\n \"builders\": { \n\n2\n\n \"styles\": \"1.x\" \n\n3\n\n } \n\n`\n\n1. Add `vtex.bazaarvoice` to `peerDependencies` in your `manifest.json`:\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n \"vtex.bazaarvoice\": \"1.x\" \n\n3\n\n } \n\n`\n\n1. Create a file called `vtex.bazaarvoice.css` inside the `styles/css` folder. Add your custom styles:\n\n`1\n\n.container { \n\n2\n\n margin-top: 10px; \n\n3\n\n} \n\n`\n\n#### CSS namespaces\n\nBelow, we describe the namespaces that are defined in the bazaarvoice.\n\n| Token name | Description | Component Source |\n| ----------------------------- | -------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| reviews | The reviews component | [NoReviews](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/NoReviews.tsx), [Reviews](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/Reviews.js) |\n| reviewsTitle | The reviews title | [NoReviews](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/NoReviews.tsx), [Reviews](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/Reviews.js) |\n| ratingSummary | Rating Summary | [RatingSummary](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/RatingSummary.js) |\n| ratingSummaryContainer | Main container of the Rating Summary | [RatingSummary](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/RatingSummary.js) |\n| ratingSummaryStars | Stars of the Rating Summary | [RatingSummary](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/RatingSummary.js) |\n| ratingSummaryStars--loading | Style of the Stars of the Rating Summary when they are loading | [RatingSummary](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/RatingSummary.js) |\n| ratingSummaryWrite | 'Write Review' link next to the stars of the Summary Container | [RatingSummary](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/RatingSummary.js) |\n| ratingInline | Rating in Line | [RatingInLine](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/RatingInline.tsx) |\n| reviewForm | Review Form | [ReviewForm](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/ReviewForm.js) |\n| ratingStars | Container of the rating stars | [Stars](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Stars.tsx) |\n| ratingStarsInactive | Style of the Stars when they are inactive | [Stars](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Stars.tsx) |\n| ratingStarsActive | Style of the Stars when they are active | [Stars](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Stars.tsx) |\n| histogramStarContainer | Histogram Star Container | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| histogramOuterContainer | Histogram most external container | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| histogramContainer | Histogram main container | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| histogramLine | Histogram line containing the data of a certain amount of star | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| histogramStar | Histogram Star | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| histogramBar | Histogram Bar | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| histogramBarValue | Histogram Bar filling | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| histogramCount | The count at the side of the histogram bar | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| secondaryHistogramLine | Histogram line containing the data of the secondary ratings | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| secondaryHistogramLabel | The label of a secondary histogram line | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| secondaryHistogramBar | Secondary ratings' histogram bar | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| secondaryHistogramBarValue | Secondary ratings' histogram bar filling | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| secondaryHistogramCount | Secondary ratings' histogram count | [Histogram](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Histogram.tsx) |\n| reviewHistogramBar | Review Histogram Bar | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewHistogramBarValue | Review Histogram Bar filling | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| histogramDivisions | Histogram division that separates it in five sections | [HistogramBar](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/HistogramBar.tsx) |\n| review | Review | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewRating | Review Rating | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewTitle | Review Title | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewSubmittedField | Review 'submitted' field | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewByField | Review 'by' field | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewFromField | Review 'from' field | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewText | Review text | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewImagesContainer | Review image container | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewImage | Review image | [Review](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Review.tsx) |\n| reviewsContainer | Reviews container | [ReviewsContainer](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/ReviewsContainer.tsx) |\n| reviewsContainerHead | Reviews Container head | [ReviewsContainer](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/ReviewsContainer.tsx) |\n| reviewsContainerTitle | Reviews container title | [ReviewsContainer](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/ReviewsContainer.tsx) |\n| reviewsContainerDropdowns | Reviews container dropdown buttons | [ReviewsContainer](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/ReviewsContainer.tsx) |\n| reviewsContainerSortDropdown | Reviews container sort button | [ReviewsContainer](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/ReviewsContainer.tsx) |\n| reviewsContainerStarsDropdown | Reviews container stars button | [ReviewsContainer](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/ReviewsContainer.tsx) |\n| reviewsContainerWriteButton | Reviews container write button | [ReviewsContainer](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/ReviewsContainer.tsx) |\n| noReviewsContainer | Container that appears when there are no reviews | [NoReviews](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/NoReviews.tsx) |\n| writeReviewButton | Write review button | [ReviewsContainer](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/ReviewsContainer.tsx), [NoReviews](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/NoReviews.tsx) |\n| activeStar | Active star | [Stars](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Stars.tsx) |\n| activeStarContainer | Active star container | [Stars](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Stars.tsx) |\n| inactiveStar | Inactive star | [Stars](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Stars.tsx) |\n| inactiveStarContainer | Inactive star container | [Stars](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/blob/master/react/components/Stars.tsx) |\n\n## Troubleshooting\n\nYou can check if others are experiencing similar issues [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/issues). Also, feel free to [open issues](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/bazaarvoice/issues/new) or contribute with a pull request.\n\n## Contributing\n\nTake a look at these guidelines: [how to contribute](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/awesome-io%23contributing).\n\n## Tests\n\nTo execute our tests go to `react/` folder and run `yarn test`\n\n### Travis CI\n\n[](https://travis-ci.org/vtex-apps/menu)\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[Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.bazaarvoice%23description)\n\n[Release schedule](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.bazaarvoice%23release-schedule)\n\n[Table of Contents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.bazaarvoice%23table-of-contents)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.bazaarvoice%23usage)\n\n[Styles API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.bazaarvoice%23styles-api)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.bazaarvoice%23troubleshooting)\n\n[Contributing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.bazaarvoice%23contributing)\n\n[Tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.bazaarvoice%23tests)\n\n[Travis CI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.bazaarvoice/docs/apps/vtex.bazaarvoice%23travis-ci)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_8b570089
|
[
{
"role": "system",
"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 checkout settings app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/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-checkout-settings/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-checkout-settings/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/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-checkout-settings/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-checkout-settings/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/vtex-io-apps)\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-suite)\n\nB2B Checkout Settings\n\nOfficial extension\n\nVersion: 3.1.0\n\nLatest version: 3.1.0\n\n> The **B2B Checkout Settings** app is part of VTEX’s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-suite) solution, a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships. We recommend that you use it alongside the other apps in this suite for all functionalities to work as expected.\n\nIn B2B commerce, it is often necessary to provide customized options during checkout, such as:\n\n* Making specific payment methods available for each organization or cost center.\n* Providing pre-filled addresses.\n* Including a purchase order number in the order.\n* Offering the option to create an order quote before making an actual purchase.\n\nThe **B2B Checkout Settings** app works alongside other **B2B Suite** apps to extend the checkout experience for users who are members of organizations, adding all the above possibilities to the checkout page.\n\n## Before you start\n\nFirst, make sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-install) installed in your machine.\n\nTo use **B2B Checkout Settings**, you must have the [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations) app installed in your store, which will enable you to group B2B users into organizations, with their own assigned payment methods, price tables, product collections, and cost centers.\n\nYou must also have the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions) app installed – it allows you to grant specific storefront roles for B2B users in an organization. See the **Storefront Permissions** app documentation for information on the available roles and how to customize their permissions.\n\n## Installation\n\nYou can install this app by running `vtex install vtex.b2b-checkout-settings` in your terminal, using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\nAfter this command, the app will be installed in your VTEX Admin, and B2B store administrators can access it on **Store Setup** \\> **B2B Checkout Settings**.\n\n## How it works\n\nConsidering B2B stores often need similar customizations, **B2B Checkout Settings** provides a ready-to-use customized checkout page for B2B scenarios.\n\nOnce **B2B Checkout Settings** is installed in your account, every script contained in its [checkout-ui-custom folder](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-checkout-settings/tree/master/checkout-ui-custom) will be automatically linked to your store. The app will customize your checkout page with the functionalities described below. You will also be able to [configure](#configuration) the app on **Store Setup** \\> **B2B Checkout Settings**.\n\n> The behavior of the checkout page in VTEX stores is customizable through JavaScript code. In case you need additional customization, we recommend that you use [Checkout UI Custom](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-checkout-ui-custom/p) if you prefer using the VTEX Admin interface or [Checkout UI Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-checkout-ui-settings) if you prefer a code-only option.\n\n### Restricted access to checkout\n\nThis app automatically checks users’ roles within the organization by communicating with the **B2B Organizations** app, and validates if the user has the required permissions to access checkout, by communicating with the Storefront Permissions app.\n\nBy default, users with any storefront role can access checkout, except for users with the **Organization Buyer** role. Any attempt to proceed to checkout without the required permission will result in a notification with the following message: _You don’t have access to the checkout_.\n\nNote that if you have [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions-ui) installed, you can customize these permissions on the VTEX Admin by accessing **Account Settings > Storefront Permissions**.\n\n### Cost Center addresses\n\nThe **B2B Checkout Settings** app communicates with the **B2B Organizations** app and automatically lists the [Cost Center addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations%23cost-center-details) associated with the user during checkout:\n\n|  |  |\n| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Cost Center Details** page, displaying two options of addresses associated with the cost center in question | Checkout page for an user associated with this organization and cost center |\n\n### Purchase order number field\n\nA purchase order (PO) is a commercial agreement between a buyer company and a B2B store, authorizing the payment for products or services to be delivered in the future within a specific time frame.\n\nHaving a purchase order number allows B2B customers to pay for authorized purchases by referencing this number. The purchase order is authorized and issued in advance by the company that is making the purchase.\n\nUsing **B2B Checkout Settings**, it is possible to enable an optional **Reference or PO Number** field for customers to insert this information during the checkout.\n\n\n\nSee the [Configuration](#configuration) section to understand how to enable or disable this button.\n\n## Configuration\n\nTo change app settings, in the VTEX Admin go to **Store Setup** \\> **B2B Checkout Settings**.\n\n\n\nYou can use the toggle button to activate or deactivate the available settings:\n\n* **Show Purchase Order Number Field:** enabling this will add the **Reference or PO Number** input field to the checkout page. This will allow users to insert a purchase order number during checkout.\n* **Show 'Create a Quote' Button:** enabling this will add the `Create a Quote` button to checkout, which allows users to create a quote using the current contents of their cart.\n\n> You should only enable the `Create a Quote` button if your store has the [B2B Quotes](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-quotes) app installed. Check the **B2B Quotes** app documentation for more information on how order quotes work.\n\n[B2B Organizations« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-organizations)[B2B Orders HistoryNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-orders-history)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-checkout-settings%23before-you-start)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-checkout-settings%23installation)\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-checkout-settings%23how-it-works)\n\n[Restricted access to checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-checkout-settings%23restricted-access-to-checkout)[Cost Center addresses](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-checkout-settings%23cost-center-addresses)[Purchase order number field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-checkout-settings%23purchase-order-number-field)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-checkout-settings/docs/apps/vtex.b2b-checkout-settings%23configuration)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_7c7d8432
|
[
{
"role": "system",
"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 image 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/Image/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/Image/docs/api-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/Image/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/Image/docs/storefront-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/Image/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/Image/docs/troubleshooting)\n\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/Image/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/Image/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/Image/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/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/Image/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/Image/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/Image/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/Image/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/Image/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/Image/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/Image/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/Image/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/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/Image/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/Image/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/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/Image/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/Image/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/Image/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/Image/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/Image/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/Image/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/Image/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/Image/docs/vtex-io-apps)\n\nImage\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 `image` block renders images in the storefront.\n\n \n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `image` block to any template you choose.\n2. Then, declare the `image` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"image#example\": { \n\n2\n\n \"props\": { \n\n3\n\n \"src\": \"https://storecomponents.vteximg.com.br/arquivos/box.png\", \n\n4\n\n \"maxHeight\": 24 \n\n5\n\n } \n\n6\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| --------- | --------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | ------------- |\n| alt | string | Alternate text for the image. | \\- |\n| link | [Link](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/native-types/blob/f63aeeb8f6e62f4a9aaec052a8be34973be7389b/pages/contentSchemas.json%23L52-L71) | The image hyperlink. For more details on the props of the link, please see the following table. | \\- |\n| maxHeight | string | Maximum height of the image. | \\- |\n| maxWidth | string | Maximum width of the image. | \\- |\n| sizes | string | Different image sizes for each page layout. | \\- |\n| src | string | Source URL of the image. | \\- |\n| srcSet | string | URL of the image to use in different situations. | \\- |\n| title | string | Image title displayed on hover. | \\- |\n\n* **`link` props:**\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| attributeNofollow | boolean | Guides the search engine not to track the link of the page indicated by the tag. If true, sets the rel=noFollow attribute to the link. | false |\n| newTab | boolean | If true opens a new tab when you click the image. | false |\n| url | string | Sets the URL to which the user will be redirected by clicking the image. | \\- |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, please read the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------ |\n| imageElement |\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/Image/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/Image/docs/apps/vtex.store-components/Image%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/docs/apps/vtex.store-components/Image%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/Image/docs/apps/vtex.store-components/Image%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_c4188369
|
[
{
"role": "system",
"content": "You are a VTEX 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 submitting your app in the vtex app store in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-app-store)\n\n[Becoming a registered VTEX App Store developer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer)\n\n[Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-developing-an-app)\n\n[Setting your app's billing model](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-setting-your-apps-billing-model)\n\n[Preparing your app for distribution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-preparing-your-app-distribution)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\n[Using the Docs builder to publish app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\n[App Store Guidelines](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/app-development)\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-app-store)\n\n[Submitting your app to the VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store)\n\nSubmitting your app to the VTEX App Store\n\nLearn how to submit your app for distribution in the VTEX App Store.\n\nLearn how to successfully submit your app for distribution in the VTEX App Store by following this guide. The VTEX App Store is a marketplace where VTEX clients can discover and install applications that enhance their ecommerce experience. Before your app can be featured in the VTEX App Store, it must pass the homologation process, which involves evaluation in three key areas: business, user experience (UX), and security/performance. This process applies to all apps, regardless of their functionality, e.g., storefront, admin, backend, or pixel.\n\n> Keep in mind that the homologation process may take 45 days from [the moment the app data is sent for validation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23step-2-managing-the-homologation-process).\n\n> [Edition apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-edition-app) do not need to be published in the App Store. Instead, accounts that wish to develop their own Edition apps must fulfill the [requirements to become a Sponsor Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-sponsor-account).\n\n## Before you begin\n\n### Technical requirements\n\nTo complete this guide, you will need:\n\n* **[GitHub](https://read.calvincode.net/reader?url=https://github.com/) account:** The app homologation is conducted via GitHub and Pull Requests (PRs). Ensure you have a GitHub account.\n* **VTEX IO CLI `3.x`:** Ensure that the VTEX IO CLI is updated to version `3.x`. For instructions, refer to [Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update).\n\n### App prerequisites\n\nBefore proceeding with the homologation process, ensure your app meets these prerequisites:\n\n* [**Set up 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): To be eligible for publication in the App Store, your app must have a billing model set up. This makes it publicly available for all VTEX accounts. If you want your app to be private to your organization and installed on a single account, you do not need to go through the process detailed in this guide and can [install it](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) directly in your account.\n* [**Publish your app on the VTEX IO development platform**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app/): Publish your app using the VTEX account corresponding to your `vendor` account and in a [workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/) that the VTEX team can test.\n* [**Deploy your app on the VTEX IO development platform**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available%23step-6---deploying-the-app-stable-version).\n\n### App Store prerequisites\n\nFinally, before submitting your app to the VTEX App Store, ensure you've completed the following steps:\n\n* [**Become a registered VTEX App Store developer**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-becoming-a-registered-vtex-app-store-developer): To submit an app to the VTEX App Store, you need to be a registered VTEX App Store developer.\n* [**Prepare your app for distribution**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-preparing-your-app-distribution): Ensure your app adheres to VTEX's [business](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-vtex-app-store), [design](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-design-guidelines), [marketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets), and [engineering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines) guidelines. These guidelines guarantee the standards of quality, viability, and usability of all apps made available through the VTEX App Store, so you must be aware of them before submitting your app for homologation.\n\n## Instructions\n\n### Step 1 - Submitting the app for validation\n\n1. Open the terminal and [log in to the VTEX account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage%23logging-in-to-your-vtex-account) corresponding to the app's `vendor` account using the [VTEX IO CLI 3.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n2. Change to your app's directory.\n3. Install the `submit` plugin: \n`1 \nvtex plugins add submit \n`\n4. Submit your app for homologation by running the following command. You can also specify which version to submit by running `vtex submit {vendorAccount}.{appName}@{appVersion}`. \n`1 \nvtex submit \n`\n5. When prompted, enter the GitHub username to manage homologation. Next, provide the workspace URL that the VTEX team can use to test your app.\n\n\n\n### Step 2 - Managing the homologation process\n\nAfter completing these steps, a GitHub repository will be automatically created for your app, and you will be provided with a PR link in the terminal (e.g., `https://github.com/vtex-reviews/{vendorAccount}.{appName}`). The specified GitHub account will be added to the repository with read-only permissions to follow your app's review process. You can make comments and adjustments in the same repository.\n\n> The homologation process applies to both new apps and new major app versions. A new branch will be created in the repository for each new app version.\n\nYou can work on improvements in a new branch. Once the branch has the necessary adjustments, open a PR for the VTEX team's review.\n\n\n\n### Step 3 - Waiting for the app homologation\n\nAfter opening the PR, the VTEX team will validate it for approval and merging. The new app version will then be ready to be released and made available in the VTEX App Store.\n\n> Once the homologation process is complete, a product will be automatically created in your store catalog. Do not remove or modify it, as this product integrates your app with the VTEX App Store marketplace.\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/vtex-app-store/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store.md)\n\n[Preparing your app for distribution« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store//docs/guides/vtex-io-documentation-preparing-your-app-distribution)[Using the Docs builder to publish app documentationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store//docs/guides/using-the-docs-builder-to-publish-app-documentation)\n\nSee also\n\n[App monetizationApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)[Engineering best practicesGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-engineering-guidelines)[Marketing guidelinesApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)[User Experience guidelinesApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-design-guidelines)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23before-you-begin)\n\n[Technical requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23technical-requirements)[App prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23app-prerequisites)[App Store prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23app-store-prerequisites)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23instructions)\n\n[Step 1 - Submitting the app for validation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23step-1-submitting-the-app-for-validation)[Step 2 - Managing the homologation process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23step-2-managing-the-homologation-process)[Step 3 - Waiting for the app homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23step-3-waiting-for-the-app-homologation)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/vtex-app-store/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store.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-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23before-you-begin)\n\n[Technical requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23technical-requirements)[App prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23app-prerequisites)[App Store prerequisites](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23app-store-prerequisites)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23instructions)\n\n[Step 1 - Submitting the app for validation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23step-1-submitting-the-app-for-validation)[Step 2 - Managing the homologation process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23step-2-managing-the-homologation-process)[Step 3 - Waiting for the app homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store/docs/guides/vtex-io-documentation-submitting-your-app-in-the-vtex-app-store%23step-3-waiting-for-the-app-homologation)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b9b2d41d
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides impressions in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/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/impressions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/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/impressions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/ads-events)\n\n[Understanding ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/understanding-ads-events)\n\n[Ads events notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/ads-events-notification)\n\n[Impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/impressions)\n\n[Views](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/views)\n\n[Clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/clicks)\n\n[Conversion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/conversion)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/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/impressions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/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/impressions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/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/impressions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/getting-started-with-vtex-ads-api)\n\n[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/synchronizing-the-catalog-with-vtex-ads)\n\n[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/retrieving-ads)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/ads-events)\n\n[Understanding ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/understanding-ads-events)\n\n[Ads events notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/ads-events-notification)\n\n[Impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/impressions)\n\n[Views](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/views)\n\n[Clicks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/clicks)\n\n[Conversion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/conversion)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/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/impressions/docs/guides)\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/vtex-ads)\n\n[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/getting-started-with-vtex-ads-api)\n\n[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/ads-events)\n\n[Impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/impressions)\n\nImpressions\n\nTrack when an ad is rendered or visible to a user.\n\nImpression tracking is fundamental for measuring ad visibility in VTEX Ads. This guide explains how to properly send impression events when your application displays advertisements to users.\n\n## Impression event rules\n\n* Impression events should be sent when an ad is rendered in the viewport.\n* Each impression is deduplicated within a 1-minute window per user, per device, per ad.\n* Impression events require both `user_id` and `session_id` for proper attribution.\n* Impression URLs are unique to each ad and should be obtained from the [Get ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/v1/rma/-publisher%5Fid-) response.\n\n> 🚧 Don't construct event URLs manually. Always use the URL provided from the `POST` [Get ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/v1/rma/-publisher%5Fid-) request.\n> \n> This is extremely important to ensure long-term stability of the integration, because the parameters of the event URL may change over time, but the integration itself does not.\n\n## Sending an impression event\n\nUse the `POST` [Track ad impressions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-ads-api%23post-/v1/beacon/impression/-ad%5Fid-) endpoint to send impression events. Check the endpoint documentation for detailed information about all available fields.\n\nRequest example:\n\n`1\n\nPOST https://events.newtail-media.newtail.com.br/v1/beacon/impression/4a94bc6e-7db1-425f-8430-cb4d17488b3b?pos=1 HTTP/1.1 \n\n2\n\naccept: application/json \n\n3\n\ncontent-type: application/json \n\n4\n\n \n5\n\n{ \n\n6\n\n \"user_id\": \"6f92d1e9-00b6-4f8b-9645-faeab321e1cc\", \n\n7\n\n \"session_id\": \"5898b8d1-c250-4bb5-931b-8b9d0ee7b499\" \n\n8\n\n} \n\n`\n\nSuccessful response example:\n\n> A successful response will have HTTP code 202.\n\n`1\n\n{ \n\n2\n\n \"messages\": [ \n\n3\n\n \"impression will be processed soon\" \n\n4\n\n ] \n\n5\n\n} \n\n`\n\nFailed response example:\n\n> A failed response will have HTTP code 422\\. The error message follows the [RFC 8927](https://read.calvincode.net/reader?url=https://datatracker.ietf.org/doc/rfc8927/) format\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"instancePath\": \"\", \n\n4\n\n \"keyword\": \"required\", \n\n5\n\n \"message\": \"must have required property 'user_id'\", \n\n6\n\n \"params\": { \"missingProperty\": \"user_id\" }, \n\n7\n\n \"schemaPath\": \"#/anyOf/0/required\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"instancePath\": \"\", \n\n11\n\n \"keyword\": \"required\", \n\n12\n\n \"message\": \"must have required property 'session_id'\", \n\n13\n\n \"params\": { \"missingProperty\": \"session_id\" }, \n\n14\n\n \"schemaPath\": \"#/anyOf/1/required\" \n\n15\n\n }, \n\n16\n\n { \n\n17\n\n \"instancePath\": \"\", \n\n18\n\n \"keyword\": \"anyOf\", \n\n19\n\n \"message\": \"must match a schema in anyOf\", \n\n20\n\n \"params\": {}, \n\n21\n\n \"schemaPath\": \"#/anyOf\" \n\n22\n\n } \n\n23\n\n] \n\n`\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/ads-events/impressions.md)\n\n[Ads events notification« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions//docs/guides/ads-events-notification)[ViewsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions//docs/guides/views)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Impression event rules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/impressions%23impression-event-rules)\n\n[Sending an impression event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/impressions%23sending-an-impression-event)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/ads-events/impressions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Impression event rules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/impressions%23impression-event-rules)\n\n[Sending an impression event](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/impressions/docs/guides/impressions%23sending-an-impression-event)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_3266350c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external seller integration connector in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-architecture)\n\n[Store setup for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-vtex-marketplace-setup)\n\n[External seller processing payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-processing-payments)\n\n[External seller connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector)\n\n[Catalog management for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-vtex-marketplace-operation)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-architecture)\n\n[Store setup for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-vtex-marketplace-setup)\n\n[External seller processing payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-processing-payments)\n\n[External seller connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector)\n\n[Catalog management for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-vtex-marketplace-operation)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides)\n\nIntegration Guides\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-guide)\n\n[External seller connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector)\n\nExternal seller connector\n\nThe seller integration flow comprises eight different API requests. Four of these are calls that the seller should make to the marketplace. The other four are requests that the marketplace will need to make to the seller. So, for these, you will need to implement endpoints that are prepared to receive specific request bodies and respond with specific objects.\n\nIn the table below, you will find every API request needed for each step of the integration. Each one of them links to their specific API Reference documentation, where you can find the request URLs, methods, headers, the explanation of every field, and examples of requests and responses.\n\n## Seller integration requests flow\n\n| Step | API Request | Request Target |\n| ------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |\n| [Catalog Notification](#catalog-notification) | post[Change Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/skuseller/changenotification/-skuId-) | ➡ Marketplace |\n| [Catalog Registration](#catalog-registration) | put[Send SKU Suggestion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api%23manage-suggestions) | ➡ Marketplace |\n| [Catalog and Storefront Update](#catalog-update) | post[Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orderForms/simulationn) | ⬅ Seller |\n| [Order Placement](#order-placement) | post[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orders) | ⬅ Seller |\n| [Order Dispatching](#order-dispatching) | post[Authorize Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orders/-sellerOrderId-/fulfill) | ⬅ Seller |\n| [Order Invoicing and Tracking](#order-invoicing) | post[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) | ➡ Marketplace |\n| [Cancellation by the Marketplace](#cancellation-by-the-marketplace) | post[Marketplace Order Cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orders/-orderId-/cancel) | ⬅ Seller |\n| [Cancellation by the Seller](#cancellation-by-the-seller) | post[Cancel Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/pvt/orders/-marketplaceOrderId-/cancel) | ➡ Marketplace |\n| [Order invoicing](#order-invoicing) | post[Send invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/pvt/orders/-marketplaceOrderId-/invoice) | ➡ Marketplace |\n| [Send tracking information](#order-tracking) | post[Send tracking information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/pvt/orders/-marketplaceOrderId-/invoice/-invoiceNumber-) | ➡ Marketplace |\n| [Update tracking status](#order-tracking) | post[Update tracking status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/pvt/orders/-marketplaceOrderId-/invoice/-invoiceNumber-/tracking) | ➡ Marketplace |\n\n> To help you test the integration requests and see in practice how they behave, we've assembled a Postman API Collection with all eight requests listed in this guide, including the necessary URLs, methods, headers, and example request bodies.\\\\n\\\\n[](https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/external-seller-integration-connector-0.png)\n\nLet’s walk through each of the steps in the integration.\n\n## Catalog notification\n\nThe seller is responsible for suggesting new SKUs to be sold in the marketplace, as well as notifying the marketplace about updates to SKUs that already exist. Both scenarios begin with a catalog notification. To send this notification, the seller must call the `[POST ChangeNotification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog_system/pvt/skuseller/changenotification/-skuId-)` endpoint provided by the marketplace.\n\nUse the **Change Notification API** to notify the marketplace about changes in the **catalog information** of a SKU, such as:\n\n* Name\n* Description\n* Images\n* EAN\n* Specifications\n\n> For price and inventory change notification, please see the [Catalog Update](#catalog-update) section.\n\nIf the request is properly authenticated and formatted, there are two possible responses:\n\n* **200 OK**: The SKU already exists in the marketplace. The seller should proceed to update its catalog information.\n* **404 Not Found**: `\"Seller StockKeepingUnit not found for this seller id\"` \nThis means the SKU does not yet exist in the marketplace. The seller must first register the SKU offer before it can be updated.\n\nThe “status 404” response means that the SKU does not yet exist in the marketplace. In this case, in order to push the SKU offer to the marketplace, the seller should register the SKU.\n\nThe “status 200” response means that the SKU informed in the request already exists in the seller. In this case, the seller should _update_ the SKU information.\n\n## Catalog registration\n\nWhen the marketplace responds to the Change Notification request with status 404, it means that the SKU informed by the seller does not exist in the marketplace’s catalog. In this case, the seller should send an SKU offer to the marketplace.\n\n> The catalog is owned by the marketplace, and the seller has no direct access to it. This is why every SKU is sent as an offer, which needs to be approved by the marketplace in order to become an SKU actually registered in the marketplace’s catalog.\n\nThe SKU offer is sent through the put[Send SKU Suggestion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-api%23manage-suggestions) API request. In this request, the seller informs mandatory information about the SKU, such as the product and SKU name, the seller ID, and the image URL.\n\n> Don’t forget that, for the Save Suggestion request to work, the marketplace must have created the proper brands and categories in their account. This should be done in the setup phase of the integration.\n\nBesides sending new SKU offers to the marketplace, the seller can update offers that have already been sent and have not yet been approved by the marketplace. To do this, you should make the same request used to create a new offer. In this case, the offer information will be replaced by the new one.\n\n> An offer update only works if the original offer hasn’t yet been approved or disapproved by the marketplace. An approved offer ceases do exist, and the SKU registration that comes from it can only be edited by the marketplace.\n\n## Catalog update\n\nTo notify the marketplace of price and inventory changes, the seller must call the following endpoints:\n\n* [Notify marketplace of price update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23post-/notificator/-sellerId-/changenotification/-skuId-/price)\n* [Notify marketplace of inventory update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23post-/notificator/-sellerId-/changenotification/-skuId-/inventory)\n\nAfter these notifications, the marketplace will reach out to the seller to retrieve the latest SKU information.\n\n### Endpoint implementation\n\nThe endpoint that the marketplace will call is the post[Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orderForms/simulation) endpoint. The marketplace will send an object containing an array of items. The seller must use this list to get the updated information about the referred SKUs and send them back to the marketplace, following the response format explained in the API Reference.\n\nBe mindful to add `/api` in your endpoint's base url for the call to function properly.\n\n> This route directly impacts the marketplace checkout flow and is essential to the functioning of the integration. Because of that, it needs to have high performance and availability.\n\n> The maximum time that VTEX marketplaces wait for a response from the fulfillment endpoint is 2.5 seconds. After that, the product will be considered unavailable or inactive.\n\n## Storefront update\n\nDuring the order flow, the marketplace storefront needs to be constantly fetching the updated price and inventory of each SKU in the cart. This is essential to guarantee that the customer will always be presented with the most updated information possible.\n\nAs in the [catalog update](#catalog-update) step, this information is provided by the seller through the post[Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orderForms/simulation) endpoint. As in that step, the same request format should be expected and the same response format should be returned.\n\nWhen the Fulfillment Simulation call is applied in the Storefront simulation scenario, the request from VTEX does not send the paramenters `country` and `postalCode`.\n\n## Seller processing payments\n\nIf the seller is processing payments, once the [necessary configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-seller-processing-payments) are set up, the seller must send their VTEX account name to the marketplace.\n\nYou can find your account name in your VTEX environment by accessing **Account Settings > Account Management > Account**, and looking for the `Account Name` field.\n\nThis information will be added in the `merchantName` field in the [Storefront Update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector%23storefront-update) and [Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector%23order-placement) steps of the integration guide. This is the field that confirms that payments will be done on the seller's side:\n\n`\"merchantName\": \"sellerAccountName\",`\n\n## Order placement\n\nOnce the customer finishes their checkout, the marketplace needs to let the seller know there is a newly placed order.\n\n### Endpoint implementation\n\nThe marketplace notifies the seller about a new order through the post[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orders) endpoint, which needs to be implemented by the seller.\n\nThe marketplace will send information such as the items contained in the cart, the client’s profile data, the shipping data, and the payment data. With that, the seller will be able to create the order in their own store.\n\n## Order dispatching\n\nAfter the payment is finished and approved, the marketplace sends a request to the seller to notify it that the fulfillment process can be started.\n\n### Endpoint implementation\n\nThis notification is done through a request to the post[Authorize Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orders/-sellerOrderId-/fulfill) endpoint, which needs to be implemented by the seller.\n\nThe body of this request contains only one information: the `marketplaceOrderId`, which identifies the order in the marketplace. The seller should use this ID to trigger the fulfillment process.\n\n## Order invoicing\n\nOnce the fulfillment process is triggered and the invoice is issued by the seller, the invoice data must be sent to the marketplace. The seller sends this information through the post[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) request.\n\n## Order tracking\n\nThe same endpoint called by the seller to send the invoice is used to send the order tracking information, which holds the following fields:\n\n* Carrier\n* Tracking identifier\n* Tracking URL\n\nIn this case, the post[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) should happen once the seller delivers the package to the carrier and receives the tracking data from it.\n\n## Cancellation by the marketplace\n\nOrder cancellations are never wanted, but they happen in every store. So the seller must be ready to receive order cancellation requests from the marketplace. For that, you will need to implement the last endpoint in this integration guide.\n\n### Endpoint implementation\n\nThe post[Marketplace Order Cancellation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-seller-fulfillment%23post-/pvt/orders/-orderId-/cancel) endpoint must be implemented on the seller's side. This call should be made twice: once for the _Evaluate cancellation request_ scenario, and a second time to _Confirm cancellation_ or _Refuse cancellation_\n\nFor the seller to:\n\n* **Evaluate a cancellation request:** it is possible to send an empty body as a response to the cancellation request, meaning that the seller is evaluating whether to proceed with the cancellation or not.\n* **Confirm the cancellation request:** it is possible to confirm the order cancellation by the marketplace by responding to the call with a body including only one information: the `marketplaceOrderId`, which identifies the order in the marketplace. The seller should use this ID to trigger the cancellation of the corresponding order. The seller should then respond with the same `marketplaceOrderId` and also with the `orderId`, which identifies the order in the seller, the date and time of the notification receipt, and a protocol code that confirms the receipt of the request (which may have the value `null`).\n* **Refuse a cancellation request:** it is possible to to [send the Invoice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/pvt/orders/-marketplaceOrderId-/invoice), meaning that the cancellation has been denied, and the flow continues to the [Order Invoicing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector%23order-invoicing) step, and the ones that follow it.\n\n## Cancellation by the seller\n\nOn certain occasions, the seller may also need to cancel the order itself. This might happen, for example, if there’s a problem with the order that prevents the seller from fulfilling it. In this case, the seller must call the post[Cancel Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/pvt/orders/-marketplaceOrderId-/cancel) endpoint.\n\n> If the order status is `Invoiced`, the order can only be canceled if—before using the Cancel Order endpoint—the seller sends a return invoice.\\\\n\\\\nTo do this, you must use the Order Invoice Notification endpoint, explained in the [Order invoicing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector%23order-invoicing) session. To inform the system that you are sending a return invoice, you must use the value input for the field type of the request body.\\\\n\\\\nAfter doing this, you will be able to send a cancellation request for the invoiced order, by using the endpoint referenced below.\n\n## Setting payment conditions\n\n---\n\nAfter building the endpoints listed in this guide and preparing your integration to send the requests expected by the marketplace, there is only one final configuration step before the VTEX marketplace can receive SKU offers from the external seller.\n\nContributors\n\n4\n\n[](https://github.com/anabaarbosa)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-seller-integration-guide/external-seller-integration-connector.md)\n\n[External seller processing payments« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector//docs/guides/external-seller-processing-payments)[Catalog management for VTEX MarketplaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector//docs/guides/external-seller-integration-vtex-marketplace-operation)\n\nContributors\n\n4\n\n[](https://github.com/anabaarbosa)\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[Seller integration requests flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23seller-integration-requests-flow)\n\n[Catalog notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23catalog-notification)\n\n[Catalog registration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23catalog-registration)\n\n[Catalog update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23catalog-update)\n\n[Endpoint implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23endpoint-implementation)\n\n[Storefront update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23storefront-update)\n\n[Seller processing payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23seller-processing-payments)\n\n[Order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23order-placement)\n\n[Endpoint implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23endpoint-implementation)\n\n[Order dispatching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23order-dispatching)\n\n[Endpoint implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23endpoint-implementation)\n\n[Order invoicing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23order-invoicing)\n\n[Order tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23order-tracking)\n\n[Cancellation by the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23cancellation-by-the-marketplace)\n\n[Endpoint implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23endpoint-implementation)\n\n[Cancellation by the seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23cancellation-by-the-seller)\n\n[Setting payment conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23setting-payment-conditions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-seller-integration-guide/external-seller-integration-connector.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Seller integration requests flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23seller-integration-requests-flow)\n\n[Catalog notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23catalog-notification)\n\n[Catalog registration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23catalog-registration)\n\n[Catalog update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23catalog-update)\n\n[Endpoint implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23endpoint-implementation)\n\n[Storefront update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23storefront-update)\n\n[Seller processing payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23seller-processing-payments)\n\n[Order placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23order-placement)\n\n[Endpoint implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23endpoint-implementation)\n\n[Order dispatching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23order-dispatching)\n\n[Endpoint implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23endpoint-implementation)\n\n[Order invoicing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23order-invoicing)\n\n[Order tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23order-tracking)\n\n[Cancellation by the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23cancellation-by-the-marketplace)\n\n[Endpoint implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23endpoint-implementation)\n\n[Cancellation by the seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23cancellation-by-the-seller)\n\n[Setting payment conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-connector/docs/guides/external-seller-integration-connector%23setting-payment-conditions)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_443d9da3
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX apps vtexbr.tiktok tbp app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/vtex-io-apps)\n\nTikTok for Business\n\nCommunity extension\n\nVersion: 1.6.2\n\nLatest version: 1.6.2\n\n> This app is no longer maintained by VTEX. This means support and maintenance are no longer provided.\n\n> �\u000fThe integration with TikTok is available only for stores in _Brazil_.\n\nThe TikTok for Business app allows merchants to easily connect their stores to TikTok, using it as a channel to drive sales and market products sold in their ecommerce.\n\nThe app includes the following features:\n\n* Connecting TikTok For Business and Ads Manager accounts with your VTEX account.\n* Syncing products in your catalog with TikTok.\n* Inserting the [TikTok Pixel](#tiktok-pixel) in your store.\n* Managing TikTok Ads from the VTEX Admin.\n\n## Before you start\n\nBefore installing the app, make sure you have read about its compatibility and requirements in the following sections.\n\n### Compatibility\n\nTikTok for Business is fully compatible with stores using [VTEX IO](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/4yB9wSl79cArd68aRBnBZ2) and partially compatible with stores using [Legacy CMS](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj) or [Headless CMS](https://read.calvincode.net/reader?url=https://faststore.dev/tutorials/cms/0%23vtex-headless-cms).\n\nIn VTEX IO stores, installing and configuring TikTok for Business causes the TikTok Pixel to be inserted automatically. On the other hand, stores using the Legacy CMS or Headless CMS need to configure the TikTok Pixel manually. Refer to the [Manual TikTok Pixel configuration](#manual-tiktok-pixel-configuration) section for more information on this.\n\n### Requirements\n\nTo be able to configure the TikTok for Business app in your VTEX store, you need to meet the following requirements:\n\n* Having a [TikTok Business account](https://read.calvincode.net/reader?url=https://ads.tiktok.com/help/article?aid=13288).\n* Having [Admin permission](https://read.calvincode.net/reader?url=https://ads.tiktok.com/help/article?aid=238947046829056266%26lang=en) in TikTok Business Center.\n* Having a [TikTok Ads Manager account](https://read.calvincode.net/reader?url=https://ads.tiktok.com/help/article?aid=9678) linked to your business account.\n\n## Installation\n\nYou can install TikTok for Business on the [VTEX App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/).\n\nAfter installation, the app settings will be available in the VTEX Admin, under **Marketplace > TikTok**. For some versions of the VTEX Admin, the page can be found at **Apps > My Apps > TikTok**.\n\n## Configuration\n\nYou must configure the TikTok for Business app through the VTEX Admin. Please check out the documentation about the [Integration with TikTok](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/tiktok-integration--1r0yJSO11nrer1YVu3WTFd/7Dwfwu1aHMp1aR1yvej5nv) for instructions on this process.\n\nIn case you are using the Legacy CMS or Headless CMS, you need to configure the TikTok Pixel manually as well. Read the following sections for more information on this.\n\n## TikTok Pixel\n\nThe TikTok Pixel is a JavaScript code snippet that you can include on your store's website, which allows you to track various actions of your website\u0019s visitors and share them with TikTok. These actions are called Pixel events \u0013 see the [Supported Pixel events](#supported-pixel-events) section to learn more.\n\nIn VTEX IO stores, the TikTok Pixel is automatically inserted when you install and configure TikTok for Business. In Legacy CMS or Headless CMS stores, you need to configure it manually. Refer to the [Manual TikTok Pixel configuration](#manual-tiktok-pixel-configuration) section for more information on this.\n\n### Supported Pixel events\n\nTikTok Pixel supports the following events:\n\n| **Event** | **Description** |\n| -------------- | -------------------------------------------- |\n| 'ViewContent' | When a visitor views any page in your store. |\n| 'AddToCart' | When a visitor adds a product to the cart. |\n| 'PlaceAnOrder' | When a visitor places an order. |\n\nFor more information on TikTok Pixel events, read TikTok\u0019s documentation on [Standard Events and Parameters](https://read.calvincode.net/reader?url=https://ads.tiktok.com/help/article?aid=10028%26lang=en).\n\n### Manual TikTok Pixel configuration\n\n> �\u000f This configuration applies only to [Legacy CMS](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj) and [Headless CMS](https://read.calvincode.net/reader?url=https://faststore.dev/tutorials/cms/0%23vtex-headless-cms) stores. If your store is built with [VTEX IO](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/4yB9wSl79cArd68aRBnBZ2), skip this section.\n\nTo insert the TikTok Pixel manually, you must follow the instructions in the TikTok documentation, more specifically in [Option 2: Install the pixel using Developer Mode](https://read.calvincode.net/reader?url=https://ads.tiktok.com/help/article?aid=10000357%23:~:text=to%20create%20events.%C2%A0-,Option%202%3A%20Install%20the%20pixel%20using%20Developer%20Mode%C2%A0,-Step%201%3A%20Install) of the [Get Started with Google Tag Manager](https://read.calvincode.net/reader?url=https://ads.tiktok.com/help/article?aid=10000357%23:~:text=TikTok%20Pixel%20Partners.-,Get%20Started%20with%20Google%20Tag%20Manager,-There%20are%20two) guide.\n\n## Disconnecting from TikTok\n\nMerchants can disable the integration between their store and TikTok at any time, by following the instructions on [Disconnecting TikTok from your store](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/tiktok-integration--1r0yJSO11nrer1YVu3WTFd/24SfBYkRkKMaetgjLDKgaP%23disconnecting-tiktok-from-your-store).\n\nIn case their TikTok user access token is revoked (deactivated or invalid), the integration will be disconnected automatically. The `access_token` is the token that bears the authorization of the TikTok user.\n\nOnce disconnected, your integration with TikTok stops completely: the TikTok Pixel and the integration with your store's catalog are deactivated. Therefore, you will no longer be able to send new products to TikTok and update products on the TikTok catalog automatically.\n\nOn the other hand, existing products are not deleted from the TikTok catalog by VTEX, which means they continue to appear on TikTok. For this to stop, you need to manually delete the products in [TikTok Catalog Manager](https://read.calvincode.net/reader?url=https://ads.tiktok.com/help/article?aid=10001005).\n\nAfter disconnecting, it is possible to reactivate the integration at any time by repeating the steps described in [Configuring the integration with TikTok for Business in the VTEX Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/tiktok-integration--1r0yJSO11nrer1YVu3WTFd/4AEUg7pEdX1beOaQhFf0wC).\n\n**Upcoming documentation:**\n\n* [Feature/error toast](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/tiktok-tbp/pull/88)\n* [Feature/brpa 1305 update register account](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/tiktok-tbp/pull/89)\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/vtexbr.tiktok-tbp/docs/apps/vtexbr.tiktok-tbp%23before-you-start)\n\n[Compatibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtexbr.tiktok-tbp%23compatibility)[Requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtexbr.tiktok-tbp%23requirements)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtexbr.tiktok-tbp%23installation)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtexbr.tiktok-tbp%23configuration)\n\n[TikTok Pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtexbr.tiktok-tbp%23tiktok-pixel)\n\n[Supported Pixel events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtexbr.tiktok-tbp%23supported-pixel-events)[Manual TikTok Pixel configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtexbr.tiktok-tbp%23manual-tiktok-pixel-configuration)\n\n[Disconnecting from TikTok](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtexbr.tiktok-tbp/docs/apps/vtexbr.tiktok-tbp%23disconnecting-from-tiktok)\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_b8cc6942
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides search and scroll api queries in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/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/search-and-scroll-api-queries/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/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/search-and-scroll-api-queries/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/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/search-and-scroll-api-queries/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/docs/guides/master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/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/search-and-scroll-api-queries/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/docs/guides/master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries//docs/guides/master-data-best-practices)[Pagination in the Master Data APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-and-scroll-api-queries//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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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/search-and-scroll-api-queries/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_e1df510b
|
[
{
"role": "system",
"content": "You are a VTEX 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 recaptcha in integrations in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-recaptcha-in-integrations/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/api-reference)\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-recaptcha-in-integrations/docs/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-recaptcha-in-integrations/docs/storefront-development)\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-recaptcha-in-integrations/docs/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-recaptcha-in-integrations/docs/troubleshooting)\n\n[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-recaptcha-in-integrations/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/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/implementing-recaptcha-in-integrations/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/recaptcha)\n\n[Applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/applicable-cases)\n\n[Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/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/implementing-recaptcha-in-integrations/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/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-recaptcha-in-integrations/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-recaptcha-in-integrations/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/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/implementing-recaptcha-in-integrations/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/recaptcha)\n\n[Applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/applicable-cases)\n\n[Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/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/implementing-recaptcha-in-integrations/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/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-recaptcha-in-integrations/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-recaptcha-in-integrations/docs/guides)\n\nIntegration Guides\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/recaptcha)\n\n[Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations)\n\nImplementing reCAPTCHA in integrations\n\nIf your store uses integrations to place orders, such as mobile apps or proprietary web-based storefronts, follow the steps below to implement [reCAPTCHA validation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha).\n\nIn order to have your implementation validate users with reCAPTCHA, you must first [obtain the appropriate reCAPTCHA key](#getting-the-recaptcha-key) and then use that key to [integrate reCAPTCHA on your storefront](#integrating-recaptcha-on-your-storefront). Once the shopper correctly solves the validation, the integration receives a token that must be [sent in the request that places the order](#final-validation).\n\n> The implementation process may vary depending on whether you are using a mobile or web-based storefront. More details below.\n\n## Getting the reCAPTCHA key\n\nThere are different ways of obtaining the reCAPTCHA key. See below the method that best applies to your context.\n\n### Getting the reCAPTCHA key for mobile implementations\n\nIn order to implement reCAPTCHA validation in a mobile app that places orders, follow the steps below.\n\n1. Create a Google Cloud project, according to the instructions in the article [Create, shut down, and restore projects](https://read.calvincode.net/reader?url=https://support.google.com/googleapi/answer/6251787).\n2. Create a Google Cloud API key, according to the instructions in the article [Authenticate using API keys](https://read.calvincode.net/reader?url=https://cloud.google.com/docs/authentication/api-keys) provided by Google.\n3. Create a reCAPTCHA enterprise key, according to the instructions in the article [Creating reCAPTCHA keys](https://read.calvincode.net/reader?url=https://cloud.google.com/recaptcha-enterprise/docs/create-key) provided by Google.\n4. Get your current VTEX Checkout settings, with the [Get orderForm configuration API request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm).\n5. Add your newly created reCAPTCHA key to your VTEX Checkout settings, by sending a request to the [Update orderForm configuration endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm). Use the configuration retrieved in step 3 as your request body and add your key information in this field: \n`1 \n{ \n2 \n …, \n3 \n \"recaptchaKeys\": [ \n4 \n { \n5 \n \"clientId\": \"{id-of-your-recaptcha-key}\", \n6 \n \"clientSecret\": \"{secret-key}\", \n7 \n \"projectId\": \"{id-of-your-google-cloud-project}\", \n8 \n \"label\": \"{key-name-in-vtex}\", \n9 \n \"score\": \"{recaptcha-score}\" \n10 \n } \n11 \n ], \n12 \n … \n13 \n} \n` \n * `recaptchaKeys`: array of objects with keys information. \n * `clientId`: ID of your reCAPTCHA key. \n * `clientSecret`: your Google Cloud API key. \n * `projectId`: ID of your Google Cloud project. If you do not have your project ID at hand, check the Google Cloud documentation to learn how to [locate your project ID](https://read.calvincode.net/reader?url=https://support.google.com/googleapi/answer/7014113) \n * `label`: use this field to identify your key. We recommend that you indicate the mobile platform in which you intend to use the key (e.g., `android-001`). \n * `score`: [reCAPTCHA score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha%23recaptcha-score) (optional).\n\nAfter completing this steps, see how you can [integrate reCAPTCHA](#integrating-mobile-apps) on your storefront.\n\n> If you have multiple integrations (e.g., an app for Android and another for iOS), create one key for each and register each one as an object in the `recaptchaKeys` array.\n\n#### Finding your reCAPTCHA key (mobile implementations)\n\nOnce you [create your reCAPTCHA key](#getting-the-recaptcha-key-for-mobile-implementations), it will be available in this address:\n\n`1\n\nhttps://console.cloud.google.com/security/recaptcha?project={projectId} \n\n`\n\nWhen you get to the reCAPTCHA Enterprise page, your reCAPTCHA key is available in the **Key ID** field of the section corresponding with the key you want to use.\n\n\n\n#### Finding your Google Cloud API key (mobile implementations)\n\nOnce you create your [Google Cloud API key](#getting-the-recaptcha-key-for-mobile-implementations), it will be available in this address:\n\n`1\n\nhttps://console.cloud.google.com/apis/credentials?project={projectId} \n\n`\n\n\n\nWhen you get to the credentials page, click **SHOW KEY** on the line corresponding to the key you wish to use.\n\n### Getting the reCAPTCHA key in web-based implementations\n\nIf you are implementing a web-based storefront, you must get the reCAPTCHA key from the checkout API you use to place the order.\n\nThere are two different ways of placing orders via API. It can be done through the [orderForm transaction endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/transaction) or the [Place order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders).\n\nThe first is based on a pre-existing shopping cart (`orderForm`), while the latter requires passing all of the order’s information in a single request body. Because of that distinction, different integrations must use different methods to obtain the reCAPTCHA key.\n\nAt this stage you must choose a key compatible with your desired implementation:\n\n* `recaptchaKey`: if you are integrating with [reCAPTCHA checkbox (equivalent to v2)](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/display).\n* `recaptchaKeyV3`: if you are integrating with [score-based reCAPTCHA (equivalent to v3)](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/v3).\n\n> Learn more about the different versions of [reCAPTCHA for VTEX Checkout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP).\n\n#### orderForm transaction key\n\nThis method of creating orders is based on existing `orderForm`, meaning a payment method has already been selected and VTEX already knows if reCAPTCHA validation is needed.\n\nWhenever reCAPTCHA validation applies, according to your `recaptchaValidation` [configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm), the Checkout API should respond with a `recaptchaKey` field similar to this:\n\n`1\n\n{ \n\n2\n\n ..., \n\n3\n\n \"recaptchaKey\": \"5Lc5UOBTRDBDBLNo2iOCPG0q7JCUgHUerDIJEHR-\", \n\n4\n\n \"recaptchaKeyV3\": \"6LfnCR8mAAAAAGfsca_MuJ4oXTWJWOJ4TkPFOXzT\" \n\n5\n\n} \n\n`\n\nNow you can use this key to [display the reCAPTCHA widget](#integrating-web-based-storefronts) on your storefront.\n\n#### Place order key\n\nIf a reCAPTCHA validation token is necessary for a given order and this request is made without it, you should get an error response with the `recaptchaKey` in the `fields` object, like in the example below.\n\n`1\n\n{ \n\n2\n\n \"fields\": { \n\n3\n\n \"recaptchaKey\": \"5Lc5UOBTRDBDBLNo2iOCPG0q7JCUgHUerDIJEHR-\", \n\n4\n\n \"recaptchaKeyV3\": \"6LfnCR8mAAAAAGfsca_MuJ4oXTWJWOJ4TkPFOXzT\" \n\n5\n\n }, \n\n6\n\n \"operationId\": \"749dt09-34d3-4b5b-b244-978473d0d373\", \n\n7\n\n \"error\": { \n\n8\n\n \"code\": \"CHK0082\", \n\n9\n\n \"message\": \"ReCAPTCHA necessário. Tente novamente passando o token reCAPTCHA junto com a chave fornecida.\", \n\n10\n\n \"exception\": null \n\n11\n\n } \n\n12\n\n} \n\n`\n\nNow you can use this key to [display the reCAPTCHA widget](#integrating-web-based-storefronts) on your storefront.\n\n## Integrating reCAPTCHA on your storefront\n\nSee below instructions for integrating reCAPTCHA depending on whether you are implementing a [mobile](#integrating-mobile-apps) or [web-based storefront](#integrating-web-based-storefronts).\n\n### Integrating mobile apps\n\nSee the documentation provided by Google to learn how to integrate score-based reCAPTCHA (equivalent to v3) on your mobile app according to the mobile platform of your choice:\n\n* [Android](https://read.calvincode.net/reader?url=https://cloud.google.com/recaptcha-enterprise/docs/instrument-android-apps)\n* [iOS](https://read.calvincode.net/reader?url=https://cloud.google.com/recaptcha-enterprise/docs/instrument-ios-apps)\n\n### Integrating web-based storefronts\n\nHaving obtained the reCAPTCHA key, you can apply validation on your storefront according to the version of reCAPTCHA you are using:\n\n* reCAPTCHA checkbox (equivalent to v2): pass the `recaptchaKey` value you got as the `siteKey` property when displaying the validation widget as described in the [reCAPTCHA v2 documentation](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/display).\n* Score-based reCAPTCHA (equivalent to v3): integrate the validation according to the instructions in the [reCAPTCHA v3 documentation](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/v3).\n\nSince reCAPTCHA application may vary according to payment method, we recommend that the integration is prepared apply the validation after the payment selection step.\n\n## Final validation\n\nAfter the shopper successfully solves the validation, the integration should receive a response token. This token should be included in the API request that places the order, along with the `recaptchaKey` that was used, be it with the [orderForm transaction endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/transaction) or the [Place order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders). The example below works for both cases.\n\n`1\n\n{ \n\n2\n\n ..., \n\n3\n\n \"recaptchaKey\": \"5Lc5UOBTRDBDBLNo2iOCPG0q7JCUgHUerDIJEHR-\", \n\n4\n\n \"recaptchaToken\": \"03AERD8Xp5arKO6-vS76sxlAFIMqCQwHOp2XTKO-DF7HcNZZVVZGJrCmHGIBCywHstiaoOpsdmAUp5pIRVD0hOwSydYvubdor45EmSH37QuBbD4qmKfjyatKTMLpsIfmXSy40kmooZ2_TZAlVH0jnKBH5avX1BdYM4qN2uihVPjlRI1RX6ze05PG3ZDn9RQmjqHLot5jDX16nSLMauiZgCqhFPPZaKXz5qNXi2irsuM6xDIfoju50wKp9fJkDmY5eyT4_1iqEVOYkGjMq8hAorY2B6KmaiqxOYWwOPwyrPYP1sFbELO2teGeFYCuxqjOSi7Zq22xEYqQhWGeFHmu4L0ydfhbk3cHnHEyYdQpr3gaG-wHK2dVI1cMD6MYYiLwDfxZ_LgdruW7O-fT12WZCtZhUrwrefaw53hQ\" \n\n5\n\n} \n\n`\n\n> You must send the key used to display the challenge that was solved in the field `recaptchaKey` regardless of the reCAPTCHA version of the key previously used.\n\n## Handling errors\n\nThe reCAPTCHA token is valid for only one attempt. So in case of error during validation, the widget has to be displayed again to the shopper, in order to get a new token. The key used to display the validation widget after the error may vary depending on the error and order placement method, as described below.\n\n### orderForm transaction errors\n\nIn case of internal error (`status 500`), the widget has to be displayed using the `recaptchaKey` from the latest updated `orderForm`.\n\nIf validation fails (`status 403`), the API returns the same error `CHK0082` as mentioned above. Note that the `recaptchaKey` returned in the error may be different than the one used previously.\n\n### Place order errors\n\nIn case of internal error (`status 500`), the widget has to be displayed again. The `recaptchaKey` that was used the first time may be used this time.\n\nIf validation with the [Place order endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23put-/api/checkout/pub/orders) fails (`status 403`), the API returns the same error `CHK0082` as mentioned above. Note that the `recaptchaKey` returned in the error may be different than the one used previously. Be sure to use the latest one received.\n\nContributors\n\n4\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/georgebrindeiro)\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/implementing-recaptcha-in-integrations.md)\n\n[Applicable cases« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations//docs/guides/applicable-cases)[CatalogNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations//docs/guides/catalog-integration)\n\nContributors\n\n4\n\n[](https://github.com/PedroAntunesCosta)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/georgebrindeiro)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Getting the reCAPTCHA key](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23getting-the-recaptcha-key)\n\n[Getting the reCAPTCHA key for mobile implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23getting-the-recaptcha-key-for-mobile-implementations)[Getting the reCAPTCHA key in web-based implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23getting-the-recaptcha-key-in-web-based-implementations)\n\n[Integrating reCAPTCHA on your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23integrating-recaptcha-on-your-storefront)\n\n[Integrating mobile apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23integrating-mobile-apps)[Integrating web-based storefronts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23integrating-web-based-storefronts)\n\n[Final validation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23final-validation)\n\n[Handling errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23handling-errors)\n\n[orderForm transaction errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23orderform-transaction-errors)[Place order errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23place-order-errors)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/recaptcha/implementing-recaptcha-in-integrations.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting the reCAPTCHA key](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23getting-the-recaptcha-key)\n\n[Getting the reCAPTCHA key for mobile implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23getting-the-recaptcha-key-for-mobile-implementations)[Getting the reCAPTCHA key in web-based implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23getting-the-recaptcha-key-in-web-based-implementations)\n\n[Integrating reCAPTCHA on your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23integrating-recaptcha-on-your-storefront)\n\n[Integrating mobile apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23integrating-mobile-apps)[Integrating web-based storefronts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23integrating-web-based-storefronts)\n\n[Final validation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23final-validation)\n\n[Handling errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23handling-errors)\n\n[orderForm transaction errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23orderform-transaction-errors)[Place order errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations/docs/guides/implementing-recaptcha-in-integrations%23place-order-errors)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_01087a89
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "How do I use the VTEX storefront permissions app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-suite)\n\n[Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions)\n\n[Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions-ui)\n\n[B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-organizations)\n\n[B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-checkout-settings)\n\n[B2B Orders History](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-orders-history)\n\n[B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-quotes)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/vtex-io-apps)\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-suite)\n\nStorefront Permissions\n\nOfficial extension\n\nVersion: 3.2.1\n\nLatest version: 3.2.1\n\n[](#contributors-)\n\n> The **Storefront Permissions** app is part of VTEX’s [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-suite) solution, which is a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships. We recommend that you use it alongside the other apps in this suite for all functionalities to work as expected.\n\nWhen navigating a B2B store as a customer, it is common for a main user from an organization to have other people under their structure, each with their own information and access privileges.\n\nWithin an organization, each user can have different roles, such as a professional buyer that places orders with budget limits from a predefined cost center or a manager in charge of reviewing and approving orders. These roles can be associated with multiple permissions, depending on the actions this user needs to perform.\n\nThe **Storefront Permissions** app stores a predefined set of roles and app permissions related to what B2B users can access and do in your storefront, making this information available for other integrated apps to check. This is useful for stores who want to set specific app permissions for users with different roles in an organization.\n\n## Available storefront roles\n\nIn the following table, you can see the available storefront roles, their key used for identification in the app’s code, and their description.\n\n| **Role** | **Key** | **Description** |\n| --------------------- | -------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Store Admin | store-admin | Store administrator, also known as a user who has access to the VTEX Admin, including the permission to impersonate any company/buyer. |\n| Sales Admin | sales-admin | Sales administrator user who can manage all sales users. |\n| Sales Manager | sales-manager | Sales manager user who can manage sales users in the same organization, as well as assist or impersonate buyers during navigation or purchase. |\n| Sales Representative | sales-representative | Sales representative user who can assist or impersonate buyers in the same cost center during navigation or purchase. |\n| Organization Admin | customer-admin | Main organization user who manages the organization information, as well as its members and cost centers. |\n| Organization Approver | customer-approver | Organization user who can take a saved cart or quote that was created by an **Organization Buyer** and use it to place an order. |\n| Organization Buyer | customer-buyer | Organization user who has the ability to add items to cart. If the **B2B Quotes** app is installed, they are also able to save their cart for future use or create a quote. |\n\n## How it works\n\n**Storefront Permissions** communicates automatically with other [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-suite) apps, such as [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations), where it enables different organization management capabilities depending on each user’s role.\n\nIt also allows you to configure available permissions when developing your own app, associate them with the predefined roles, and have these permissions checked by other applications – if you perform the steps described in the [Advanced app integration](#advanced-app-integration-optional) section.\n\nThe **Storefront Permissions** app does not contain an interface – it operates “backstage”, storing the predefined roles and serving as a bridge to communicate with other apps in order to check user permissions. If you would like to manage roles and app permissions using the VTEX Admin interface, you must also install the [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions-ui) app. As an optional feature, you can install the [Admin Customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-admin-customers) app for additional customer management capabilities.\n\n## Before you start\n\nMake sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-install) installed in your machine.\n\nIf you opt to develop your own app and [integrate](#advanced-app-integration-optional) it with **Storefront Permissions**, read our documentation on [Developing an app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-developing-an-app).\n\n## Installation\n\nYou can install the app by running `vtex install vtex.storefront-permissions` in your terminal, using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).\n\n## Advanced app integration \\[optional\\]\n\nIf you would like to develop your own app and integrate it with **Storefront Permissions**, follow the steps below.\n\n1. Open your app’s repository.\n2. In the `manifest.json` file, add `vtex.storefront-permissions` under the `builders` property, as follows. \n`1 \n\"builders\": { \n2 \n\"vtex.storefront-permissions\": \"1.x\" \n3 \n} \n`\n3. In the root folder, create a new folder named `vtex.storefront-permissions`.\n4. In the `vtex.storefront-permissions` folder, create a `configuration.json` file. The content of this file should follow the format below. Keep in mind that you must replace the example information with the `name` of your app and its `features`. \n`1 \n{ \n2 \n \"name\": \"My awesome app\", \n3 \n \"features\": [ \n4 \n { \n5 \n \"label\": \"View\", \n6 \n \"value\": \"view-awesome-things\", \n7 \n \"roles\": [\"store-admin\",\"sales-admin\",\"sales-manager\",\"sales-representative\",\"customer-admin\",\"customer-approver\",\"customer-buyer\"] \n8 \n }, \n9 \n { \n10 \n \"label\": \"Create\", \n11 \n \"value\": \"create-awesome-things\", \n12 \n \"roles\": [\"store-admin\",\"sales-admin\",\"sales-manager\",\"sales-representative\"] \n13 \n }, \n14 \n { \n15 \n \"label\": \"Delete\", \n16 \n \"value\": \"delete-awesome-things\", \n17 \n \"roles\": [\"store-admin\",\"sales-admin\",\"sales-manager\",\"sales-representative\"] \n18 \n }, \n19 \n { \n20 \n \"label\": \"Special Access\", \n21 \n \"value\": \"allow-special-access\", \n22 \n \"roles\": [\"store-admin\",\"sales-admin\"] \n23 \n } \n24 \n ] \n25 \n} \n` \nBelow you can find a description of each property. \n| **Property** | **Type** | **Description** | \n| ------------ | ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | \n| name | string | Name of your app. | \n| features | array of objects | List of features related to your app – the functionalities of your app that you want to set permissions for users to be able to access or not. | \n| ⤷ | object | Object containing information about each feature of your app. | \n| ⤷ label | string | Name or description of the feature. | \n| ⤷ value | string | Identifier key you want to use for the feature, as used in your app’s [custom storefront components](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-developing-custom-storefront-components). Do not use space or special characters in this field. | \n| ⤷ roles | array of strings | List with the keys for all the roles you want to associate with the permission to use the feature by default. You can find more information about each role and its key in the [Available Storefront Roles section](#available-storefront-roles) of this documentation. |\n5. Make sure you refer to the `value` – the identifier key – for each feature you want to set permissions for in your [custom storefront components](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-developing-custom-storefront-components)’ code, when developing your app. \nExample: in the B2B Organizations app, one of the permissions created is represented by the following object. \n`1 \n{ \n2 \n \"label\": \"Create Cost Center\", \n3 \n \"value\": \"create-cost-center-organization\", \n4 \n \"roles\": [\"store-admin\",\"sales-admin\",\"customer-admin\"] \n5 \n} \n` \nTherefore, in a [custom storefront component’s code](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-organizations/blob/366a28add226eac5d9b104bb13a9f2cd1d574f02/react/components/CostCenterDetails.tsx) in TypeScript, whenever referring to this feature, it uses `create-cost-center-organization`.\n\nOnce you are done developing and installing your own app, if you have [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions-ui), the features of your app associated with each role will be automatically loaded on the **Storefront Permissions** page. For more details on this, read our documentation on the [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-storefront-permissions-ui) app.\n\n### Session Watcher\n\nThe session watcher is based in the [session transformation feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-collecting-user-session-data%23configuring-vtexsession) to update the cart fields with Buyer [Organization data](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/b2b-organizations): `Shipping Address`, `Profile` and `Marketdata` ( `utmCampaign` with `organization.id` and `utmMedium` with `costCenter.id` )\n\nTo activate it, [use the mutation](#setSessionWatcher).\n\n### GraphQL queries\n\nNow that your app is integrated, you can write a GraphQL query on your app to check the current user's permission within the context of your app.\n\nFirst, you need to associate your test user to a Role containing your app's permission by following the [B2B Organizations documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations%23users).\n\nIt is not necessary to declare your app name nor user credentials, the query will take care of these details.\n\n#### checkUserPermission\n\nThis query allows you to check which permissions a user has in the context of your app. When the query is performed, **Storefront Permissions** checks which app the request is coming from, and returns the current user's permissions for that specific app.\n\nThe response will be a list with all the permissions the current user has on the app.\n\nSample query:\n\n`1\n\nquery permissions { \n\n2\n\n checkUserPermission @context(provider: \"vtex.storefront-permissions\") { \n\n3\n\n role { \n\n4\n\n id \n\n5\n\n name \n\n6\n\n slug \n\n7\n\n } \n\n8\n\n permissions \n\n9\n\n } \n\n10\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\":{ \n\n3\n\n \"checkUserPermission\": { \n\n4\n\n \"role\": { \n\n5\n\n \"id\": \"00549c22-f39d-11eb-82ac-0a55b612700f\", \n\n6\n\n \"name\": \"Admin\", \n\n7\n\n \"slug\": \"customer-admin\" \n\n8\n\n }, \n\n9\n\n \"permissions\": [\"view-awesome-things\",\"create-awesome-things\",\"delete-awesome-things\"] \n\n10\n\n } \n\n11\n\n } \n\n12\n\n} \n\n`\n\n#### hasUsers\n\nThis query allows you to check if there are any users associated with a specific role. The response will be a boolean, with `\"hasUsers\": true` if there are users with this role or `false` if there are not.\n\nSample query:\n\n`1\n\nquery hasUsers { \n\n2\n\n hasUsers(slug: \"sales-admin\") \n\n3\n\n @context(provider: \"vtex.storefront-permissions\") \n\n4\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"hasUsers\": true \n\n4\n\n } \n\n5\n\n} \n\n`\n\n#### checkImpersonation\n\nThis query allows you to check if the current user is [impersonating](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations%23impersonate-users) another user, and retrieve information on the impersonated user.\n\nSample query:\n\n`1\n\nquery checkImpersonation { \n\n2\n\n checkImpersonation { \n\n3\n\n firstName \n\n4\n\n lastName \n\n5\n\n email \n\n6\n\n userId \n\n7\n\n error \n\n8\n\n } \n\n9\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"checkImpersonation\": { \n\n4\n\n \"firstName\": \"Andrew\", \n\n5\n\n \"lastName\": \"Smith\", \n\n6\n\n \"email\": \"testemail@mail.com\", \n\n7\n\n \"userId\": \"aaaaa-bbbb-cccc-dddd-eeeee\", \n\n8\n\n \"error\": null \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n#### getSessionWatcher\n\nUsing Session Watcher, **Storefront Permissions** detects changes to the user authentication to trigger changes to its cart and navigation, based on associated price tables, collections, profile information and shipping options.\n\nThis query fetches Session Watcher’s status, that is, whether it is active or not. The response will be a boolean, with `true` meaning that it is enabled or `false` meaning it is disabled.\n\nSample query:\n\n`1\n\nquery getSessionWatcher { \n\n2\n\n getSessionWatcher \n\n3\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"getSessionWatcher\": false \n\n4\n\n } \n\n5\n\n} \n\n`\n\n#### getOrganizationsPaginatedByEmail\n\nThis query allows you to retrieve a paginated list of organizations associated with a specific email. The response includes the organization data along with pagination details such as the current page, page size, and total number of results.\n\nSample query:\n\n`1\n\nquery OrganizationsPaginated($email: String!, $page: Int, $pageSize: Int) { \n\n2\n\n getOrganizationsPaginatedByEmail( \n\n3\n\n email: $email \n\n4\n\n page: $page \n\n5\n\n pageSize: $pageSize \n\n6\n\n ) { \n\n7\n\n data { \n\n8\n\n id \n\n9\n\n organizationStatus \n\n10\n\n costId \n\n11\n\n orgId \n\n12\n\n costCenterName \n\n13\n\n } \n\n14\n\n pagination { \n\n15\n\n page \n\n16\n\n pageSize \n\n17\n\n total \n\n18\n\n } \n\n19\n\n } \n\n20\n\n} \n\n`\n\nSample response:\n\n{ \"data\": { \"getOrganizationsPaginatedByEmail\": { \"data\": \\[ { \"id\": \"00000000-0000-0000-0000-000000000000\", \"clId\": \"00000000-0000-0000-0000-000000000000\", \"costId\": \"00000000-0000-0000-0000-000000000000\", \"orgId\": \"00000000-0000-0000-0000-000000000000\" }, { \"id\": \"00000000-0000-0000-0000-000000000000\", \"clId\": \"00000000-0000-0000-0000-000000000000\", \"costId\": \"00000000-0000-0000-0000-000000000000\", \"orgId\": \"00000000-0000-0000-0000-000000000000\" } \\], \"pagination\": { \"page\": 1, \"pageSize\": 25, \"total\": 2 } } } }\n\n### GraphQL mutation\n\n#### impersonateUser\n\nUsing this mutation, you can inform the `userId` to [impersonate an user](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-organizations%23impersonate-users). To remove impersonation, send an empty `userId` instead.\n\nSample mutation:\n\n`1\n\nmutation impersonateUser($userId: ID) \n\n2\n\n@context(provider: \"vtex.storefront-permissions\") { \n\n3\n\n impersonateUser(userId: $userId) { \n\n4\n\n status \n\n5\n\n message \n\n6\n\n } \n\n7\n\n} \n\n`\n\n#### [](#setSessionWatcher) setSessionWatcher\n\nIf your account is not using `vtex.b2b-organizations` you may want to disable the Session Watcher to avoid unnecessary operations. To do so, set the `active` property to `false` in the mutation exemplified below.\n\nThe response will be a boolean, with `true` for a successful operation or `false` for a failure.\n\nSample mutation:\n\n`1\n\nmutation setSessionWatcher { \n\n2\n\n sessionWatcher(active: false) \n\n3\n\n} \n\n`\n\nSample response:\n\n`1\n\n{ \n\n2\n\n \"data\": { \n\n3\n\n \"sessionWatcher\": true \n\n4\n\n } \n\n5\n\n} \n\n`\n\n[B2B Suite« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.b2b-suite)[Storefront Permissions UINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions-ui)\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[Available storefront roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions%23available-storefront-roles)\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions%23how-it-works)\n\n[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions%23before-you-start)\n\n[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions%23installation)\n\n[Advanced app integration \\[optional\\]](https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions#advanced-app-integration-optional)\n\n[Session Watcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions%23session-watcher)[GraphQL queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions%23graphql-queries)[GraphQL mutation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions/docs/apps/vtex.storefront-permissions%23graphql-mutation)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.