id
stringlengths 12
53
| messages
listlengths 3
3
|
|---|---|
doc_7938fcae
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex google search console in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/updates/release-notes)\n\nSearch Console\n\nVTEX Search Console first-party app\n\n## How to install\n\nOpen the VTEX App Store and install this app on your store.\n\nNow, open the app settings on your admin and fill in your Search Console's Content.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/pixel-apps/vtex-google-search-console.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[How to install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/guides/vtex-google-search-console%23how-to-install)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/pixel-apps/vtex-google-search-console.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[How to install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console/docs/guides/vtex-google-search-console%23how-to-install)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_bf56bfae
|
[
{
"role": "system",
"content": "You are a VTEX 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 accessibility in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-accessibility/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/api-reference)\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-accessibility/docs/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-accessibility/docs/storefront-development)\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-accessibility/docs/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-accessibility/docs/troubleshooting)\n\n[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-accessibility/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-accessibility/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-accessibility/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-performance)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-seo)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/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-accessibility/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-accessibility/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-analytics)\n\n[Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-performance)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-seo)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/storefront-development)\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-best-practices)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility)\n\nAccessibility\n\nMake sure your store is accessible to all by following these best practices for ecommerce accessibility.\n\nThis guide presents accessibility best practices for building the storefront of your VTEX store based on the [Lighthouse accessibility score](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/accessibility/scoring).\n\nAccessibility ensures that websites, tools, and technologies are usable by as many people as possible, including those with disabilities. It focuses on designing and developing content that anyone can perceive, understand, navigate, and interact with it.\n\nThis includes providing text alternatives for images, enabling keyboard navigation, and ensuring compatibility with assistive technologies. The aim is to create a digital environment where all users can equally access information and functionality.\n\nLearn more about strategies, standards, and resources to make your ecommerce website accessible in [W3C Web Accessibility Initiative (WAI)](https://read.calvincode.net/reader?url=https://www.w3.org/WAI/).\n\n## Building your storefront\n\nTo guarantee accessibility in your storefront, implement Accessible Rich Internet Applications (ARIA) attributes correctly, along with other best practices, so all users can navigate and interact with your site.\n\n> Learn more in [Lighthouse accessibility score](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/accessibility/scoring).\n\nSee below key strategies for ensuring accessibility when developing your storefront.\n\n### Use Semantic HTML tags\n\nAlways use semantic HTML tags when possible, as they help screen readers better interpret content.\n\n* Use `<header>`, `<nav>`, `<main>`, `<footer>`, and other semantic elements to enhance accessibility with minimal effort.\n* Use appropriate form elements, such as `<button>` for clickable items, `<input>` for input fields, and `<label>` for form labels.\n\n### Add ARIA attributes\n\nARIA attributes improve accessibility by providing assistive technologies with additional information about the page structure, roles, states, and element properties. Below are the ARIA attributes that have the greatest impact on the Lighthouse accessibility audit.\n\n* `aria-label`: Provides a label for an element, typically when a visible label is absent or insufficient. It's especially useful for non-text elements like icon buttons, form fields without labels, or complex controls. This attribute helps screen readers understand the purpose of an element.\n\n`1\n\n<button aria-label=\"Close modal\">X</button> \n\n`\n\n* `aria-labelledby`: Associates an element with another element that serves as its label. This is particularly useful for linking descriptions or titles with non-text elements, such as in headings.\n\n`1\n\n<div aria-labelledby=\"sectionTitle\"> \n\n2\n\n <h2 id=\"sectionTitle\">Special Offers</h2> \n\n3\n\n <p>Exclusive discounts available!</p> \n\n4\n\n</div> \n\n`\n\n* `aria-hidden`: Indicates that an element and its children aren't visible or perceivable to assistive technologies. It's often used for purely decorative elements that don't provide any meaningful information.\n\n```` 1\n\n<div aria-hidden=\"true\"> \n\n2\n\n <img src=\"decorative-image.jpg\" alt=\"\" /> \n\n3\n\n</div> \n\n4\n\n```html \n\n5\n\n \n6\n\n- `aria-live`: Announces dynamic content changes, particularly in live regions, such as notifications, error messages, or shopping cart updates. The value can be `polite` (announces after the current task) or `assertive` (announces immediately). \n\n7\n\n \n8\n\n```html \n\n9\n\n<div aria-live=\"polite\"> \n\n10\n\n Your cart has been updated. \n\n11\n\n</div> \n\n ````\n\n* `role`: Defines the role of an element, helping screen readers understand its intended behavior. Common roles include `button`, `link`, `alert`, `dialog`, `navigation`, and more. Incorrect or missing roles can make it difficult for users to interact with dynamic content or custom UI elements, such as dropdowns and modals.\n\n`1\n\n<div role=\"dialog\" aria-labelledby=\"dialogTitle\"> \n\n2\n\n <h2 id=\"dialogTitle\">Confirm Action</h2> \n\n3\n\n <button>Close</button> \n\n4\n\n</div> \n\n`\n\n* `aria-expanded`: Indicates the expanded or collapsed state of elements like dropdowns, menus, or accordions.\n\n`1\n\n<button aria-expanded=\"false\" aria-controls=\"menu\"> \n\n2\n\n Toggle Menu \n\n3\n\n</button> \n\n`\n\n* `aria-describedby`: Provides additional descriptive text to an element, often used for form fields or controls that need extra context. The value of this attribute should reference the `id` of a related descriptive element.\n\n`1\n\n<label for=\"email\">Email Address</label> \n\n2\n\n<input type=\"email\" id=\"email\" aria-describedby=\"emailHelp\" /> \n\n3\n\n<span id=\"emailHelp\">We'll never share your email.</span> \n\n`\n\n* `aria-required`: Indicates that an input field is required before submitting a form. It's particularly useful for form fields.\n\n`1\n\n<input type=\"text\" id=\"name\" aria-required=\"true\" /> \n\n`\n\n* `aria-invalid`: Indicates that the value entered in a form field is invalid. For example, it can be used to display form validation errors.\n\n`1\n\n<input type=\"email\" id=\"email\" aria-invalid=\"true\" /> \n\n`\n\n* `aria-controls`: Identifies the elements that are controlled by the current element, like a button controlling a dropdown menu. It's especially useful in dynamic interfaces, as it helps to clarify relationships between elements such as modals, menus, or carousels.\n\n`1\n\n<button aria-controls=\"dropdownMenu\" aria-expanded=\"false\">Open Menu</button> \n\n`\n\n* `area-checked`: Indicates the current state of a checkbox or toggle. For checkboxes, it can have values of `true`, `false`, or `mixed`.\n\n`1\n\n<input type=\"checkbox\" aria-checked=\"false\" /> \n\n`\n\n#### Best practices for ARIA\n\n* **Correct usage:** Make sure ARIA attributes are used where appropriate, but avoid overusing them. Native HTML elements, such as `<button>`, `<form>`, and `<input>`, are already accessible and don't require ARIA roles or attributes.\n* **ARIA IDs must be unique:** Ensure all ARIA IDs used are unique.\n* **ARIA attributes must be valid and error-free:** Verify that ARIA attributes (`aria-*`) have valid values and are free of spelling errors.\n* **ARIA attributes must match their functions:** Ensure that `aria-*` attributes are being used for the correct purpose and correspond to their intended function.\n* **ARIA roles and children must meet requirements:** Ensure that elements with specific ARIA roles (for example, `role=\"treeitem\"`) contain the appropriate child roles as required.\n\n### Multimedia\n\n* **Images include `alt` text:** All images must have descriptive `alt` attributes that provide meaningful content for screen reader users.\n* **`<input type=\"image\">` elements include `alt` text:** Images used within form buttons, such as `<input type=\"image\">`, should also have descriptive `alt` text.\n* **Videos include a track element with captions:** All `<video>` elements must contain a `<track>` element with `kind=\"captions\"` to provide captions for users with hearing impairments.\n\n### Page structure\n\n#### Buttons\n\n* **Buttons must have accessible names:** Buttons must have a clear, accessible name through the `aria-label`, text content, or associated `<label>` tags.\n* **Button text must be understandable:** Button text should clearly communicate the action it will perform.\n\n#### Tables\n\n* **Tables must have headers:** Ensure that `<td>` elements in large tables are associated with one or more table headers (`<th>`).\n\n#### Responsive viewport and scaling\n\n**Don't use `[user-scalable=\"no\"]` in `viewport` meta tag:** The `viewport` meta tag should not prevent users from zooming by setting `user-scalable=\"no\"`. The maximum zoom level (`maximum-scale`) should be at least 5.\n\n#### Performance\n\n**Don't use `<meta http-equiv=\"refresh\">`:** The `<meta http-equiv=\"refresh\">` tag is used to automatically refresh or redirect a web page after a specified amount of time, and it's typically placed within the `<head>` section. Using this meta tag may cause **disruption for screen readers users**, **loss of user context**, and **impact negatively the website SEO**.\n\n## Accessibility in VTEX storefront technologies\n\nTo start building your storefront with VTEX, you can choose between [FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore) or [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework).\n\n> [Legacy CMS Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/1oN446gRGcR2s70RvBCAmj) is no longer available to new VTEX stores.\n\nSee below the accessibility features available for each technology.\n\n### FastStore\n\n* **Lighthouse Metrics:** The accessibility score is monitored using Lighthouse metrics for key pages, such as the homepage, Product Detail Pages (PDP), and Product List Pages (PLP). While the dashboard provides a basic accessibility score, more detailed insights are available in the pull request (PR) analysis.\n\n\n\n* **FastStore UI Component Library:** The components have been developed with accessibility in mind. Each component is designed to enhance accessibility, with sections highlighting best practices. Notable components include Dropdowns, Heros, Buttons, and Checkboxes, which include specific accessibility considerations.\n\n### Store Framework\n\nWhen developing your [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme), follow the best practices in the [Building your storefront](#building-your-storefront) section. Learn how to start developing yours in the [Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3) tutorial.\n\nWhen creating a [Storefront app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io) to your store developed with Store Framework, prioritize accessibility within the creation process to improve the shopping experience for all users. To promote inclusion, key practices are:\n\n* Ensuring keyboard interactivity for all user actions.\n* Applying good color contrast in component styles.\n* Avoiding the use of HTML `<div>` elements where possible to enhance accessibility for screen readers and improve SEO.\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/storefront-best-practices/storefront-accessibility.md)\n\n[Storefront best practices« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility//docs/guides/storefront-best-practices)[AnalyticsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility//docs/guides/storefront-analytics)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Building your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23building-your-storefront)\n\n[Use Semantic HTML tags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23use-semantic-html-tags)[Add ARIA attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23add-aria-attributes)[Multimedia](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23multimedia)[Page structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23page-structure)\n\n[Accessibility in VTEX storefront technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23accessibility-in-vtex-storefront-technologies)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23faststore)[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23store-framework)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/storefront-best-practices/storefront-accessibility.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Building your storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23building-your-storefront)\n\n[Use Semantic HTML tags](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23use-semantic-html-tags)[Add ARIA attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23add-aria-attributes)[Multimedia](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23multimedia)[Page structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23page-structure)\n\n[Accessibility in VTEX storefront technologies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23accessibility-in-vtex-storefront-technologies)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23faststore)[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-accessibility/docs/guides/storefront-accessibility%23store-framework)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_bda512a1
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides seller opt in promotions in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/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/seller-opt-in-promotions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/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[Creating and managing coupons with Promotions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/creating-and-managing-coupons-with-promotions-api)\n\n[Using Policy Engine API on Promotion Alerts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/using-policy-engine-api-on-promotion-alerts)\n\n[Seller Opt-in Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions)\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/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/seller-opt-in-promotions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/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[Creating and managing coupons with Promotions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/creating-and-managing-coupons-with-promotions-api)\n\n[Using Policy Engine API on Promotion Alerts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/using-policy-engine-api-on-promotion-alerts)\n\n[Seller Opt-in Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions)\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides)\n\nPromotions\n\n[Seller Opt-in Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions)\n\nSeller Opt-in for Promotions\n\nThe Seller Opt-in Promotions feature allows sellers to choose whether they want to participate in promotions on the marketplace.\n\n> Adding or removing sellers is not available through the Admin interface. These actions must be performed exclusively via the [Promotions and Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api).\n\n## Creating promotions\n\nYou can create promotions manually in the VTEX Admin or via the API.\n\n### Via Admin\n\n1. In the VTEX Admin, go to **Promotions**.\n2. Click `Create Promotion` in the top right corner of the page.\n3. Choose the desired type of promotion.\n4. Complete the promotion details and, in the **Sellers** field, select the **Participating** option.\n5. Click `Create`.\n\nAfter creating the promotion, you must configure seller participation using the API.\n\n### Via API\n\nUse the [Create or Update Promotion or Tax](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api%23post-/api/rnb/pvt/calculatorconfiguration) endpoint to configure promotions with opt-in.\n\n> To avoid conflicts with the previous seller association model, make sure to set `idSeller` and `idSellerIsInclusive` to `null`.\n\nExample request body with defined sellers:\n\n`1\n\n{ \n\n2\n\n \"idSeller\": null, \n\n3\n\n \"idSellerIsInclusive\": null, \n\n4\n\n \"optIn\": { \n\n5\n\n \"sellers\": [ \n\n6\n\n \"seller-id-1\", \n\n7\n\n \"seller-id-2\" \n\n8\n\n ] \n\n9\n\n }, \n\n10\n\n \n11\n\n \"name\": \"MY PROMOTION\", \n\n12\n\n \"idCalculatorConfiguration\": \"\", \n\n13\n\n \"type\": \"combo\", \n\n14\n\n \"origin\": \"Marketplace\", \n\n15\n\n \"isActive\": true, \n\n16\n\n \"beginDateUtc\": \"2025-05-29T00:00:00.000Z\", \n\n17\n\n \"endDateUtc\": \"2025-05-29T00:30:00.000Z\", \n\n18\n\n \"newOffset\": -3, \n\n19\n\n \"isFeatured\": false, \n\n20\n\n \"listSku1BuyTogether\": [ { \"id\": \"1\", \"name\": \"t-shirt size P\" } ], \n\n21\n\n \"listSku2BuyTogether\": [ { \"id\": \"8\", \"name\": \"t-shirt size M\" } ], \n\n22\n\n \"percentualDiscountValueList1\": 10, \n\n23\n\n \"percentualDiscountValueList2\": 10, \n\n24\n\n \"minimumQuantityBuyTogether\": 1, \n\n25\n\n \"maxUsage\": 0, \n\n26\n\n \"maxUsagePerClient\": 0, \n\n27\n\n \"cumulative\": false, \n\n28\n\n \"accumulateWithManualPrice\": false, \n\n29\n\n \"idSeller\": null, \n\n30\n\n \"idSellerIsInclusive\": null, \n\n31\n\n \"idsSalesChannel\": [], \n\n32\n\n \"areSalesChannelIdsExclusive\": true \n\n33\n\n} \n\n`\n\nExample request body without initially defined sellers:\n\n`1\n\n{ \n\n2\n\n \"idSeller\": null, \n\n3\n\n \"idSellerIsInclusive\": null, \n\n4\n\n \"optIn\": { \n\n5\n\n \"sellers\": [] \n\n6\n\n }, \n\n7\n\n \n8\n\n \"name\": \"MY PROMOTION\", \n\n9\n\n \"idCalculatorConfiguration\": \"\", \n\n10\n\n \"type\": \"combo\", \n\n11\n\n \"origin\": \"Marketplace\", \n\n12\n\n \"isActive\": true, \n\n13\n\n \"beginDateUtc\": \"2025-05-29T00:00:00.000Z\", \n\n14\n\n \"endDateUtc\": \"2025-05-29T00:30:00.000Z\", \n\n15\n\n \"newOffset\": -3, \n\n16\n\n \"isFeatured\": false, \n\n17\n\n \"listSku1BuyTogether\": [ { \"id\": \"1\", \"name\": \"t-shirt size P\" } ], \n\n18\n\n \"listSku2BuyTogether\": [ { \"id\": \"8\", \"name\": \"t-shirt size M\" } ], \n\n19\n\n \"percentualDiscountValueList1\": 10, \n\n20\n\n \"percentualDiscountValueList2\": 10, \n\n21\n\n \"minimumQuantityBuyTogether\": 1, \n\n22\n\n \"maxUsage\": 0, \n\n23\n\n \"maxUsagePerClient\": 0, \n\n24\n\n \"cumulative\": false, \n\n25\n\n \"accumulateWithManualPrice\": false, \n\n26\n\n \"idSeller\": null, \n\n27\n\n \"idSellerIsInclusive\": null, \n\n28\n\n \"idsSalesChannel\": [], \n\n29\n\n \"areSalesChannelIdsExclusive\": true \n\n30\n\n} \n\n`\n\n> If you send invalid IDs, the promotion will still be created, but it won't take effect, as it will be associated with non-existent participating sellers.\n\n## Querying participating sellers\n\nYou can query participating sellers manually in the VTEX Admin or via the API.\n\n### Via Admin participating sellers\n\n1. In the VTEX Admin, go to **Promotions**.\n2. Click the name of the promotion you created.\n3. In the **Sellers** field, view the list of participating sellers.\n\n\n\n### Via API participating sellers\n\nUse the [Get promotion or tax by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api%23get-/api/rnb/pvt/calculatorconfiguration/-idCalculatorConfiguration-) endpoint to query promotion details, including the opt-in configuration.\n\nGET`https://{accountName}.{environment}.com/api/rnb/pvt/calculatorconfiguration/{idCalculatorConfiguration}`\n\nExample response for a promotion without opt-in:\n\n`1\n\n{ \n\n2\n\n \"optIn\": null \n\n3\n\n} \n\n`\n\nExample response for a promotion with opt-in and defined sellers:\n\n`1\n\n{ \n\n2\n\n \"optIn\": { \n\n3\n\n \"sellers\": [\"seller-id-1\", \"seller-id-2\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\nExample response for a promotion with opt-in and no defined sellers:\n\n`1\n\n{ \n\n2\n\n \"optIn\": { \n\n3\n\n \"sellers\": [] \n\n4\n\n } \n\n5\n\n} \n\n`\n\n## Adding or removing participating sellers via API\n\nTo add or remove sellers in an opt-in promotion, use the [Seller Opt-in or Opt-out](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api%23post-/api/rnb/pvt/calculatorconfiguration/-promotionId-/seller-opt) endpoint.\n\nPOST\n\n`1\n\n'/api/rnb/pvt/calculatorConfiguration/{promotionId}/seller-opt?an={accountName}' \n\n2\n\n--header 'if-Match: {lastUpdate}' \n\n3\n\n--data '{ \n\n4\n\n \"sellerIds\": [{sellerIds}], \n\n5\n\n \"operation\": \"{operation}\" \n\n6\n\n}' \n\n`\n\n| Field | Required | Type | Description |\n| ----------- | -------- | ----------------------------- | ------------------------------------------------------------------------------------------------------------------- |\n| promotionId | true | string | ID of the promotion |\n| accountName | true | string | Account that owns the promotion |\n| sellerIds | true | string\\[\\] | List of seller IDs |\n| lastUpdate | true | DateTime | Date and time of the promotion's last modification. Must match the current value, otherwise, the request will fail. |\n| operation | true | OptOperation - OptIn - OptOut | Operation to be performed. |\n\nTo add participating sellers, include their IDs in the request body.\n\nExample request body:\n\n`1\n\n{ \n\n2\n\n \"sellerIds\": [ \n\n3\n\n \"seller-id-1\", \n\n4\n\n \"seller-id-2\" \n\n5\n\n ], \n\n6\n\n \"operation\": \"OptIn\" \n\n7\n\n} \n\n`\n\nTo remove a participating seller, send a new request with the ID of the seller you want to remove.\n\nExample request body:\n\n`1\n\n{ \n\n2\n\n \"sellerIds\": [ \n\n3\n\n \"seller-id-2\" \n\n4\n\n ], \n\n5\n\n \"operation\": \"OptOut\" \n\n6\n\n} \n\n`\n\nExample response body:\n\n`1\n\n{ \n\n2\n\n \"lastModified\": \"2025-01-28T17:50:13+00:00\" \n\n3\n\n} \n\n`\n\nResponse codes:\n\n| Code | Description |\n| ---- | -------------------------------------------------------------------------------------------------------------------- |\n| 200 | Opt-in executed successfully. |\n| 400 | Returned if the IdSellerIsInclusive field of the promotion is set to false. |\n| 401 | Returned if the user doesn’t have the \"Manage External Seller Promotions\" permission. |\n| 412 | Returned if the if-Match header value doesn't match the promotion's lastModified field, causing the request to fail. |\n| 404 | Returned if no non-archived promotion with the specified ID is found. |\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/Promotions/seller-opt-in-promotions.md)\n\n[Using Policy Engine API on Promotion Alerts« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions//docs/guides/using-policy-engine-api-on-promotion-alerts)[How to load test a storeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions//docs/guides/how-to-load-test-a-store)\n\nContributors\n\n1\n\n[](https://github.com/geisecosta)\n\nON THIS PAGE\n\n[Creating promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23creating-promotions)\n\n[Via Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23via-admin)[Via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23via-api)\n\n[Querying participating sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23querying-participating-sellers)\n\n[Via Admin participating sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23via-admin-participating-sellers)[Via API participating sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23via-api-participating-sellers)\n\n[Adding or removing participating sellers via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23adding-or-removing-participating-sellers-via-api)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Promotions/seller-opt-in-promotions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Creating promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23creating-promotions)\n\n[Via Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23via-admin)[Via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23via-api)\n\n[Querying participating sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23querying-participating-sellers)\n\n[Via Admin participating sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23via-admin-participating-sellers)[Via API participating sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23via-api-participating-sellers)\n\n[Adding or removing participating sellers via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-opt-in-promotions/docs/guides/seller-opt-in-promotions%23adding-or-removing-participating-sellers-via-api)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_67bb7e16
|
[
{
"role": "system",
"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 message center api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/message-center-api/)\n\nDKIM Configuration\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/message-center-api/)\n\nDKIM Configuration\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeSearch contact information« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/masterdata-api%23get-/api/dataentities/contact%5Finformation/search)[PoGenerate DKIM keysNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api/docs/api-reference/message-center-api%23post-/api/mail-service/pvt/providers/-EmailProvider-/dkim)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d236d6cd
|
[
{
"role": "system",
"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 similar products variants 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.similar-products-variants/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/api-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.similar-products-variants/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.similar-products-variants/docs/storefront-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.similar-products-variants/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.similar-products-variants/docs/troubleshooting)\n\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.similar-products-variants/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/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.similar-products-variants/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.similar-products-variants/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/advanced-components)\n\n[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.availability-notify)\n\n[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.category-menu)\n\n[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexbr.kitlook)\n\n[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-icons/iconpack)\n\n[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.iframe)\n\n[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexventures.livestreaming)\n\n[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.connector-paypal-commerce-platform)\n\n[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexventures.personal-shopper-free)\n\n[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.product-availability)\n\n[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.product-comparison)\n\n[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.product-gifts)\n\n[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexarg.product-highlight-by-vtex-segment)\n\n[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.product-specification-badges)\n\n[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtexarg.quantity-on-cart)\n\n[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.reviews-and-ratings)\n\n[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.safedata)\n\n[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.seller-selector)\n\n[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.similar-products-variants)\n\n[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-drawer)\n\n[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-locator)\n\n[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-form)\n\n[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-link)\n\n[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-media)\n\n[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-newsletter)\n\n[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-video)\n\n[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.sandbox)\n\n[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.shipping-option-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/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.similar-products-variants/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.similar-products-variants/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.similar-products-variants/docs/vtex-io-apps)\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/guides/advanced-components)\n\nSimilar Products Variants\n\nOfficial extension\n\nVersion: 0.1.1\n\nLatest version: 0.1.1\n\nThe Similar Products Variants app returns similar products related to an SKU so users can select other colors or types of the same product.\n\n\n\n## Before you start\n\n1. Set up similar products in your store’s **Products and SKU.** Access your store’s Admin and go to **Products > Catalog > Products and SKU**.\n2. In **Products and SKU**, in the column **SKU**, click on the desired SKU.\n3. In the field **Similar (Alternative Products)**, type the product name you desire\n\n\n\n1. Then, In **Products and SKU**, in the column **SKU**, click on the one you have added in the last step.\n2. Go to the `Images` tab, and on the field `Label`, type a name to identify the image displayed in the thumbnail through the `imageLabel` prop of the `Similar Products` Variants app.\n\nNow, follow the [app’s configuration below](#configuration) to show the similar products you have set up.\n\n## Configuration\n\n1. Using [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), install the app by running the following:\n\n`1\n\nvtex install vtex.similar-products-variants \n\n`\n\n1. Add the `vtex.similar-products-variants` app to your theme's dependencies in the `manifest.json`\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.similar-products-variants\": “0.x” \n\n3\n\n} \n\n`\n\n1. Add the `similar-products-variants` block to the product template you desire, such as `store.product`, to display a similar product list.\n\n`1\n\n... \n\n2\n\n \"flex-layout.col#right-col\": { \n\n3\n\n \"props\": { \n\n4\n\n \"preventVerticalStretch\": true, \n\n5\n\n \"rowGap\": 0 \n\n6\n\n }, \n\n7\n\n \"children\": [ \n\n8\n\n \"flex-layout.row#product-name\", \n\n9\n\n \"product-rating-summary\", \n\n10\n\n \"flex-layout.row#list-price-savings\", \n\n11\n\n \"flex-layout.row#selling-price\", \n\n12\n\n \"product-installments\", \n\n13\n\n \"product-separator\", \n\n14\n\n \"product-identifier.product\", \n\n15\n\n \"sku-selector\", \n\n16\n\n + \"similar-products-variants\", \n\n17\n\n \"product-quantity\", \n\n18\n\n \"link-seller\", \n\n19\n\n \"product-availability\", \n\n20\n\n \"product-assembly-options\", \n\n21\n\n \"product-gifts\", \n\n22\n\n \"flex-layout.row#buy-button\", \n\n23\n\n \"availability-subscriber\", \n\n24\n\n \"shipping-simulator\", \n\n25\n\n \"share#default\" \n\n26\n\n ] \n\n27\n\n }, \n\n28\n\n \"similar-products-variants\": { \n\n29\n\n \"props\": { \n\n30\n\n \"imageLabel\": \"swatch\" \n\n31\n\n } \n\n32\n\n }, \n\n33\n\n... \n\n`\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| imageLabel | String | The identifier of the image thumbnail displayed for each variant. The identifier is set in the Admin’s Catalog. If the label does not exist or is not defined, the first image is used. | null |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| -------------------- |\n| variants |\n| title |\n| var-wrap |\n| img\\_wrap |\n| img\\_wrap--is-active |\n| img |\n\n[Seller Selector« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.seller-selector)[Store DrawerNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.store-drawer)\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.similar-products-variants/docs/apps/vtex.similar-products-variants%23before-you-start)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.similar-products-variants%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.similar-products-variants/docs/apps/vtex.similar-products-variants%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_efac384e
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore building sections 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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-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/building-sections-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/overrides-overview)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-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/building-sections-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-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/building-sections-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-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/building-sections-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/overrides-overview)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-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/building-sections-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-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/building-sections-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/building-sections-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/building-sections-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore)\n\nDeveloping and overriding UI components\n\nFastStore offers the ability to extend and customize your store components in the following ways:\n\n## Content customization with Headless CMS\n\nChange the behavior of specific components by changing their props in the [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview). In the VTEX Admin, go to **Storefront > Headless CMS** and select the section where the desired component is located. From there, you can customize the component by modifying its props. Find the available props in each native section for customization in the Headless CMS in [list of available native sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections).\n\n> The props changed via Headless CMS overlap the changes made through [override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/building-sections/overriding-components-and-props%23override-native-components-props). For example, if you change a prop through override and also change it using Headless CMS, the final prop's value will be the one added using CMS.\n\n## Theming customization\n\nChange the store theme and component styling using theming and design tokens. For detailed instructions on customizing through these methods, refer to the [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview) and [Styling a Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components) documentation.\n\n## Components and sections customization\n\nYou have the following customization options for components and sections:\n\n| Type of customization | Description |\n| ------------------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [Override native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-component-props) | Modify the behavior of a specific component by passing additional props to it in your store code. |\n| [Override a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-native-component) | Create a new component and override its native equivalent to achieve the desired functionality. |\n| [Create a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) | If the available FastStore native sections do not meet your business requirements, you can create a new section and make it available in the Headless CMS. |\n\n### Considerations for customizing components and sections\n\n### Use for advanced customizations\n\nConsider using overrides when [FastStore design tokens (theming tools)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview%23what-is-theming) or Headless CMS props alone cannot achieve the customization you need. Overrides are suitable for making changes in component behavior or replacing components entirely.\n\n### Manage Analytics\n\nThe [\\_\\_experimentalProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-card) and [SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-search-input) components are FastStore components that need to be customized carefully, since they can affect the triggering of events and impact your [Intelligent Search Analytics](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/analytics--6qRMAHDL9hvv3oE0bh8mA1) store report. To understand how these components can affect store analytics while customizing them, refer to the [List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections).\n\n## API extension\n\nAdd new data to existing queries on the FastStore API by extending it. Refer to the [API extension guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview) for more information.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/overview.mdx)\n\n[Enabling refresh token on FastStore« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/session-enabling-refresh-token)[Section overrideNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/overrides-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Content customization with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23content-customization-with-headless-cms)\n\n[Theming customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23theming-customization)\n\n[Components and sections customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23components-and-sections-customization)\n\n[Considerations for customizing components and sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23considerations-for-customizing-components-and-sections)[Use for advanced customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23use-for-advanced-customizations)[Manage Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23manage-analytics)\n\n[API extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23api-extension)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Content customization with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23content-customization-with-headless-cms)\n\n[Theming customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23theming-customization)\n\n[Components and sections customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23components-and-sections-customization)\n\n[Considerations for customizing components and sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23considerations-for-customizing-components-and-sections)[Use for advanced customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23use-for-advanced-customizations)[Manage Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23manage-analytics)\n\n[API extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overview/docs/guides/faststore/developing-and-overriding-components-overview%23api-extension)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_a8186255
|
[
{
"role": "system",
"content": "You are a VTEX 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 input field in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-overview)\n\nInputField\n\nText fields used to get user inputs.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/InputField)\n\nThe `InputField` is a text field component to get user inputs. The component wraps an [Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-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\nInput w/ Error MessageError Message\n\nInput w/ Action\n\nApply\n\nInput w/ Action and ErrorError Message\n\nInput Disabled\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { InputField } 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/InputField/styles.scss\"; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Examples\n\n### Variants\n\n#### Actionable\n\nExample\n\nCode\n\nInput w/ Action\n\nApply\n\n#### Actionable w/ Error\n\nExample\n\nCode\n\nInput w/ Error MessageError Message\n\n#### Error\n\nExample\n\nCode\n\nInput w/ Action and ErrorError Message\n\n#### Disabled\n\nExample\n\nCode\n\nInput Disabled\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | ----------------------------------------- |\n| \\--fs-input-field-padding | var(--fs-spacing-2) var(--fs-spacing-2) 0 |\n| \\--fs-input-field-color | var(--fs-color-text) |\n| \\--fs-input-field-size | var(--fs-text-size-body) |\n| \\--fs-input-field-border-color | var(--fs-border-color) |\n| \\--fs-input-field-transition-function | var(--fs-transition-function) |\n| \\--fs-input-field-transition-property | var(--fs-transition-property) |\n| \\--fs-input-field-transition-timing | var(--fs-transition-timing) |\n\n### Design tokens: Label\n\n| Local token | Default value/Global token linked |\n| ----------------------------- | --------------------------------- |\n| \\--fs-input-label-padding | 0 var(--fs-spacing-2) |\n| \\--fs-input-field-label-color | var(--fs-color-text-light) |\n| \\--fs-input-field-label-size | var(--fs-text-size-tiny) |\n\n### Design tokens: Button\n\n| Local token | Default value/Global token linked |\n| ------------------------------- | --------------------------------- |\n| \\--fs-input-field-button-height | var(--fs-control-tap-size) |\n\n### Design tokens: Error\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------------------------------------- |\n| \\--fs-input-error-message-margin-top | var(--fs-spacing-0) |\n| \\--fs-input-error-message-size | var(--fs-text-size-legend) |\n| \\--fs-input-error-message-line-height | 1.1 |\n| \\--fs-input-error-message-color | var(--fs-color-danger-text) |\n| \\--fs-input-error-border-color | var(--fs-color-danger-border) |\n| \\--fs-input-error-box-shadow | 0 0 0 var(--fs-border-width) var(--fs-input-error-border-color) |\n| \\--fs-input-error-focus-ring | var(--fs-color-focus-ring-danger) |\n\n### Design tokens: Disabled\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 `InputField` styles using the following data attributes:\n\n`data-fs-input-field`\n\n`data-fs-input-field-error`\n\n`data-fs-input-field-error-message`\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-field |\n| **id\\*** | string | ID to identify input and corresponding label. | |\n| **label\\*** | string | The text displayed to identify input text. | |\n| **error** | string | The error message is displayed when an error occurs. | |\n| **inputRef** | MutableRefObject<HTMLInputElement \\| null> | Component's ref. | |\n| **disabled** | boolean | Specifies that the whole input component should be disabled. | |\n| **actionable** | boolean | Adds a Button to the component. | |\n| **onSubmit** | () => void | Callback function when button is clicked. Required for actionable input.\\* | |\n| **onClear** | () => void | Callback function when clear button is clicked. Required for actionable input.\\* | |\n| **buttonActionText** | string | The text displayed on the Button. Suggestion: maximum 9 characters. | Apply |\n| **displayClearButton** | boolean | Boolean that controls the clear button. | |\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/input-field.mdx)\n\n[IconButton« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-icon-button)[LinkButtonNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-link-button)\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-input-field/docs/guides/faststore/molecules-input-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens)\n\n[Design tokens: Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens-label)[Design tokens: Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens-button)[Design tokens: Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens-error)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23props)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/input-field.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23variants)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens)\n\n[Design tokens: Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens-label)[Design tokens: Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens-button)[Design tokens: Error](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens-error)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23design-tokens-disabled)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-input-field/docs/guides/faststore/molecules-input-field%23props)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b0cff6da
|
[
{
"role": "system",
"content": "You are a VTEX 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 a pre analysis antifraud flow for debit card transactions in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/payments-configuration-guides)\n\n[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/setting-up-the-type-of-interest-rate)\n\n[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/setting-up-merchant-id-in-apple-pay)\n\n[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/cardholder-document-configuration)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\n\n[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/metadata-information-in-payment-transactions)\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/payments-configuration-guides)\n\n[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/setting-up-the-type-of-interest-rate)\n\n[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/setting-up-merchant-id-in-apple-pay)\n\n[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/cardholder-document-configuration)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\n\n[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/metadata-information-in-payment-transactions)\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides)\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/payments-configuration-guides)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\n\nImplementing a pre-analysis anti-fraud flow for debit card transactions\n\nTo provide more protection in transactions processed by debit cards, an initial pre-analysis anti-fraud step can be added to the standard payment transaction flow.\n\nSee below an example of a debit card transaction using the anti-fraud system:\n\n1. **Analyzing initial risk (pre-analysis)**: This flow starts with a pre-analysis carried out by the anti-fraud system using the data forwarded by the payment gateway.\n2. **Authorizing**: If no initial inconsistencies are found, the transaction information is forwarded to the acquirer or another gateway (when applicable).\n3. **Authorized**: Upon initiating the authorization process, the acquirer or other gateway sends the transaction information to the issuing bank. The bank responds whether or not the transaction should be authorized. If it denies the transaction, the payment is **canceled**. If it authorizes, the transaction status changes to **Authorized**.\n4. **Approved**: This status indicates that the transaction was authorized by the issuing bank.\n5. **Analyzing Risk**: After approval of the transaction by the issuing bank, the anti-fraud system works by analyzing the risk of the operation.\n6. **Risk Approved**: If the anti-fraud responds positively, the transaction goes to the **risk approved** status. If the anti-fraud identifies any evidence of fraud, the transaction is **canceled**.\n7. **Settlement of $**: This status indicates that the **settlement** process of a specific amount will be started. It's important to note that, at this stage, the value **has not yet been settled**. What exists is a warning that the process of settling this value will be carried out in the next status.\n8. **Settling**: In this status, the **settlement** attempt actually starts. The systems responsible for that begin the process by which the transaction amount is settled.\n9. **Settled**: When the transaction reaches this status, it means that **the amount was successfully settled**. Now, the payment has already been sent to the store's account.\n10. **Finished**: The transaction reaches the **finished** status when the invoice with the payment amount is issued and linked to the order in the OMS. You should note that even after the settlement finishes successfully, [it is necessary to include the invoice in the order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/faq/why-has-a-transaction-been-successfully-captured-but-not-finalized-in-the-pci-gateway).\n\n\n\n## How to activate the anti-fraud flow for debit card transactions\n\nTo implement the debit card anti-fraud provider flow in your system, during the homologation process, you should contact the [Support VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/support) and request its activation.\n\nUpon your request, our team will add the parameter `shouldUseAntifraudOnDebit` to your provider settings. This is a boolean field, with the default value being `false`.\n\nWhen you set this value to `true`, and a debit card transaction occurs using a payment rule containing an anti-fraud, the anti-fraud provider will be triggered, and the payment flow will be carried out as mentioned in this article.\n\nContributors\n\n2\n\n[](https://github.com/pedro-vasconcellos-vtex)\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Payments/payments-configuration-guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions.md)\n\n[Cardholder document configuration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions//docs/guides/cardholder-document-configuration)[Metadata information in payment transactionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions//docs/guides/metadata-information-in-payment-transactions)\n\nContributors\n\n2\n\n[](https://github.com/pedro-vasconcellos-vtex)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[How to activate the anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions%23how-to-activate-the-anti-fraud-flow-for-debit-card-transactions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Payments/payments-configuration-guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[How to activate the anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions%23how-to-activate-the-anti-fraud-flow-for-debit-card-transactions)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d417eb16
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex io documentation vtex io cli install in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\n[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\n[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-usage)\n\n[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)\n\n[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)\n\n[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\n[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\n[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-usage)\n\n[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)\n\n[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)\n\n[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/app-development)\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n[Installing VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install)\n\nInstalling VTEX IO CLI\n\nInstructions to install VTEX IO CLI in your computer\n\nAccording to your operating system, follow the respective steps to install VTEX IO CLI on your computer.\n\n## MacOS\n\n* **Brew**\n\n> For computers running on an Apple M series chip (M1, M2, etc.), before installing VTEX IO CLI, install [Rosetta](https://read.calvincode.net/reader?url=https://support.apple.com/en-us/HT211861). This enables your computer to use the command-line interface for a Mac with an Intel processor. To install Rosetta, run the following in your terminal: `/usr/sbin/softwareupdate --install-rosetta --agree-to-license`.\n\n1. Install Xcode by running the following command:\n\n`1\n\nxcode-select --install \n\n`\n\n1. Install **Homebrew** by following the instructions on the [**Homebrew website**](https://read.calvincode.net/reader?url=https://brew.sh/index).\n\n\n\n1. Install **VTEX IO CLI** by running the following command:\n\n`1\n\nbrew tap vtex/vtex \n\n2\n\nbrew install vtex \n\n`\n\n## Linux\n\n* **Tarball** \n> Before the installation, check if you have the [curl](https://read.calvincode.net/reader?url=https://curl.se/) command-line tool and library installed on your computer. \nOpen the terminal and run the following command to install VTEX IO CLI.\n\n`1\n\ncurl -L https://vtex.io/vtexcli/install | sh \n\n`\n\n## Windows\n\n* **Installer for Windows** \n 1. Download the appropriate installer for your Windows system ([64-bit installer](https://read.calvincode.net/reader?url=https://vtex.io/vtexcli/install/win-x64); [32-bit installer](https://read.calvincode.net/reader?url=https://vtex.io/vtexcli/install/win-x32)). \n 2. Open the downloaded file and follow the instructions to complete the installation process. \n 3. Run the Windows Terminal with admin permission by right-clicking the Windows Terminal icon and selecting `Run as administrator`. \n 4. Run the following command to complete the installation:\n\n`1\n\nvtex \n\n`\n\nAfter completing these steps, you'll see the following message:\n\n\n\n> Further usage of VTEX IO CLI doesn't require admin permission.\n\n## Installing CLI via NPM\n\nSince VTEX IO CLI is built with [Node.js](https://read.calvincode.net/reader?url=https://nodejs.org/en/), you can install it manually via [npm](https://read.calvincode.net/reader?url=https://www.npmjs.com/package/vtex). This method is recommended only for environments where auto-updating VTEX IO CLI is not ideal.\n\n> We highly recommend using an alternative installation method. If you choose to install VTEX IO CLI via npm, remember that CLI won't update automatically, and the Node version on your computer might conflict with the one used by CLI developers. If you opt for any other installation method, VTEX IO CLI will always be up-to-date, preventing installation issues.\n\nMacOS \n1. Install **Homebrew** by following the instructions on the [**Homebrew website**](https://read.calvincode.net/reader?url=https://brew.sh/index).\n\n\n\n1. Install **Node.js** via Homebrew by running the following command.\n\n`1\n\nbrew install node \n\n`\n\n1. Then, install **Yarn**.\n\n`1\n\nbrew install yarn \n\n`\n\n1. Finally, install **VTEX IO CLI**.\n\n`1\n\nyarn global add vtex \n\n`\n\n \nLinux \n1. Install **Node.js** by running the following command:\n\n`1\n\nsudo apt install nodejs \n\n`\n\n1. Install **Yarn** by following the [Yarn installation](https://read.calvincode.net/reader?url=https://classic.yarnpkg.com/en/docs/install%23gentoo-stable) for Linux.\n2. Install **VTEX IO CLI** by running the following command:\n\n`1\n\nsudo yarn global add vtex \n\n`\n\n \nWindows \n1. Download and install [**Node.js**](https://read.calvincode.net/reader?url=https://nodejs.org/pt-br/download/).\n2. Download and install [**Yarn**](https://read.calvincode.net/reader?url=https://classic.yarnpkg.com/en/docs/getting-started).\n3. Run the Windows Terminal with elevated administrator permission by right-clicking the Windows Terminal icon and selecting `Run as administrator`.\n4. Install **VTEX IO CLI** by running the following command.\n\n`1\n\nyarn global add vtex \n\n`\n\n1. Run the following command to finish the installation.\n\n`1\n\nvtex \n\n`\n\nAfter following the steps, this message will appear.\n\n\n\nYou don't have to be in your admin role for the next step.\n\n \n## Verifying the installation\n\nTo confirm that the installation went as expected, run the following command to check all default commands available in VTEX IO CLI.\n\n`1\n\nvtex \n\n`\n\n\n\n### Troubleshooting\n\nIf you are having problems after installing VTEX IO, see the [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) troubleshooting guide.\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/vtex-io-documentation-vtex-io-cli-install.md)\n\n[VTEX IO CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install//docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)[Updating VTEX IO's CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install//docs/guides/vtex-io-documentation-vtex-io-cli-update)\n\nContributors\n\n2\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[MacOS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23macos)\n\n[Linux](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23linux)\n\n[Windows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23windows)\n\n[Installing CLI via NPM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23installing-cli-via-npm)\n\n[Verifying the installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23verifying-the-installation)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23troubleshooting)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/vtex-io-documentation-vtex-io-cli-install.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[MacOS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23macos)\n\n[Linux](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23linux)\n\n[Windows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23windows)\n\n[Installing CLI via NPM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23installing-cli-via-npm)\n\n[Verifying the installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23verifying-the-installation)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install/docs/guides/vtex-io-documentation-vtex-io-cli-install%23troubleshooting)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f82587da
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides app authentication using auth tokens in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/authentication)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens)\n\nApp authentication using auth tokens\n\nLearn how to use app auth tokens in each context\n\nWhen working on VTEX IO apps, you generally don't make direct requests to VTEX APIs. This is because VTEX IO already provides convenient access to VTEX APIs through predefined [clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). Therefore, using application keys within your app is often unnecessary. If you need to use them, the recommended approach is using authentication tokens.\n\nWe recommend using the VTEX IO [clients package](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients) when possible. With this package, every [client method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-3-implementing-client-methods) has an optional argument called `authMethod`, which accepts one of three authentication options, each indicating which token to use for the request.\n\nThe tokens are available via the VTEX IO context and are associated with different permissions.\n\nYou can import the context in your app as follows: `import { IOContext } as ctx from '@vtex/api'`. See the table below to learn about each token.\n\n| Token | authMethod | Via context | Description | Permissions |\n| ---------------------------------- | ------------ | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| App authentication token (default) | AUTH\\_TOKEN | ctx.authToken | Every VTEX IO app has its own temporary authentication token. We recommend avoiding the use of this app token whenever user tokens are available. | Permissions declared in the [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies) defined in the app's [manifest](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest), where developers must declare precisely what actions are allowed for the app they are building. |\n| Store user token | STORE\\_TOKEN | ctx.storeUserAuthToken | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) with store scope. | Shopper permissions. |\n| Admin user token | ADMIN\\_TOKEN | ctx.adminUserAuthToken | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) with Admin scope. | Administrative permissions as defined by [License Manager roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) associated with the current logged-in user. |\n\nIf your project requires features not provided by the available [clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients), we recommend creating your own clients following the same authentication logic.\n\n> Authenticate app actions with user tokens whenever possible. Currently, app authentication tokens are not subject to [License Manager permissions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). We recommend considering this when defining app architecture and configuring [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies).\n\n## Usage examples\n\nBelow are examples of how to use each token type in a [client definition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients%23step-2-creating-a-custom-client).\n\n### App authentication token\n\nUse the app `authToken` when operations are not linked to a user. In this case, the permission level is defined by [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies) in the app [manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest).\n\n`1\n\nexport class OmsClient extends JanusClient { \n\n2\n\n constructor(ctx: IOContext, options?: InstanceOptions) { \n\n3\n\n super(ctx, { \n\n4\n\n ...options, \n\n5\n\n headers: { \n\n6\n\n ...options?.headers, \n\n7\n\n VtexIdclientAutCookie: ctx.authToken, \n\n8\n\n }, \n\n9\n\n }) \n\n10\n\n } \n\n11\n\n} \n\n`\n\n### Store user token\n\nWhen the app is focused on **store browsing** experience, use `storeUserAuthToken` whenever possible. This way, app permissions will be limited to **shopper** user permissions in the account.\n\n`1\n\nexport class OmsClient extends JanusClient { \n\n2\n\n constructor(ctx: IOContext, options?: InstanceOptions) { \n\n3\n\n super(ctx, { \n\n4\n\n ...options, \n\n5\n\n headers: { \n\n6\n\n ...options?.headers, \n\n7\n\n VtexIdclientAutCookie: ctx.storeUserAuthToken, \n\n8\n\n }, \n\n9\n\n }) \n\n10\n\n } \n\n11\n\n} \n\n`\n\n### Admin user token\n\nWhen the app is focused on **Admin** experience, use `adminUserAuthToken` whenever possible. This way, app permissions will be limited to **Admin** user permissions in the account.\n\n`1\n\nexport class OmsClient extends JanusClient { \n\n2\n\n constructor(ctx: IOContext, options?: InstanceOptions) { \n\n3\n\n super(ctx, { \n\n4\n\n ...options, \n\n5\n\n headers: { \n\n6\n\n ...options?.headers, \n\n7\n\n VtexIdclientAutCookie: ctx.adminUserAuthToken, \n\n8\n\n }, \n\n9\n\n }) \n\n10\n\n } \n\n11\n\n} \n\n`\n\nContributors\n\n3\n\n[](https://github.com/henriquessb)\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/Getting-Started/authentication/app-authentication-using-auth-tokens.md)\n\n[Rotating VTEX API tokens« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens//docs/guides/rotating-vtex-api-tokens)[API authentication using user tokensNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens//docs/guides/api-authentication-using-user-tokens)\n\nSee also\n\n[API authentication using user tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/api-authentication-using-user-tokens)\n\nContributors\n\n3\n\n[](https://github.com/henriquessb)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Usage examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens%23usage-examples)\n\n[App authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens%23app-authentication-token)[Store user token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens%23store-user-token)[Admin user token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens%23admin-user-token)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/authentication/app-authentication-using-auth-tokens.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens%23usage-examples)\n\n[App authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens%23app-authentication-token)[Store user token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens%23store-user-token)[Admin user token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens/docs/guides/app-authentication-using-auth-tokens%23admin-user-token)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_1921ec3e
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides remove all personal data in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/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/remove-all-personal-data/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/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/remove-all-personal-data/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/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/remove-all-personal-data/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/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/remove-all-personal-data/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/remove-all-personal-data/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/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/remove-all-personal-data/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/remove-all-personal-data)\n\nRemove all personal data from 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 remove all personal data from a shopping cart by the API.\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 remove personal data. For more information, access the [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id) guide.\n\nSee below an example of some personal data contained in a shopping cart:\n\n`1\n\n... \n\n2\n\n\"clientProfileData\": { \n\n3\n\n \"email\": \"clark.kent@examplemail.com\", \n\n4\n\n \"firstName\": \"Clark\", \n\n5\n\n \"lastName\": \"Kent\", \n\n6\n\n \"document\": \"44444444444\", \n\n7\n\n \"documentType\": \"cpf\", \n\n8\n\n \"phone\": \"+5511123456789\", \n\n9\n\n \"corporateName\": null, \n\n10\n\n \"tradeName\": null, \n\n11\n\n \"corporateDocument\": null, \n\n12\n\n \"stateInscription\": null, \n\n13\n\n \"corporatePhone\": null, \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\n20\n\n\"availableAddresses\": [ \n\n21\n\n { \n\n22\n\n \"addressType\": \"residential\", \n\n23\n\n \"receiverName\": \"Clark Kent\", \n\n24\n\n \"addressId\": \"ae3173b32bf64663a81fc42b057be211\", \n\n25\n\n \"isDisposable\": true, \n\n26\n\n \"postalCode\": \"70386060\", \n\n27\n\n \"city\": \"Brasília\", \n\n28\n\n \"state\": \"DF\", \n\n29\n\n \"country\": \"BRA\", \n\n30\n\n \"street\": \"Quadra SQS 116 Bloco F\", \n\n31\n\n \"number\": \"101\", \n\n32\n\n \"neighborhood\": \"Asa Sul\", \n\n33\n\n \"complement\": null, \n\n34\n\n \"reference\": null, \n\n35\n\n \"geoCoordinates\": [ \n\n36\n\n -47.925922393798828, \n\n37\n\n -15.832707405090332 \n\n38\n\n ] \n\n39\n\n } \n\n40\n\n] \n\n41\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## Removing all personal data from the shopping cart\n\nTo remove all personal data from a shopping cart, you can use your browser to create a URL based on the `orderFormId` value. See an example below:\n\n* **ordeFormId**: `9620cbb7ebc34ca68a86621428816c5a`\n* **New URL**: `https://{accountname}.{environment.com.br}/checkout/changeToAnonymousUser/9620cbb7ebc34ca68a86621428816c5a`\n\nAfter accessing the URL created in your browser, you will be redirected to the cart page, where all personal data has been removed.\n\n**Important**: The page with the cart without personal information is displayed, because when the URL is accessed, a new orderForm is generated and a new cookie is saved in the browser.\n\n> Alternatively, if you are using a backend or similar implementation, it is also possible to create a new cart (without any personal data) using the [Get current or create a new Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm) endpoint and adding the same items from the previous cart through the [Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/items/update).\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides/remove-all-personal-data.md)\n\n[Remove all items from cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data//docs/guides/remove-all-items-from-cart)[Add cart itemsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data//docs/guides/add-cart-items)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Getting and accessing shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/remove-all-personal-data%23getting-and-accessing-shopping-cart-information)\n\n[Removing all personal data from the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/remove-all-personal-data%23removing-all-personal-data-from-the-shopping-cart)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides/remove-all-personal-data.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/remove-all-personal-data/docs/guides/remove-all-personal-data%23getting-and-accessing-shopping-cart-information)\n\n[Removing all personal data from the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-personal-data/docs/guides/remove-all-personal-data%23removing-all-personal-data-from-the-shopping-cart)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_ff353b80
|
[
{
"role": "system",
"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 dont see my store theme changes in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\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-dont-see-my-store-theme-changes/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/api-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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/docs/storefront-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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/docs/troubleshooting)\n\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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/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-dont-see-my-store-theme-changes/docs/troubleshooting)\n\nDevelopment\n\nI don't see my Store Theme changes\n\nAfter linking your Store Theme app, the changes are not reflected in the workspace.\n\n**Keywords:** Store Theme | Workspace\n\nOnce you [link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app), you should see all your changes live at `https://{workspace}--{accountName}.myvtex.com`. If the changes in your [Store Theme app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) aren't reflecting on your store workspace, check the following solutions to fix your scenario.\n\n## Solution\n\n### My workspace does not reflect changes in Typescript types\n\nThe [vtex link command](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference%23link) doesn't automatically detect changes in [Typescript types](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/2/everyday-types.html). To address this issue, follow these steps:\n\n1. Stop the link process with `vtex unlink`.\n2. Update the Typescript types in your code.\n3. Run `vtex link` to link the app again.\n\n### My endpoint is returning outdated values\n\nIf your endpoint is returning outdated values, consider disabling caching temporarily by setting the `no-cache` option on the endpoint response, as in the following example:\n\n`1\n\nctx.set('Cache-Control', 'no-cache') \n\n`\n\n> Please note that caching is enabled by default to enhance performance. Only use this option during development if a real-time response is necessary. Don't disable caching for production stores by removing the `no-cache` option.\n\n### There is a conflict between the installed and the linked store themes\n\nTo see your changes, the [version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version%23understanding-app-versioning) of the Store Theme you're working on must have the same major as the Store Theme app installed on your account.\n\n1. [Log in to your 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).\n2. [List the apps installed on your account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-listing-an-accounts-apps) by running `vtex ls`.\n3. Check if the major of the Store Theme app installed is different from the one you're developing.\n4. Check if there's another Store Theme app installed on your VTEX account. If there is, uninstall it.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-dont-see-my-store-theme-changes.md)\n\n[I can't install an app with a major other than 0.x« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)[I can't complete a purchase on a FastStore websiteNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting/i-dont-see-my-store-theme-changes%23solution)\n\n[My workspace does not reflect changes in Typescript types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting/i-dont-see-my-store-theme-changes%23my-workspace-does-not-reflect-changes-in-typescript-types)[My endpoint is returning outdated values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting/i-dont-see-my-store-theme-changes%23my-endpoint-is-returning-outdated-values)[There is a conflict between the installed and the linked store themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting/i-dont-see-my-store-theme-changes%23there-is-a-conflict-between-the-installed-and-the-linked-store-themes)\n\nWas this helpful?\n\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-dont-see-my-store-theme-changes.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-dont-see-my-store-theme-changes/docs/troubleshooting/i-dont-see-my-store-theme-changes%23solution)\n\n[My workspace does not reflect changes in Typescript types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting/i-dont-see-my-store-theme-changes%23my-workspace-does-not-reflect-changes-in-typescript-types)[My endpoint is returning outdated values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting/i-dont-see-my-store-theme-changes%23my-endpoint-is-returning-outdated-values)[There is a conflict between the installed and the linked store themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-dont-see-my-store-theme-changes/docs/troubleshooting/i-dont-see-my-store-theme-changes%23there-is-a-conflict-between-the-installed-and-the-linked-store-themes)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0c3d9eb6
|
[
{
"role": "system",
"content": "You are a VTEX 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 workspace in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-workspace)\n\n[Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace)\n\n[Creating a Development workspace for a Legacy CMS store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)\n\n[Creating a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace)\n\n[Workspace behavior with app installations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations)\n\n[Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-workspaces-best-practices)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-workspace)\n\n[Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-creating-a-development-workspace)\n\n[Creating a Development workspace for a Legacy CMS store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-creating-development-workspace-for-cms-legacy)\n\n[Creating a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-creating-a-production-workspace)\n\n[Workspace behavior with app installations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-workspace-behavior-with-app-installations)\n\n[Best practices on workspaces management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-workspaces-best-practices)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/app-development)\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/docs/guides/vtex-io-documentation-workspace)\n\nWorkspace\n\nWorkspaces are environments isolated from each other in terms of app development. They can be understood as different versions of the same VTEX account. In practice, changes performed in a particular workspace do not affect your store's live version or other developers' work.\n\n> If you're used to working with git, think of workspaces as branches.\n\nThere are three main types of workspaces:\n\n* **Development workspace** \\- is mainly used by software developers to draft, build or extend VTEX IO apps and storefront themes. These workspaces provide more development freedom. They allow [linking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app), [installing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app), and [publishing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) VTEX IO apps. They can't handle production traffic, be promoted to master, nor be used for A/B testing.\n* **Production workspace** \\- is mainly used by the quality assurance and development teams to validate VTEX IO apps. These workspaces support production traffic and can be used for [A/B testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing), but linking apps is forbidden. If desired, these workspaces can be [promoted to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-promoting-a-workspace-to-master) to become publicly available for all end-users.\n* **Master workspace** \\- a **unique** production workspace that reflects the content served to the end-users of a store.\n\nDevelopment and production workspaces can be accessed at `https://{workspace}--{account}.myvtex.com`.\n\n\n\n> While each workspace operates independently when it comes to app development, they share the same VTEX platform modules accessible through Admin. Then, any changes made in a specific workspace will be reflected in all others.\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-workspace.md)\n\n[Uninstalling VTEX IO's CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace//docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)[Creating a Development workspaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace//docs/guides/vtex-io-documentation-creating-a-development-workspace)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Reference/concepts/vtex-io-documentation-workspace.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_881f56f9
|
[
{
"role": "system",
"content": "You are a VTEX 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 cart information by id in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-cart-information-by-id/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/api-reference)\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-cart-information-by-id/docs/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-cart-information-by-id/docs/storefront-development)\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-cart-information-by-id/docs/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-cart-information-by-id/docs/troubleshooting)\n\n[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-cart-information-by-id/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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-cart-information-by-id/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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/get-cart-information-by-id/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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-cart-information-by-id/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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-cart-information-by-id/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-cart-information-by-id/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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-cart-information-by-id/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\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-cart-information-by-id/docs/guides/data-protection-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-cart-information-by-id/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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-cart-information-by-id/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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/get-cart-information-by-id/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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/get-cart-information-by-id/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/get-cart-information-by-id/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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-cart-information-by-id/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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-cart-information-by-id/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-cart-information-by-id/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/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-cart-information-by-id/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\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-cart-information-by-id/docs/guides/data-protection-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-cart-information-by-id/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/get-cart-information-by-id)\n\nGet cart information by ID\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 access information for a specific shopping cart by its identification code (`orderFormId`).\n\n## Getting shopping cart ID\n\nThe first step is to get the `orderFormId` of the shopping cart you want to check. You can obtain this information through the [Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm) endpoint. The response body of this request will provide the `orderFormId` of your current cart or, if desired, a new empty cart. See more information at [Get current or create a new cart Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart).\n\n> The `orderFormId` information to be used on VTEX APIs must be obtained only from the [Get current or create a new cart Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm) endpoint. This value cannot be obtained from the Cookies via JavaScript implementation.\n\nIf you only intend to perform test operations (e.g. in Postman), you can use the following procedure:\n\n1. Access the website where a shopping cart is open (the order has not already been concluded).\n2. Go to the **Dev. Tools** screen (press the `F12` key).\n3. Click the **Application** tab, and under **Cookies**, click the name of the site's URL.\n4. In the table, locate the line `checkout.vtex.com` and record the value `_ofid=`. This is the `orderFormId` of the current shopping cart.\n\n\n\n## Accessing shopping cart information\n\nWith the `orderFormId` information available, you must use the [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm/-orderFormId-) endpoint to send the following information through the URL:\n\n* **Path param**: `orderFormId` value.\n* **Query param**: `refreshOutdatedData`. You can set up this query as `false` or `true` to define whether some cart information can be updated by the [Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/items/update) endpoint.\n\nSee a URL example below:\n\n`https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/ede846222cd44046ba6c638442c3505a?refreshOutdatedData=true`\n\nAfter sending the request, the endpoint will return the response body containing the shopping cart information, as shown in the example below:\n\n`1\n\n{ \n\n2\n\n \"orderFormId\": \"ede846222cd44046ba6c638442c3505a\", \n\n3\n\n \"salesChannel\": \"1\", \n\n4\n\n \"loggedIn\": false, \n\n5\n\n \"isCheckedIn\": false, \n\n6\n\n \"storeId\": null, \n\n7\n\n \"checkedInPickupPointId\": null, \n\n8\n\n \"allowManualPrice\": false, \n\n9\n\n \"canEditData\": true, \n\n10\n\n \"userProfileId\": null, \n\n11\n\n \"userType\": null, \n\n12\n\n \"ignoreProfileData\": false, \n\n13\n\n \"value\": 0, \n\n14\n\n \"messages\": [], \n\n15\n\n \"items\": [], \n\n16\n\n \"selectableGifts\": [], \n\n17\n\n \"totalizers\": [], \n\n18\n\n \"shippingData\": null, \n\n19\n\n \"clientProfileData\": { \n\n20\n\n \"email\": null, \n\n21\n\n \"firstName\": null, \n\n22\n\n \"lastName\": null, \n\n23\n\n \"document\": null, \n\n24\n\n \"documentType\": null, \n\n25\n\n \"phone\": null, \n\n26\n\n \"corporateName\": null, \n\n27\n\n \"tradeName\": null, \n\n28\n\n \"corporateDocument\": null, \n\n29\n\n \"stateInscription\": null, \n\n30\n\n \"corporatePhone\": null, \n\n31\n\n \"isCorporate\": false, \n\n32\n\n \"profileCompleteOnLoading\": null, \n\n33\n\n \"profileErrorOnLoading\": null, \n\n34\n\n \"customerClass\": null \n\n35\n\n }, \n\n36\n\n... \n\n`\n\n> For more information about the meaning of each of the fields available in the shopping cart, access the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error code\n\nThe following error may appear as a message in the response body.\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/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides/get-cart-information-by-id.md)\n\n[Get current or create a new cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id//docs/guides/create-a-new-cart)[Remove all items from cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id//docs/guides/remove-all-items-from-cart)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/ricardoaerobr)\n\nON THIS PAGE\n\n[Getting shopping cart ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/get-cart-information-by-id%23getting-shopping-cart-id)\n\n[Accessing shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/get-cart-information-by-id%23accessing-shopping-cart-information)\n\n[Error code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/get-cart-information-by-id%23error-code)\n\n[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/get-cart-information-by-id%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/get-cart-information-by-id.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Getting shopping cart ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/get-cart-information-by-id%23getting-shopping-cart-id)\n\n[Accessing shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/get-cart-information-by-id%23accessing-shopping-cart-information)\n\n[Error code](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/get-cart-information-by-id%23error-code)\n\n[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id/docs/guides/get-cart-information-by-id%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_572e087a
|
[
{
"role": "system",
"content": "You are a VTEX 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 the header and footer blocks by page in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-building-pages)\n\n[Building a Product Details Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-building-a-product-details-page)\n\n[Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts)\n\n[Creating a Black Friday page from template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-creating-a-black-friday-page-from-template)\n\n[Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n[Creating a new custom page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-creating-a-new-custom-page)\n\n[Customizing the Header and Footer blocks by page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework)\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/store-framework-building-pages)\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-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page)\n\nCustomizing the Header and Footer blocks by page\n\nLearn how to customize the header and footer blocks for specific pages within your store.\n\nThe Header and Footer blocks are essential for enhancing navigation and ensuring consistency across your online store, including the homepage, product listings, and checkout. These blocks are typically defined once in the `blocks.jsonc` file and serve as default elements for all other templates in the Store Framework.\n\nHowever, you may want to customize these blocks for specific pages. For instance, you might wish to display a unique Header on your homepage while retaining the default Header for the Order Placed page, or even remove the Footer from product pages entirely to declutter the user interface.\n\nThis guide outlines how to customize these blocks for specific pages within your store.\n\n## Instructions\n\n1. Open your Store Theme project in your preferred code editor.\n2. Find the template you want to customize within the `blocks.jsonc` file.\n3. [Replace](#replacing-the-header-and-footer-blocks) or [remove](#removing-the-header-and-footer-blocks) the Header and Footer blocks according to your needs.\n4. Save your changes and [link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) to see the new configurations reflected on the desired page.\n\n### Replacing the header and footer blocks\n\nTo customize the Header and Footer for a particular template, locate the desired template in the `blocks.jsonc` file and add the following code to override the default blocks:\n\nblocks.jsonc\n\n`1\n\n{ \n\n2\n\n \"store.{templateName}\": { \n\n3\n\n \"parent\": { \n\n4\n\n \"header\": \"{headerBlock}\", \n\n5\n\n \"footer\": \"{footerBlock}\" \n\n6\n\n } \n\n7\n\n } \n\n8\n\n} \n\n`\n\n> Replace `{headerBlock}` and `{footerBlock}` with the actual block names you want to use. Also, replace `{templateName}` with a valid theme template, such as `product`, `search#category`, and `custom`.\n\nIf you wish to override only one block, keep the parent structure and specify the block you want to change. For instance, to customize just the Header, use the following code:\n\nblocks.jsonc\n\n`1\n\n{ \n\n2\n\n \"store.{templateName}\": { \n\n3\n\n \"parent\": { \n\n4\n\n \"header\": \"{headerBlock}\" \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\nYou can then configure the Header and Footer blocks based on your specific requirements for the selected template.\n\nHere’s an example configuration that customizes the Header for a product page:\n\nblocks.jsonc\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"parent\": { \n\n4\n\n \"header\": \"header#product\" \n\n5\n\n } \n\n6\n\n }, \n\n7\n\n \"header#product\": { \n\n8\n\n \"blocks\": [ \n\n9\n\n \"header-layout.desktop\", \n\n10\n\n \"header-layout.mobile\" \n\n11\n\n ] \n\n12\n\n }, \n\n13\n\n \"header-layout.desktop\": { \n\n14\n\n \"children\": [ \n\n15\n\n \"header-row#1-desktop\" \n\n16\n\n ] \n\n17\n\n }, \n\n18\n\n \"header-row#1-desktop\": { \n\n19\n\n \"children\": [\"telemarketing\"], \n\n20\n\n \"props\": { \n\n21\n\n \"fullWidth\": true \n\n22\n\n } \n\n23\n\n } \n\n24\n\n} \n\n`\n\n> For further customization, refer to the [Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-header/) and [Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-footer/) documentation.\n\n### Removing the header and footer blocks\n\nIf you prefer to remove the Header and Footer blocks from a specific template, you can declare the blocks with empty `children` arrays:\n\nblocks.jsonc\n\n`1\n\n{ \n\n2\n\n \"store.custom#noheaderfooter\": { \n\n3\n\n \"parent\": { \n\n4\n\n \"header\": \"header#empty\", \n\n5\n\n \"footer\": \"footer#empty\" \n\n6\n\n }, \n\n7\n\n }, \n\n8\n\n \"header#empty\": { \n\n9\n\n \"blocks\": [ \n\n10\n\n \"header-layout.desktop#empty\", \n\n11\n\n \"header-layout.mobile#empty\" \n\n12\n\n ] \n\n13\n\n }, \n\n14\n\n \"header-layout.desktop#empty\": { \n\n15\n\n \"children\": [] \n\n16\n\n }, \n\n17\n\n \"header-layout.mobile#empty\": { \n\n18\n\n \"children\": [] \n\n19\n\n }, \n\n20\n\n \"footer#empty\": { \n\n21\n\n \"blocks\": [ \n\n22\n\n \"footer-layout.desktop#empty\", \n\n23\n\n \"footer-layout.mobile#empty\" \n\n24\n\n ] \n\n25\n\n }, \n\n26\n\n \"footer-layout.desktop#empty\": { \n\n27\n\n \"children\": [] \n\n28\n\n }, \n\n29\n\n \"footer-layout.mobile#empty\": { \n\n30\n\n \"children\": [] \n\n31\n\n } \n\n32\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/concepts-1/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page.md)\n\n[Creating a new custom page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page//docs/guides/vtex-io-documentation-creating-a-new-custom-page)[Using componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page//docs/guides/store-framework-using-components)\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-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page%23instructions)\n\n[Replacing the header and footer blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page%23replacing-the-header-and-footer-blocks)[Removing the header and footer blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page%23removing-the-header-and-footer-blocks)\n\nWas this helpful?\n\n 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-customizing-the-header-and-footer-blocks-by-page.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page%23instructions)\n\n[Replacing the header and footer blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page%23replacing-the-header-and-footer-blocks)[Removing the header and footer blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page%23removing-the-header-and-footer-blocks)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_965d6fe7
|
[
{
"role": "system",
"content": "You are a VTEX 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 managing performance 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/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-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/managing-performance-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-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/managing-performance-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-overview/docs/guides/faststore/managing-performance-overview)\n\n[Testing server-side rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/managing-performance-testing-server-side-rendering)\n\n[Improving store performance with Preact](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-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/managing-performance-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/managing-performance-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-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/managing-performance-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/managing-performance-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-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/managing-performance-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-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/managing-performance-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-overview/docs/guides/faststore/managing-performance-overview)\n\n[Testing server-side rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/managing-performance-testing-server-side-rendering)\n\n[Improving store performance with Preact](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-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/managing-performance-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/managing-performance-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/managing-performance-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore)\n\nManaging performance\n\nIn the ecommerce business, the performance of your website directly impacts the shoppers' experience. It may affect **sales conversion rate**, **user session time**, and other relevant metrics. Every millisecond counts and influences not only the shopper's decision-making process but also your store's website **rank in search engine results**. Therefore, it is crucial to ensure that your website is as fast and performant as possible, achieving **high scores in [Lighthouse](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/lighthouse/overview) audits**.\n\n## Performance slowdowns\n\nAs the complexity of your project increases, many factors may slow down your website's performance. For this reason, maintaining optimal website performance is a **continuous effort**, which requires some commitments.\n\nSome points of attention are:\n\n* **Third-party scripts:** Third-party scripts are one of the leading causes of performance slowdowns. These scripts fire additional network requests to multiple servers and are likely to block DOM construction, keeping the main thread busy and delaying how quickly pages can render.\n* **Page weight:** Page weight comprises the total size of a web page, including all the resources needed for a page to load (i.e., images, stylesheets, and other static files). The heavier the files and data your website sends to the client, the longer the browser takes to render your page. Hence, reducing page weight is a great opportunity for improving your website performance. \nPage weight issues are related mainly to: \n * Uncompressed files. \n * Unoptimized images. \n * Unoptimized fonts. \n * Unclean code.\n* **HTTP requests:** When a user visits a web page, the browser sends multiple HTTP requests to load all the resources (i.e., images, stylesheets, fonts, etc.) needed to render that web page. Downloading these resources, however, significantly impacts the page's loading time. Therefore, besides optimizing images, compressing files, and reducing download size, it is also important to consider minimizing download frequency.\n* **Render-blocking resources:** Render-blocking resources are scripts, stylesheets, and code files sequentially downloaded, parsed, and executed by the browser. Hence, when the browser faces a render-blocking resource, it stops the entire rendering process until these critical files are processed first. Although these resources take a considerable time for the browser to process, they may not be crucial for the user experience.\n\n## Monitoring tools\n\nThere are several tools available for identifying performance issues and helping improve website performance, such as:\n\n* [Lighthouse](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/lighthouse)/[PageSpeed Insights](https://read.calvincode.net/reader?url=https://developers.google.com/speed/pagespeed/insights/): An open-source automated tool created by Google used to identify common problems related to the quality of a webpage through audits.\n* [SpeedCurve](https://read.calvincode.net/reader?url=https://speedcurve.com/): Live dashboards that monitor web applications' experience across different browsers and platforms and provide visibility over performance.\n* [PartyTown](https://read.calvincode.net/reader?url=https://partytown.builder.io/): A lazy-loaded library to help relocate resource-intensive scripts into a [web worker](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/API/Web%5FWorkers%5FAPI), keeping them off the [main thread](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Glossary/Main%5Fthread).\n* [Google DevTools](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/devtools/): A set of web developer tools built directly into the Google Chrome browser.\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/managing-performance/overview.mdx)\n\n[Managing URLs with redirects and rewrite paths« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)[Testing server-side renderingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/managing-performance-testing-server-side-rendering)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Performance slowdowns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/managing-performance-overview%23performance-slowdowns)\n\n[Monitoring tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/managing-performance-overview%23monitoring-tools)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/managing-performance/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Performance slowdowns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/managing-performance-overview%23performance-slowdowns)\n\n[Monitoring tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/managing-performance-overview/docs/guides/faststore/managing-performance-overview%23monitoring-tools)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_640edc22
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Explain the VTEX api reference vtex id api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-id-api/)\n\nAuthentication\n\nStorefront users\n\nToken renewal\n\nRefresh token (Headless)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-id-api/)\n\nAuthentication\n\nStorefront users\n\nToken renewal\n\nRefresh token (Headless)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PoAdd comment on a task« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-do-api%23post-/tasks/-taskId-/comments)[PoGenerate authentication tokenNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api/docs/api-reference/vtex-id-api%23post-/api/vtexid/apptoken/login)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_00dccbbd
|
[
{
"role": "system",
"content": "You are a VTEX 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 master data crud 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/create-master-data-crud-app/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-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/create-master-data-crud-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-app/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/vtex-io-getting-started)\n\n[Storefront apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/vtex-io-documentation-1-developing-storefront-apps-using-react-and-vtex-io)\n\n[Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-app/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-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/create-master-data-crud-app/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-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/create-master-data-crud-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/create-master-data-crud-app/docs/app-development)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/vtex-io-getting-started)\n\n[Master Data CRUD](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app)\n\nCreating a Master Data v2 CRUD app\n\nLearn how to create a Master Data v2 CRUD apps in VTEX IO.\n\nThis guide will teach you how to build a Master Data v2 CRUD (Create, Read, Update, Delete) application within VTEX IO using the `masterdata` builder. [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/master-data--4otjBnR27u4WUIciQsmkAw) is a native key-document database that allows you to efficiently store, search, expand, and personalize your data. While it is possible to integrate Master Data into any VTEX IO app by connecting to the [Master Data API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23overview), this is not the most efficient approach.\n\nTo streamline your development experience, we recommend leveraging the `masterdata` [builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-builders) to create apps with [Master Data v2](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/master-data--4otjBnR27u4WUIciQsmkAw) features, including data creation, editing, and deletion.\n\n> If you prefer to use Master Data v1, check [Creating a VTEX IO service to interact 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).\n\n## Before you begin\n\nBefore diving into coding your app, it's essential to grasp some fundamental concepts:\n\n* Master Data \n * [Basic components](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23basic-components). \n * [Infrastructure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-infrastructure). \n * [Working with JSON Schemas in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-json-schemas-in-master-data-v2). \n * [Schema lifecycle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-schema-lifecycle).\n* VTEX IO service development \n * [Developing services on VTEX IO](https://read.calvincode.net/reader?url=https://learn.vtex.com/docs/course-service-course-lang-en).\n\n## Instructions\n\nTo create a [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/master-data--4otjBnR27u4WUIciQsmkAw) app, follow these steps:\n\n### Step 1 - Defining the data structure\n\nBefore diving into coding, take time to plan your data structure. Since you will be setting up a VTEX IO service app with a focus on [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/master-data--4otjBnR27u4WUIciQsmkAw)'s basic elements, ensure you have well-defined data entities and written schemas prepared for each entity your app will interact with.\n\nFor each [data entity](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23data-entities) that your app will interact with, plan and prepare its corresponding [JSON schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-json-schemas-in-master-data-v2). See an example below:\n\nSchema example\n\n`1\n\n{ \n\n2\n\n \"$schema\": \"http://json-schema.org/schema#\", \n\n3\n\n \"title\": \"my_schema\", \n\n4\n\n \"type\": \"object\", \n\n5\n\n \"properties\": { \n\n6\n\n \"string_field_example\": { \n\n7\n\n \"type\": \"string\" \n\n8\n\n }, \n\n9\n\n \"number_field_example\": { \n\n10\n\n \"type\": \"number\" \n\n11\n\n }, \n\n12\n\n \"boolean_field_example\": { \n\n13\n\n \"type\": \"boolean\" \n\n14\n\n } \n\n15\n\n }, \n\n16\n\n \"required\": [ \n\n17\n\n \"number_field_example\", \n\n18\n\n \"string_field_example\" \n\n19\n\n ], \n\n20\n\n \"v-default-fields\": [ \n\n21\n\n \"number_field_example\", \n\n22\n\n \"string_field_example\" \n\n23\n\n ] \n\n24\n\n} \n\n`\n\n### Step 2 - Editing the `manifest.json` file\n\n1. Use the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) and run `vtex init` to copy the [service-example](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/service-example) boilerplate files to your computer.\n2. Add the `masterdata` builder to your [manifest file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest).\n\n`1\n\n \"builders\": { \n\n2\n\n ... \n\n3\n\n+ \"masterdata\": \"1.x\", \n\n4\n\n } \n\n`\n\n1. Add the following [policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies) to your app’s `manifest.json` file:\n\n`1\n\n[{ \n\n2\n\n \"name\": \"outbound-access\", \n\n3\n\n \"attrs\": { \n\n4\n\n \"host\": \"api.vtex.com\", \n\n5\n\n \"path\": \"/api/*\" \n\n6\n\n } \n\n7\n\n}, \n\n8\n\n{ \n\n9\n\n \"name\": \"ADMIN_DS\" \n\n10\n\n }] \n\n`\n\n### Step 3 - Using the `masterdata` builder\n\n1. Create a folder named `masterdata` at the root of your app. This will be your Master Data configuration folder.\n2. For each data entity your app interacts with, create a dedicated folder inside the `masterdata` directory.\n3. Within each data entity folder, create a file named `schema.json`. The folder structure should resemble the following:\n\n`1\n\nmasterdata \n\n2\n\n | --myEntity \n\n3\n\n | --schema.json \n\n`\n\n1. Populate the `schema.json` file with the [JSON schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-json-schemas-in-master-data-v2) corresponding to the respective and save your changes. Notice that each data entity must have its own `schema.json` with a valid JSON schema.\n2. In the terminal, run `vtex link` to test your code.\n\nNote that your app creates regular Master Data entities accessible via the [Master Data v2 endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23overview). The naming convention for the entities follows this pattern: `{vendor}_{appName}_{entityName}`.\n\n> Note that each time you install or link a different version of your app, the `masterdata` builder creates a new schema with the app’s name and version. Hence, since Master Data v2 data entities have a limit of 60 schemas per entity, ensure to [delete unused schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23delete-/api/dataentities/-dataEntityName-/schemas/-schemaName-) to prevent from running into issues.\n\n### Step - 4 - Generating TypeScript typings\n\nRun `vtex setup -i` at the root of your project. This command will generate all TypeScript typings for your data entity, making them available for import in your app. You can find them in your `node/node_modules` folder.\n\n> Whenever you change a data entity schema, you must regenerate the TypeScript typings. Hence, if you run into issues related to the data entity typings, try regenerating the typings. Also, ensure to run `vtex setup -i` before releasing your app so that the typings will not be tied to your development workspace.\n\n### Step 5 - Using the `node` builder\n\n1. In the terminal, change to the `node` folder of your app.\n2. Run `yarn add @vtex/clients` to install the `clients` package.\n3. Open the file `node/clients/index.ts` and import the following modules:\n\n`1\n\nimport { masterDataFor } from '@vtex/clients' \n\n2\n\nimport { myEntity } from 'vendor.appName' // Replace with the names of your data entity, store, and app. \n\n`\n\n> When importing your data entity typings from the app, follow the format `{vendor}.{appName}`, as specified in your `manifest.json`. If the app does not recognize the generated typings import, try deleting the `node/node_modules` folder. Then run `yarn` to reinstall dependencies and `vtex setup` to regenerate the typings. Finally, run `vtex link` to check if everything is functioning correctly.\n\n1. In the same `node/clients/index.ts` file, create a new property for the `Clients` class to create a client for your data entity. This represents the data entity you are working with. See this code example:\n\n`1\n\npublic get entity() { \n\n2\n\n return this.getOrSet('entity', masterDataFor<myEntity>('entity')) \n\n3\n\n} \n\n`\n\n### Step 6 - Configuring Master Data triggers\n\nTo configure [Master Data triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2) in your app, follow these steps:\n\n1. Create a folder named `triggers` inside your `masterdata/{dataEntity}` folder.\n2. Create a JSON file inside the `triggers` folder.\n3. Declare your triggers in the JSON file, following the same format described for the `v-triggers` field when [setting up Master Data v2 triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-triggers-on-master-data-v2).\n\n### Step 7 - Creating Master Data functions\n\nNow that your app is set up, you can begin coding Master Data functions, such as saving, editing, retrieving, or deleting data. You can then use these functions in your app’s `resolvers` and `middlewares`.\n\nMaster Data functions are available via global context through `ctx.clients.{entityName}.{function}()`. Below, you can see more details on each function. These functions are equivalent to those performed by [Master Data v2 endpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23overview).\n\n#### Get\n\nThe `get()` function returns a document by its ID. You may specify what fields you want to be returned. If you do not, all fields in the document will be returned.\n\n| **Argument** | **Required** | **Type** | **Description** |\n| ------------ | ------------ | ---------------- | ---------------------------------------------------------------------------------------------- |\n| id | Yes | String | ID of the document you wish to retrieve. |\n| fields | No | Array of strings | List of the names of the fields you wish to be returned. If not sent, all fields are returned. |\n\nExample: Getting a complete document of the `Book` entity.\n\n`1\n\nctx.client.Book.get(id: 'sdfg3543df5g4h3d5fh47d') \n\n`\n\nExample: Getting the name and release date of a given book from the `Book` entity.\n\n`1\n\nctx.client.Book.get(id: 'sdfg3543df5g4h3d5fh47d’, fields:['name', 'releaseDate']) \n\n`\n\n#### Save\n\nThe `save()` function saves a new document to your data entity and returns the generated ID for that new document.\n\nThis function’s arguments follow the format you described when setting up JSON schemas in your [data structure](#data-structure).\n\nExample: Saving a new document to the `Book` data entity.\n\n`1\n\nctx.client.Book.save({ \n\n2\n\n name: 'Dom Quixote', \n\n3\n\n releaseDate: 1605, \n\n4\n\n author: 'Miguel de Cervantes' \n\n5\n\n}) \n\n`\n\n#### Update\n\nThe `update()` function an existing document by ID.\n\n| **Argument** | **Required** | **Type** | **Description** |\n| --------------- | ------------ | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | Yes | String | ID of the document you wish to update. |\n| {document-data} | Yes | Corresponding to the types declared in the schema | This function’s arguments follow the format you described when setting up JSON schemas in your [data structure](#data-structure). Required fields apply even for partial updates. |\n\nExample: Updating a document’s `rating` field in the `Book` entity.\n\n`1\n\nctx.client.Book.udpate( \n\n2\n\n id: 'sdfg3543df5g4h3d5fh47d', \n\n3\n\n { \n\n4\n\n name 'Dom Quixote', \n\n5\n\n rating: 4,5 \n\n6\n\n } \n\n7\n\n) \n\n`\n\n#### Save or update\n\nThe `saveOrUpdate()` function updates an existing document by ID or creates a new document if you do not send an ID.\n\n| **Argument** | **Required** | **Type** | **Description** |\n| --------------- | ------------ | ------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| id | No | String | ID of the document you wish to update. If you send an ID, the document is updated. Otherwise, a new document is created. |\n| {document-data} | Yes | Corresponding to the types declared in the schema | This function’s arguments follow the format you described when setting up JSON schemas in your [data structure](#data-structure). Required fields apply even for partial updates. |\n\nExample: Updating a document’s `rating` field in the `Book` entity.\n\n`1\n\nctx.client.Book.saveOrUpdate( \n\n2\n\n id: ‘sdfg3543df5g4h3d5fh47d’, \n\n3\n\n { \n\n4\n\n name ‘Dom Quixote’, \n\n5\n\n rating: 4,5 \n\n6\n\n } \n\n7\n\n) \n\n`\n\nExample: Saving a new document to the `Book` data entity.\n\n`1\n\nctx.client.Book.saveOrUpdate({ \n\n2\n\n name: 'Dom Quixote', \n\n3\n\n releaseDate: 1605, \n\n4\n\n author: 'Miguel de Cervantes' \n\n5\n\n}) \n\n`\n\n#### Delete\n\nThe `delete()` function deletes a document by ID.\n\n| **Argument** | **Required** | **Type** | **Description** |\n| ------------ | ------------ | -------- | -------------------------------------- |\n| id | Yes | String | ID of the document you wish to delete. |\n\nExample: Deleting a document of the `Book` entity.\n\n`1\n\nctx.client.Book.delete(id: 'sdfg3543df5g4h3d5fh47d') \n\n`\n\n#### Search\n\nThe `search()` function returns an array of documents that satisfy the criteria described in the arguments.\n\n| **Argument** | **Required** | **Type** | **Description** |\n| ------------ | ------------ | ---------------- | ---------------------------------------------------------------------------------- |\n| page | Yes | Integer | Number of the page you wish to retrieve. |\n| pageSize | Yes | Integer | Number of documents that should be returned in each page. |\n| fields | No | Array of strings | Names of the fields you wish to be returned. If not sent, all fields are returned. |\n| where | No | String | Filtering condition. |\n\nExample: Searching names and release dates of all books by the author Miguel de Cervantes.\n\n`1\n\nctx.client.Book.search( \n\n2\n\n pagination: { \n\n3\n\n page: 1, \n\n4\n\n pageSize: 10 \n\n5\n\n }, \n\n6\n\n fields: ['name', 'releaseDate'], \n\n7\n\n where: 'name=Miguel de Cervantes' \n\n8\n\n) \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/vtex-io/App-Guides/create-master-data-crud-app.md)\n\n[7\\. Making your Pixel app publicly available« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app//docs/guides/vtex-io-documentation-8-makingyourpixelapppubliclyavailable)[ManifestNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app//docs/guides/vtex-io-documentation-manifest)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23instructions)\n\n[Step 1 - Defining the data structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-1-defining-the-data-structure)[Step 2 - Editing the manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-2-editing-the-manifestjson-file)[Step 3 - Using the masterdata builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-3-using-the-masterdata-builder)[Step - 4 - Generating TypeScript typings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-4-generating-typescript-typings)[Step 5 - Using the node builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-5-using-the-node-builder)[Step 6 - Configuring Master Data triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-6-configuring-master-data-triggers)[Step 7 - Creating Master Data functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-7-creating-master-data-functions)\n\nWas this helpful?\n\n 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/create-master-data-crud-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23instructions)\n\n[Step 1 - Defining the data structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-1-defining-the-data-structure)[Step 2 - Editing the manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-2-editing-the-manifestjson-file)[Step 3 - Using the masterdata builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-3-using-the-masterdata-builder)[Step - 4 - Generating TypeScript typings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-4-generating-typescript-typings)[Step 5 - Using the node builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-5-using-the-node-builder)[Step 6 - Configuring Master Data triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-6-configuring-master-data-triggers)[Step 7 - Creating Master Data functions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-master-data-crud-app/docs/guides/create-master-data-crud-app%23step-7-creating-master-data-functions)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_237a818d
|
[
{
"role": "system",
"content": "You are a VTEX 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 category menu in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/updates/release-notes)\n\nCategory Menu\n\nCategory Menu app is a store component that shows a department list of the store on an customizable menu, and this app is used by store theme.\n\n## Configuration\n\n1. Add the app to your theme's dependencies on the `manifest.json`, for example:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.category-menu\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `category-menu` block into your theme.\n\n`1\n\n{ \n\n2\n\n \"category-menu\": { \n\n3\n\n \"props\": { \n\n4\n\n \"showAllDepartments\": true, \n\n5\n\n \"showSubcategories\": true, \n\n6\n\n \"menuDisposition\": \"center\", \n\n7\n\n \"departments\": [], \n\n8\n\n \"sortSubcategories\": \"name\" \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n| Prop name | Type | Description | Default Value |\n| ------------------ | ------------ | ----------------------------------------------------------------------------------------- | ------------- |\n| showAllDepartments | Boolean | Shows all departments category in menu | true |\n| menuDisposition | Enum | Indicates the disposition of the menu on the screen. Possible values: left, center, right | center |\n| showSubcategories | Boolean | Decides if the subcategories will be displayed | true |\n| departments | Array(items) | List of departments items to be displayed on the menu | \\[\\] |\n| mobileMode | Boolean | Use this as true to render the category menu in a sidebar | false |\n| sortSubcategories | Enum | Determine how subcategories are sorted. Possible values name | |\n\nItems:\n\n| Prop name | Type | Description |\n| --------- | ------ | --------------------------------------------- |\n| id | Number | The department Id to be displayed on the menu |\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS Handles |\n| ------------------------- |\n| container |\n| departmentLink |\n| departmentList |\n| firstLevelLink |\n| firstLevelLinkContainer |\n| firstLevelList |\n| itemContainer |\n| itemContainer--category |\n| itemContainer--department |\n| menuContainer |\n| secondLevelLink |\n| secondLevelLinkContainer |\n| secondLevelList |\n| section--category |\n| section--department |\n| sidebar |\n| sidebarContainer |\n| sidebarContent |\n| sidebarHeader |\n| sidebarItem |\n| sidebarItemContainer |\n| sidebarOpen |\n| sidebarScrim |\n| submenuItem |\n| submenuList |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/advanced-components/vtex-category-menu.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-category-menu/docs/guides/vtex-category-menu%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/guides/vtex-category-menu%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/advanced-components/vtex-category-menu.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-category-menu/docs/guides/vtex-category-menu%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-category-menu/docs/guides/vtex-category-menu%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_f9098230
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides cardholder document 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/cardholder-document-configuration/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-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/cardholder-document-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/cardholder-document-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/cardholder-document-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/cardholder-document-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/cardholder-document-configuration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-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/cardholder-document-configuration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/payments-configuration-guides)\n\n[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/setting-up-the-type-of-interest-rate)\n\n[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/setting-up-merchant-id-in-apple-pay)\n\n[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/cardholder-document-configuration)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\n\n[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/metadata-information-in-payment-transactions)\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-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/cardholder-document-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/cardholder-document-configuration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-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/cardholder-document-configuration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/payments-configuration-guides)\n\n[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/setting-up-the-type-of-interest-rate)\n\n[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/setting-up-merchant-id-in-apple-pay)\n\n[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/cardholder-document-configuration)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\n\n[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/metadata-information-in-payment-transactions)\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-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/cardholder-document-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/cardholder-document-configuration/docs/guides)\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/payments-configuration-guides)\n\n[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/cardholder-document-configuration)\n\nCardholder document configuration\n\nWhen a customer decides to use a credit or debit card as a payment method for their purchase, in addition to the card data (number, name, expiration date, and CVV code), on some occasions, an identification document from the cardholder may also be requested (example: CPF, Social Security Number). Some payment providers use this information to authorize the transaction and anti-fraud providers to perform fraud analysis.\n\nHowever, in some countries, there are anti-fraud providers that do not require this type of additional document, and local legislation does not encourage the use of this information. Likewise, some people do not have a personal identification document that can be used to prove that they are the owners of the card used in the purchase.\n\nTo allow each anti-fraud provider and merchant to have the autonomy to decide whether or not to request this document, VTEX provides the option to configure the cardholder's document field.\n\n> If the anti-fraud provider wants to keep the use of the cardholder document as \"mandatory\", it is not necessary to perform any of the procedures described in this article.\n\nThe procedures below demonstrate how to configure anti-fraud providers via PPP.\n\n## Configuring cardholder document field - Anti-fraud Provider (PPP)\n\nTo configure the cardholder document field, follow the steps below:\n\n1. In the anti-fraud provider manifest, add the `cardholderDocument` field with one of the following values: \n * `\"required\"`: a cardholder document is required for the purpose of fraud analysis. The field must be displayed at checkout and on [my cards](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-funciona-a-minha-conta--2BQ3GiqhqGJTXsWVuio3Xh%23credit-cards). \n * `\"optional\"`: a cardholder document can be used to complete the fraud analysis but is not required. The merchant must configure if they want to display the field at checkout and on [my cards](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-funciona-a-minha-conta--2BQ3GiqhqGJTXsWVuio3Xh%23credit-cards). Learn more at [Cardholder Document Configuration](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/antifraud-provider--4aZtmdpgFikcsQomWyqAOq%23cardholder-document-configuration). \n * `\"unused\"`: a cardholder document is not required to perform fraud analysis. The field will not be displayed at checkout nor on [my cards](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-funciona-a-minha-conta--2BQ3GiqhqGJTXsWVuio3Xh%23credit-cards).\n\nAnti-Fraud Provider Manifest example:\n\n\n\n1. Access [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support) to open a ticket, and request that the connector on VTEX be updated.\n\n> If the anti-fraud provider wants to keep the use of the cardholder document \"mandatory\", it is not necessary to add the field `cardholderDocument`.\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/Payments/payments-configuration-guides/cardholder-document-configuration.md)\n\n[Setting up Merchant ID in Apple Pay« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration//docs/guides/setting-up-merchant-id-in-apple-pay)[Implementing a pre-analysis anti-fraud flow for debit card transactionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration//docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\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[Configuring cardholder document field - Anti-fraud Provider (PPP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/cardholder-document-configuration%23configuring-cardholder-document-field-anti-fraud-provider-ppp)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Payments/payments-configuration-guides/cardholder-document-configuration.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuring cardholder document field - Anti-fraud Provider (PPP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration/docs/guides/cardholder-document-configuration%23configuring-cardholder-document-field-anti-fraud-provider-ppp)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e2110c65
|
[
{
"role": "system",
"content": "You are a VTEX 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 dropdown in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-overview)\n\nDropdown\n\nShows a list of options or commands.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Dropdown)\n\nThe `Dropdown` component Displays a set of actions/items to the user, usually used to show a menu of options.\n\nExample\n\nCode\n\nDropdown\n\nDropdown Small\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { \n\n2\n\n Dropdown, \n\n3\n\n DropdownItem, \n\n4\n\n DropdownMenu, \n\n5\n\n DropdownButton, \n\n6\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/Dropdown/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### Compound Components\n\n#### Dropdown Item\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | ------------------------------------------------------------------------------- |\n| \\--fs-dropdown-item-min-height | 2.375rem |\n| \\--fs-dropdown-item-padding | var(--fs-spacing-1) var(--fs-spacing-2) var(--fs-spacing-1) var(--fs-spacing-1) |\n| \\--fs-dropdown-item-text-size | var(--fs-text-size-base) |\n| \\--fs-dropdown-item-text-weight | var(--fs-text-weight-regular) |\n| \\--fs-dropdown-item-color | var(--fs-color-link) |\n| \\--fs-dropdown-item-bkg-color | var(--fs-color-tertiary-bkg-light) |\n| \\--fs-dropdown-item-bkg-color-hover | var(--fs-color-primary-bkg-light) |\n| \\--fs-dropdown-item-border-bottom-color | var(--fs-border-color-light) |\n| \\--fs-dropdown-item-icon-min-width | 1.125rem |\n| \\--fs-dropdown-item-icon-margin-right | var(--fs-spacing-0) |\n| \\--fs-dropdown-item-icon-margin-top | calc(-1 \\* var(--fs-spacing-1)) |\n\n#### Dropdown Menu\n\n| Local token | Default value/Global token linked |\n| --------------------------------- | --------------------------------- |\n| \\--fs-dropdown-menu-bkg-color | var(--fs-color-tertiary-bkg) |\n| \\--fs-dropdown-menu-border-radius | var(--fs-border-radius) |\n| \\--fs-dropdown-menu-box-shadow | var(--fs-shadow-hover) |\n\n### Design tokens: Small\n\n| Local token | Default value/Global token linked |\n| ------------------------------------ | ------------------------------------------------------------------------------- |\n| \\--fs-dropdown-item-small-min-height | 1.75rem |\n| \\--fs-dropdown-item-small-padding | var(--fs-spacing-0) var(--fs-spacing-2) var(--fs-spacing-0) var(--fs-spacing-1) |\n| \\--fs-dropdown-item-small-text-size | var(--fs-text-size-1) |\n\n---\n\n## Data attributes\n\nYou can target and override `Dropdown` styles using the following data attributes:\n\n#### Dropdown Item\n\n`data-fs-dropdown-item`\n\n#### Dropdown Menu\n\n`data-fs-dropdown-menu`\n\n`data-fs-dropdown-overlay`\n\n`data-fs-dropdown-menu`\n\n`data-fs-dropdown-menu-size=\"small | regular\"`\n\n#### Dropdown Button\n\n`data-fs-dropdown-button`\n\nThis component inherits [Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button) CSS selectors and styles.\n\n---\n\n## Props\n\n### Dropdown\n\n| Name | Type | Description | Default |\n| ------------- | ------------- | ---------------------------------------------------------- | ----------- |\n| **onDismiss** | () => void | Event emitted when the Dropdown is closed. | |\n| **isOpen** | false \\| true | A boolean value that represents the state of the Dropdown. | |\n| **id** | string | ID to identify Dropdown. | fs-dropdown |\n\n### DropdownItem\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-dropdown-item | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | @deprecated A React component that will be rendered as an icon. |\n| **asChild** | false \\| true | Replace the default rendered element with the one passed as a child, merging their props and behavior. | | | | | | | |\n| **dismissOnClick** | false \\| true | Emit onDismiss event when the component is clicked. | true | | | | | | |\n\n### DropdownMenu\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-dropdown-menu | |\n| **aria-labelledby** | string | Identifies the element (or elements) that labels the current element. @see aria-labelledby https://www.w3.org/TR/wai-aria-1.1/#aria-labelledby | | |\n| **onDismiss** | (event: MouseEvent<Element, MouseEvent> \\| KeyboardEvent<Element>) => void | This function is called whenever the user hits \"Escape\" or clicks outside the dialog. | | |\n| **size** | \"small\" \\| \"regular\" | Specifies the size variant. | regular | |\n| **align** | \"left\" \\| \"right\" | \"center\" | Alignment for the dropdown | left |\n\n### DropdownButton\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-dropdown-button | | | | | | |\n| **asChild** | false \\| true | Replace the default rendered element with the provided child element, merging their props and behavior. | false | | | | | | |\n| **loading** | false \\| true | Boolean that represents a loading state. | | | | | | | |\n| **loadingLabel** | string | Specifies a label for loading state. | | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | @deprecated A React component that will be rendered as an icon. |\n| **iconPosition** | \"left\" \\| \"right\" | @deprecated Specifies where the icon should be positioned | | | | | | | |\n| **size** | \"small\" \\| \"regular\" | Specifies the size variant. | | | | | | | |\n| **disabled** | false \\| true | Specifies that this button should be disabled. | | | | | | | |\n\n---\n\n## Accessibility\n\n### Keyboard Interactions\n\n| Key | Description |\n| --------- | -------------------------------------------------------------------------------------------- |\n| Enter | When focusing on DropdownButton, the Dropdown menu opens and focuses the first DropdownItem. |\n| ArrowDown | When focusing on an item, moves focus to the next DropdownItem. |\n| ArrowUp | When focusing on an item, moves focus to the previous DropdownItem. |\n| Escape | Closes DropdownMenu and moves focus to DropdownButton. |\n| Home | When DropdownMenu is open, move focus to the first DropdownItem. |\n| End | When DropdownMenu is open, move focus to the last DropdownItem. |\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/dropdown.mdx)\n\n[DiscountBadge« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-discount-badge)[GiftNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-gift)\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-dropdown/docs/guides/faststore/molecules-dropdown%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23design-tokens)\n\n[Compound Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23compound-components)[Design tokens: Small](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23design-tokens-small)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23props)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23dropdown)[DropdownItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23dropdownitem)[DropdownMenu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23dropdownmenu)[DropdownButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23dropdownbutton)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23accessibility)\n\n[Keyboard Interactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23keyboard-interactions)\n\nWas this helpful?\n\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/dropdown.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23design-tokens)\n\n[Compound Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23compound-components)[Design tokens: Small](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23design-tokens-small)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23props)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23dropdown)[DropdownItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23dropdownitem)[DropdownMenu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23dropdownmenu)[DropdownButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23dropdownbutton)\n\n[Accessibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23accessibility)\n\n[Keyboard Interactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-dropdown/docs/guides/faststore/molecules-dropdown%23keyboard-interactions)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_2292e9c1
|
[
{
"role": "system",
"content": "You are a VTEX 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 new cart in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/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/create-a-new-cart/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/docs/guides/remove-all-personal-data)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/add-cart-items)\n\n[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/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/create-a-new-cart/docs/guides/change-price)\n\n[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/ignore-profile-data)\n\n[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/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/create-a-new-cart/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/create-a-new-cart/docs/guides/add-service-to-the-cart)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/checkout-api-overview)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/create-a-new-cart)\n\nGet current or create a new 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 get the information of your current shopping cart (`orderFormId`) or to create a new cart with the API.\n\n## Accessing current shopping cart information\n\nTo access your current shopping cart information, you must use the [Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm) endpoint. In this request, it is not required to send any additional information (path params, query, or body). See this URL example:\n\n`https://{accountName}.{environment}.com.br/api/checkout/pub/orderForm`\n\nAfter sending the request, the endpoint will return the response body containing the information of your current shopping cart, as shown in the example below:\n\n`1\n\n{ \n\n2\n\n \"orderFormId\": \"11c257869e444e7185e61cab475f91bd\", \n\n3\n\n \"salesChannel\": \"1\", \n\n4\n\n \"loggedIn\": false, \n\n5\n\n \"isCheckedIn\": false, \n\n6\n\n \"storeId\": null, \n\n7\n\n \"checkedInPickupPointId\": null, \n\n8\n\n \"allowManualPrice\": false, \n\n9\n\n \"canEditData\": true, \n\n10\n\n \"userProfileId\": null, \n\n11\n\n \"userType\": null, \n\n12\n\n \"ignoreProfileData\": false, \n\n13\n\n \"value\": 0, \n\n14\n\n \"messages\": [], \n\n15\n\n \"items\": [ \n\n16\n\n { \n\n17\n\n \"uniqueId\": \"D1E0949706A3441DA0386929FAB6E7E8\", \n\n18\n\n \"id\": \"2005\", \n\n19\n\n \"productId\": \"3\", \n\n20\n\n \"productRefId\": \"\", \n\n21\n\n \"refId\": null, \n\n22\n\n \"ean\": \"978020137962\", \n\n23\n\n \"name\": \"Weightless Waves Mild Lather Cleanser 50 ml\", \n\n24\n\n \"skuName\": \"50 ml\", \n\n25\n\n \"modalType\": null, \n\n26\n\n \"parentItemIndex\": null, \n\n27\n\n \"parentAssemblyBinding\": null, \n\n28\n\n \"assemblies\": [], \n\n29\n\n \"priceValidUntil\": \"2023-11-07T22:14:44Z\", \n\n30\n\n \"tax\": 0, \n\n31\n\n \"price\": 3190, \n\n32\n\n \"listPrice\": 3190, \n\n33\n\n \"manualPrice\": null, \n\n34\n\n \"manualPriceAppliedBy\": null, \n\n35\n\n \"sellingPrice\": 3107, \n\n36\n\n \"rewardValue\": 0, \n\n37\n\n \"isGift\": false, \n\n38\n\n \"additionalInfo\": { \n\n39\n\n \"dimension\": null, \n\n40\n\n \"brandName\": \"VALDIE&CO\", \n\n41\n\n \"brandId\": \"2000000\", \n\n42\n\n \"offeringInfo\": null, \n\n43\n\n \"offeringType\": null, \n\n44\n\n \"offeringTypeId\": null \n\n45\n\n }, \n\n46\n\n \"preSaleDate\": null, \n\n47\n\n \"productCategoryIds\": \"/2/\", \n\n48\n\n \"productCategories\": { \n\n49\n\n \"2\": \"Computers\" \n\n50\n\n }, \n\n51\n\n \"quantity\": 3, \n\n52\n\n \"seller\": \"cosmetics1\", \n\n53\n\n \"sellerChain\": [ \n\n54\n\n \"cosmetics1\" \n\n55\n\n ], \n\n56\n\n \"imageUrl\": \"http://cosmetics2.vteximg.com.br/arquivos/ids/155401-55-55/ID-001-MAIN.jpg?v=637109313796670000\", \n\n57\n\n \"detailUrl\": \"/weightless-waves-mild-lather-cleanser/p\", \n\n58\n\n \"components\": [], \n\n59\n\n \"bundleItems\": [], \n\n60\n\n \"attachments\": [], \n\n61\n\n \"attachmentOfferings\": [], \n\n62\n\n \"offerings\": [], \n\n63\n\n \"priceTags\": [ \n\n64\n\n { \n\n65\n\n \"name\": \"discount@price-0e45a4e3-6084-4bf9-bff7-0fe8403699fc#ac2d3d37-5845-45a6-9254-191449d6f100\", \n\n66\n\n \"value\": -416, \n\n67\n\n \"rawValue\": -4.160, \n\n68\n\n \"isPercentual\": false, \n\n69\n\n \"identifier\": \"0e45a4e3-6084-4bf9-bff7-0fe8403699fc\", \n\n70\n\n \"owner\": \"cosmetics2\" \n\n71\n\n } \n\n72\n\n ], \n\n73\n\n \"availability\": \"available\", \n\n74\n\n \"measurementUnit\": \"un\", \n\n75\n\n \"unitMultiplier\": 1.0000, \n\n76\n\n \"manufacturerCode\": null, \n\n77\n\n \"priceDefinition\": { \n\n78\n\n \"calculatedSellingPrice\": 3107, \n\n79\n\n \"total\": 15534, \n\n80\n\n \"sellingPrices\": [ \n\n81\n\n { \n\n82\n\n \"value\": 3107, \n\n83\n\n \"quantity\": 4 \n\n84\n\n }, \n\n85\n\n { \n\n86\n\n \"value\": 3106, \n\n87\n\n \"quantity\": 1 \n\n88\n\n } \n\n89\n\n ] \n\n90\n\n } \n\n91\n\n }, \n\n92\n\n... \n\n`\n\n> ️ If you want access to a specific shopping cart (other than your current one) and you already know its `orderFormId`, you can find it through the [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm/-orderFormId-) endpoint. See more information at [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id%23accessing-shopping-cart-information) guide.\n\n## Creating the new shopping cart\n\nTo create a new shopping cart, in the same way that to obtain the information of the current cart, you must use the [Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/orderForm) endpoint. However, in this request, you must also send the query parameter `forceNewCart = true`, as shown in this URL example:\n\n`https://{accountName}.{environment}.com.br/api/checkout/pub/orderForm?forceNewCart=true`\n\nAfter sending the request, the endpoint will return the response body containing the information about the new shopping cart created, as shown in the example below:\n\n`1\n\n{ \n\n2\n\n \"orderFormId\": \"ede846222cd44046ba6c638442c3505a\", \n\n3\n\n \"salesChannel\": \"1\", \n\n4\n\n \"loggedIn\": false, \n\n5\n\n \"isCheckedIn\": false, \n\n6\n\n \"storeId\": null, \n\n7\n\n \"checkedInPickupPointId\": null, \n\n8\n\n \"allowManualPrice\": false, \n\n9\n\n \"canEditData\": true, \n\n10\n\n \"userProfileId\": null, \n\n11\n\n \"userType\": null, \n\n12\n\n \"ignoreProfileData\": false, \n\n13\n\n \"value\": 0, \n\n14\n\n \"messages\": [], \n\n15\n\n \"items\": [], \n\n16\n\n \"selectableGifts\": [], \n\n17\n\n \"totalizers\": [], \n\n18\n\n \"shippingData\": null, \n\n19\n\n \"clientProfileData\": { \n\n20\n\n \"email\": null, \n\n21\n\n \"firstName\": null, \n\n22\n\n \"lastName\": null, \n\n23\n\n \"document\": null, \n\n24\n\n \"documentType\": null, \n\n25\n\n \"phone\": null, \n\n26\n\n \"corporateName\": null, \n\n27\n\n \"tradeName\": null, \n\n28\n\n \"corporateDocument\": null, \n\n29\n\n \"stateInscription\": null, \n\n30\n\n \"corporatePhone\": null, \n\n31\n\n \"isCorporate\": false, \n\n32\n\n \"profileCompleteOnLoading\": null, \n\n33\n\n \"profileErrorOnLoading\": null, \n\n34\n\n \"customerClass\": null \n\n35\n\n }, \n\n36\n\n... \n\n`\n\n> ️ For more information about the meaning of each of the fields available in the shopping cart, access the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.\n\n## Error codes\n\nThe following error may appear as a message in the response body.\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/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/shopping-cart-section-api-quick-start-guides/create-a-new-cart.md)\n\n[Simulate a shopping cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart//docs/guides/simulate-a-shopping-cart)[Get cart information by IDNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart//docs/guides/get-cart-information-by-id)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Accessing current shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/create-a-new-cart%23accessing-current-shopping-cart-information)\n\n[Creating the new shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/create-a-new-cart%23creating-the-new-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/create-a-new-cart%23error-codes)\n\n[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/create-a-new-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/shopping-cart-section-api-quick-start-guides/create-a-new-cart.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Accessing current shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/create-a-new-cart%23accessing-current-shopping-cart-information)\n\n[Creating the new shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/create-a-new-cart%23creating-the-new-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/create-a-new-cart%23error-codes)\n\n[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/create-a-new-cart/docs/guides/create-a-new-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_6fe06e27
|
[
{
"role": "system",
"content": "You are a VTEX 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 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/payments-integration-payment-app/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-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/payments-integration-payment-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/payments-integration-payment-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/payments-integration-payment-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/payments-integration-payment-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/payments-integration-payment-app/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-app/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-app/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-app/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-app/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/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-app/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-app/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-app/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-app/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/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-app/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/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-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---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\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-app/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-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/payments-integration-payment-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/payments-integration-payment-app/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/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-app/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-app/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-app/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-app/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/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-app/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-app/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-app/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-app/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/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-app/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/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-app/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/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-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---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\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-app/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-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/payments-integration-payment-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/payments-integration-payment-app/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-guide)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app)\n\nPayment App\n\n> You can check the demo videos of Payment App on our Office Hours through these links in [English](https://read.calvincode.net/reader?url=https://youtu.be/nrZOZ7LMtLE?t=3119) and [Portuguese](https://read.calvincode.net/reader?url=https://youtu.be/YJ0qSgYiN8c?t=1064).\n\nA Payment App is a special type of app built-in [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) which allows developers to create custom payment experiences on the checkout page, without redirecting customers to an external website.\n\nIn terms of programming, a Payment App is defined as a class in TypeScript that extends from [React’s Component](https://read.calvincode.net/reader?url=https://reactjs.org/docs/react-component.html). You can configure a payment method to use a specific Payment App, and this app is instantiated by the Checkout UI when the payment method is selected in the purchase.\n\nThe main reasons why someone would choose to build a Payment App over a standard [Payments Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-guide) are that it allows you to:\n\n* Implement a payment method through [Payment Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-payment-provider-protocol) without a redirect flow (without redirecting users to an external website).\n* Add a security layer to your store’s online payments using the [3D Secure 2 (3DS2)](https://read.calvincode.net/reader?url=https://help.vtex.com/en/announcements/3ds2-authentication-flow-accept-online-payments-more-securely--6UdTjjVU1AcEQ2aE3Ftxsl) standard.\n* Measure conversions by analytics tools for customized flows.\n\nAs you can see below, the Payment App is displayed as a modal window when the customer clicks on the **Buy now** button:\n\n\n\nThis tutorial will guide you through the steps required to develop, test, and set up a Payment App in your store. The sections of this tutorial are: \n* [Understanding the Payment App flow](#understanding-the-payment-app-flow): An explanation of what a Payment App is, its behavior, and usage.\n* [Implementing a Payment App](#implementing-a-payment-app): A step-by-step guide with the basic information needed to develop a Payment App.\n* [Operational Mode](#operational-mode): After having deployed the Payment App, check more information about the checkout response. Also, learn how to handle an order payload and how to inject external scripts.\n\n> IO apps do not work in headless environments. If you want to process payments in this type of scenario, you must use a checkout [webview](https://read.calvincode.net/reader?url=https://developer.chrome.com/docs/webview) or implement a fully headless integration directly between your system and the acquirer/connector, sending the information via custom payments or promissory notes.\n\n## Understanding the Payment App flow\n\nOur Payment App model applies to a large variety of payment methods thanks to its interaction with the Checkout API, as shown in the following sequence diagram:\n\n\n\nBelow is described the flow in the same order of the sequence diagram (steps from 1 to 4 are the same for every payment flow; steps unique to the Payment App flow are from 5 onwards): \n1. Checkout UI sends a Start Transaction request to the Checkout API.\n2. Checkout API sends a [Start Transaction request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/1createanewtransaction) to the Gateway API. \n * VTEX Payment Gateway creates the new transaction and generates a unique `transactionId`, which is returned to the Checkout, and then to the Checkout UI.\n3. Checkout UI sends a [Send Payments request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/2sendpaymentspublic) directly to the Gateway API. \n * The Gateway will create, for each payment, a payment entity inside the transaction entity that was created in the previous request. Note that, for multiple payments, they are all sent in this same request. That is, one transaction can have multiple payments. For each payment entity, a `paymentId` is generated and all of them are returned to the Checkout UI. This step sends the actual payment information (i.e.: credit card data).\n4. Checkout UI sends an Authorization request to the Checkout API.\n5. Checkout API encapsulates two requests to the Gateway API. \n * The first is the [Send Additional Data request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/3sendadditionaldata) that sends to the Gateway API information about the order, such as the client profile data, the shipping address, and the cart information (cart items). Such information is securely stored in the Gateway database, and this information is used by anti-fraud providers, and also used by a few payment providers to Authorize the transaction. \n * The second is the actual [Authorization request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/4doauthorization) that the Checkout API performs to the Gateway API. This request will trigger the Payment Authorization workflow inside the Gateway API. \n 1. The Gateway API calls the [Create Payment request](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/createpayment) for the correct connector depending on the Payment Conditions that was set up by the store administrator. \n 2. At this point, the connector handles the request and performs its logic depending on the Payment method. Using Pix as an example, the connector will request the Payment Provider to create a payment in their API and will receive the necessary information to build the Pix QR Code. \n 3. The connector responds the Create Payment request to the Gateway. The body of the response has a `paymentAppData` field, which contains two properties. The first is `appName`, which describes the name of the VTEX account responsible for developing, maintaining and distributing the app, and the name of the Payment App that will be used in the transaction (e.g., `\"{vendor}.{appName}\"` ). The second is `payload` containing the payload to complete the transaction (i.e.: the information to build the Pix QR code). Then, the Gateway responds to the Checkout API and it responds back to the Checkout UI which instantiates the Payment App with the corresponding payload that was generated in the connector.\n6. The Checkout UI instantiates the Payment App defined by the `paymentAppData.appName` and adds to the app object the `appPayload` property and fills this property with the content of `paymentAppData.payload`. Then the Payment App can perform its logic here. For instance, it could be an Authorization App (3DS v2) or a QR Code (Pix), or it could simulate a redirection inside the Payment App frame. At this point, the transaction is in Authorizing state (more information about transaction status can be found in the [Transaction flow in Payments](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/transaction-flow-in-payments--Er2oWmqPIWWyeIy4IoEoQ) article).\n7. When the user finishes the interaction, the Payment App closes and it will trigger the transaction Validation in the Checkout UI, which starts the validation where the Checkout UI gets the transaction status from the Checkout API (which will [request the transaction status](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/transactiondetails) from the Gateway API). If the transaction status is **Authorized** or **Undefined** then the Checkout UI displays the Order Placed screen. Else, the Checkout UI shows a warning and returns to the state where the user can choose the payment method.\n\n## Implementing a Payment App\n\nThe following tutorial will guide you through the steps required to implement a Payment App, including:\n\n* Information on how to set up a development environment.\n* Steps to clone the repository that contains a Payment App boilerplate code for you to edit.\n* How to run and test your Payment App.\n* Information about the deployment process.\n\nTo proceed with the following steps, you will be using the [VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-vtex-io) development platform.\n\n> If you are implementing a new payment method in your Payment App, please contact the [VTEX Support Team](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support) to add it to the VTEX backend.\n\n### Step 1: Setting up the development environment\n\n1. Using your computer system terminal, [install the VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) (Command Line Interface).\n2. After installing VTEX IO CLI, check the documentation [Creating a Development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) to create a workspace and start developing the Payment App.\n3. When you finish creating the workspace, jump to the next section.\n\n### Step 2: Developing your Payment App\n\nThese are the minimum things you need to change in the boilerplate and make your own app.\n\nIn addition to these modifications, you need to add the business logic of your payment system.\n\n> Before you start editing the Payment App, it is necessary to have Git installed on your computer. Click [here](https://read.calvincode.net/reader?url=https://git-scm.com/downloads) to learn more.\n\n1. Using your terminal, clone the repository that contains a Payment App model to your local files by running:\n\n`1\n\ngit clone https://github.com/vtex-apps/example-payment-authorization-app.git \n\n`\n\n1. After cloning the repository, use a code editor of your choice to open the project locally.\n2. Open the `manifest.json` file and update its content according to your scenario. If you need more information about the required fields, access our [Manifest documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest). The value set in the `name` field will be the unique identifier for this app and must be the exact name that corresponds to the response of your connector (`appname` property of `paymentAppData` field in the response body of the Create Payment endpoint). The `billingOptions` field is also required and set with the property `type` as `free`. More information about the `billingOptions` 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).\n3. After finishing the update, open the `pages/pages.json` file and replace `example-payment-auth-app` with the app `name` set in `manifest.json`. The `pages.json` file is responsible for creating the routes for your application. So it is necessary to make this configuration for the VTEX system to find and display the app at checkout. Also, the `\"component\"` field having the `\"index\"` value indicates that the `index.js` file in the `react` folder is the file with the component that will be instantiated at checkout.\n\n> Replace only the last part of the path in the `pages.json` file for the name of your app. In this case, the `example-payment-auth-app` part. Do not change the beginning of the path `checkout/transactions/`, since the checkout uses it to identify a payment application.\\\\n\\\\nAlso, if you are using the **Test Connector** to make internal tests with your app, you have to keep the original name of the app that came from the repository in the `pages.json` file, since it will be the reference for this connector to open the Payment App in the checkout.\n\n1. Using your terminal, go to the app directory and run the following command:\n\n`1\n\nvtex link \n\n`\n\nOnce you [link the app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app), your local computer files will sync to our cloud development environment. It means that any change done locally in the code you are working on will be sent to the cloud and reflected in the workspace.\n\n### Step 3: Testing a Payment App flow\n\nA Payment App will appear on the checkout screen by following the steps below, allowing you to test the Payment App general flow.\n\n> Proceed with the following steps only when you want to test a Payment App flow; otherwise, skip to [Step 4: Deploying the Payment app](#step-4-deploying-your-payment-app).\n\n1. Make sure you have your connector installed in your account configured with the Payment App and the payment method you want to test in your Payment App. The connector must contain the field `paymentAppData` in the response body of the [Create Payment endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/createpayment) with the right properties (`\"appName\": \"{vendor}.{appName}\"` and `\"payload\": \"{payload information}\"`). If you do not have the connector installed yet, contact the [VTEX Support Team](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support) to help you with the installation process. More information about how the endpoints should be implemented can be found in the article [Implementing a Payment Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/payments-integration-implementing-a-payment-provider).\n2. Select the payment condition associated with your connector in the checkout and finish the purchase to test the flow.\n\n### Step 4: Deploying your Payment App\n\nOnce you finish the changes, follow our documentation on [Making your new app version publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available) to run your app on the **Master** workspace.\n\n## Operational Mode\n\nIf you followed all the previous steps, it means that you successfully created a Payment App and are ready to take advantage of the benefits of having an additional verification step to the checkout of your store.\n\nThis section discusses the following topics to help you make the best use of the Payment App:\n\n* Handling the order payload.\n* Understanding the response to the Checkout UI.\n* Injecting external scripts.\n\n### Handling the order payload\n\nThe `appPayload` is what the Payment App receives as props, and it consists of a serialized JSON of the order payload. This variable is not declared in the Payment App class, but it is added to its `props` after the Payment App is instantiated in the Checkout UI. You can access this information with the following code:\n\n`1\n\nconst { appPayload } = this.props // This appPayload is a serialized JSON (as string). \n\n`\n\nThe expected content is a JSON object consisting of the Payment App’s data needed for the Payment App to allow or deny an order placement. Thus, the `appPayload` fields will be defined by the developer of the associated connector.\n\nTo exemplify how the payload can be used, take the following example:\n\n`1\n\n{ \n\n2\n\n \"timeToCancel\": 300, \n\n3\n\n \"transactionApproveLink\": \"https://...\" \n\n4\n\n} \n\n`\n\nIn this example, there are two fields for illustration. The first field (`\"timeToCancel\"`) can mean the amount of time after the payment app stays open before automatically canceling the transaction. The second field (`\"transactionApproveLink\"`) can have a link to request for the approval of the transaction if all the conditions in the Payment App are fulfilled.\n\n### Understanding the response to the Checkout UI\n\nWhen the Payment App finishes its operation, it has to inform the Checkout UI that it should be closed and then check if the transaction is approved or not. If the transaction is `approved` or `undefined`, the Checkout UI will redirect the user to the Order Placed page; otherwise, it will show a warning pop-up and then take the user back to the payment options.\n\nTo perform these steps, the Checkout UI listens to the `transactionValidation.vtex` event that is triggered by the Payment App using the [browser’s native event handling engine](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Learn/JavaScript/Building%5Fblocks/Events) during the validation step. When this event is triggered, the Checkout UI will close the Payment App and check the transaction status from the Gateway. The following [example method](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/example-payment-authorization-app/blob/master/react/index.tsx%23L45) can be used by the Payment App to trigger the event:\n\n`1\n\nrespondTransaction = () => { \n\n2\n\n $(window).trigger('transactionValidation.vtex') \n\n3\n\n} \n\n`\n\n> If the `transactionValidation.vtex` event is not triggered, the order confirmation email will not be sent to the user. We recommend that you create a retry flow to act in cases where this event is not triggered or the order confirmation email is not sent.\n\n### Injecting external scripts\n\nAn external script injection allows your Payment App to have additional content and behavior. To run external scripts on your Payment app, you need to inject the following script on the `head` of the checkout `html`. To do so, you have to do a DOM injection as follows:\n\n`1\n\nconst head = document.getElementsByTagName('head')[0] \n\n2\n\n \n3\n\nconst js = document.createElement('script') \n\n4\n\njs.id = {{script-id}} \n\n5\n\njs.src = {{script-src}} \n\n6\n\njs.async = true; \n\n7\n\njs.defer = true; \n\n8\n\njs.onload = {{callback-onload}} \n\n9\n\n \n10\n\n \n11\n\nhead.appendChild(js) \n\n`\n\nThere is an example of script injection [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/example-payment-authorization-app/blob/master/react/index.tsx%23L89) that inserts Google Recaptcha to a Payment App.\n\n> Keep in mind that if the external `js` script handles DOM manipulation, you should use [React's Ref](https://read.calvincode.net/reader?url=https://reactjs.org/docs/refs-and-the-dom.html) to create a `div` container and hand it over to the library. You can find an [example here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/example-payment-authorization-app/blob/master/react/index.tsx%23L106).\n\n## Payment App Scenarios\n\nIn the following sections, you will find some scenarios in which you can use a Payment App.\n\n### Scenario 1: An integration via Payment Provider Protocol that requires a new payment method\n\nThe best way to create a new payment method is by developing a Payment App, once it allows customers to complete the payment transaction without leaving the checkout page. It also allows you to add a security layer to your store’s online payments by using the [3D Secure 2](#scenario-2-payment-app-and-3d-secure-2) standards.\n\n### Scenario 2: Payment App and 3D Secure 2\n\nThe [3D Secure 2](https://read.calvincode.net/reader?url=https://3dsecure2.com/) is a protocol that allows a website’s checkout process to comply with the [Strong Customer Authentication (SCA)](https://read.calvincode.net/reader?url=https://3dsecure2.com/glossary/%23what-is-strong-customer-authentication-sca) requirements by performing risk-based authentication to approve an online card transaction. It was created to attend to the [Revised Payment Service Directive 2 (PSD2)](https://read.calvincode.net/reader?url=https://3dsecure2.com/glossary/%23what-is-payment-service-directive-2) regulations in Europe.\n\nThe 3D Secure 2 (3DS2) is an evolution of the 3D Secure 1 (3DS1). It introduces the [frictionless authentication flow](https://read.calvincode.net/reader?url=https://3dsecure2.com/glossary/%23what-is-frictionless-flow) and improves the purchase experience compared to 3DS1\\. More details about the differences between 3DS1 and 3DS2 can be found in the [3D Secure 2 FAQ](https://read.calvincode.net/reader?url=https://3dsecure2.com/frequently-asked-questions/%23what-are-the-main-changes-in-3d-secure-2).\n\n> On VTEX, [3D Secure 2](https://read.calvincode.net/reader?url=https://3dsecure2.com/) can only be implemented through the Payment App, as the platform doesn't support alternative methods such as redirect URLs for this protocol.\n\n#### 3DS2 flow\n\nTo apply the 3DS2 to the checkout, the acquirer that processes the website payments needs to create a Payment App that will handle challenges for each [issuing Bank](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-the-issuing-bank--7aVIVGwgtU4SWuqowSQksg) that will use the Strong Authentication through the 3DS2.\n\nWhen the customer adds the credit card information and clicks on the Checkout button, the acquirer will call the issuing bank through the 3DS2 flow.\n\nThe card issuer will, in turn, analyze the fraud context of that purchase (the score, probability), also called [Risk-based Authentication](https://read.calvincode.net/reader?url=https://3dsecure2.com/frictionless-flow/%23what-is-risk-based-authentication). The score will be a result of a series of risk-based elements which can include the value of the purchase, transactional history, device information, among others. If this analysis returns as a score for high fraud risk, the provider can choose to call the 3DS2 challenge asking the customer to proceed with the Strong Authentication method (i.e.: approve the payment in the bank app). If it falls in a score for low fraud risk, the provider will not call the challenge.\n\nIf the acquirer decides that it must perform the Strong Authentication for any payment, it must return to VTEX, in the response body of the [Create Payment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments) route, his `status` as `undefined` and his Payment App information in the `paymentAppData` field.\n\nThe `status` returned as `undefined` indicates to our Gateway that the payment has not yet been authorized or denied. There may be several reasons for this, with Strong Authentication being one of them. What will make the Payment App, which runs 3DS2, be called is the `paymentAppData` field in the response.\n\nThe Gateway will save this app data on the payment and tell the Checkout that payment has not yet been authorized or denied. It will make the Checkout UI run the Payment App specified in the `paymentAppData` field.\n\nOnce the Payment App opens, the Strong Authentication warning will be displayed to the customer within the Payment App on the checkout screen. It will require the customer to approve the transaction from his account on the issuing Bank (i.e.: in the bank app).\n\nAfter finishing the interaction with the Payment App, the app closes and redirects the customer depending on the `status` of the transaction. If it is `approved` or still is `undefined`, it will go to the order placed screen. If it is `denied` or `canceled`, the Checkout UI shows a warning and returns to the state where the user can choose the payment method.\n\nThe following image shows how the 3DS2 is displayed to customers:\n\n\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-app.md)\n\n[Purchase Flows« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app//docs/guides/payments-integration-purchase-flows)[Payment MethodsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app//docs/guides/payments-integration-payment-methods)\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[Understanding the Payment App flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23understanding-the-payment-app-flow)\n\n[Implementing a Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23implementing-a-payment-app)\n\n[Step 1: Setting up the development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23step-1-setting-up-the-development-environment)[Step 2: Developing your Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23step-2-developing-your-payment-app)[Step 3: Testing a Payment App flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23step-3-testing-a-payment-app-flow)[Step 4: Deploying your Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23step-4-deploying-your-payment-app)\n\n[Operational Mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23operational-mode)\n\n[Handling the order payload](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23handling-the-order-payload)[Understanding the response to the Checkout UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23understanding-the-response-to-the-checkout-ui)[Injecting external scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23injecting-external-scripts)\n\n[Payment App Scenarios](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23payment-app-scenarios)\n\n[Scenario 1: An integration via Payment Provider Protocol that requires a new payment method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23scenario-1-an-integration-via-payment-provider-protocol-that-requires-a-new-payment-method)[Scenario 2: Payment App and 3D Secure 2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23scenario-2-payment-app-and-3d-secure-2)\n\nWas this helpful?\n\n 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-app.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Understanding the Payment App flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23understanding-the-payment-app-flow)\n\n[Implementing a Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23implementing-a-payment-app)\n\n[Step 1: Setting up the development environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23step-1-setting-up-the-development-environment)[Step 2: Developing your Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23step-2-developing-your-payment-app)[Step 3: Testing a Payment App flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23step-3-testing-a-payment-app-flow)[Step 4: Deploying your Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23step-4-deploying-your-payment-app)\n\n[Operational Mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23operational-mode)\n\n[Handling the order payload](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23handling-the-order-payload)[Understanding the response to the Checkout UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23understanding-the-response-to-the-checkout-ui)[Injecting external scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23injecting-external-scripts)\n\n[Payment App Scenarios](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23payment-app-scenarios)\n\n[Scenario 1: An integration via Payment Provider Protocol that requires a new payment method](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23scenario-1-an-integration-via-payment-provider-protocol-that-requires-a-new-payment-method)[Scenario 2: Payment App and 3D Secure 2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-payment-app/docs/guides/payments-integration-payment-app%23scenario-2-payment-app-and-3d-secure-2)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_153e0e06
|
[
{
"role": "system",
"content": "You are a VTEX 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 toolbelt in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-toolbelt/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-toolbelt/docs/api-reference)\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-toolbelt/docs/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-toolbelt/docs/storefront-development)\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-toolbelt/docs/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-toolbelt/docs/troubleshooting)\n\n[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-toolbelt/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-toolbelt/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-toolbelt/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-toolbelt/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-toolbelt/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-toolbelt/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-toolbelt/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-toolbelt/updates/release-notes)\n\nVTEX IO CLI\n\nVTEX IO CLI is a **command-line interface** that gives you access to every feature of the VTEX platform.\n\nYou can use the VTEX IO CLI to:\n\n* List, install or uninstall apps available in your account.\n* List, create, promote or remove [**workspaces**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace).\n* Develop new apps in [**link mode**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app), using automatic synchronization.\n* [**Release**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version), [**publish**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) and **deploy** new app versions.\n\nTo install it and learn more about its functionalities, check the [**VTEX IO CLI**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) reference section.\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-toolbelt.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/Reference/concepts/vtex-io-documentation-toolbelt.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_5b206362
|
[
{
"role": "system",
"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 admin customers 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-admin-customers/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-admin-customers/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/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-admin-customers/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/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-admin-customers/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/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-admin-customers/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/vtex-io-apps)\n\n⚠️ Warning ⚠️\n\nOfficial extension\n\nVersion: 2.0.1\n\nLatest version: 2.0.1\n\n_This is a fork of the [vtex.admin-customers](https://read.calvincode.net/reader?url=https://github.com/vtex/admin-customers) to keep the integration with B2B Suite_\n\n# Customers Admin\n\nA VTEX admin app that helps the management of your customer data. This application allows the user to create, edit and search for customers. It's an alternative for MasterData when it comes to managing the documents from CL entity.\n\nThe [vtex.admin-customers-graphql](https://read.calvincode.net/reader?url=https://github.com/vtex/admin-customers-graphql) is a dependence of this application. Its responsibility is to group all the GraphQL queries and mutations that are needed to manage data from MasterData.\n\n## 🚀 Installation\n\nUsing [VTEX IO Toobelt](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/vtex-io-cli-installation-and-command-reference/%23command-reference) log into the VTEX account you are working on and install the latest version:\n\n`1\n\nvtex install vtex.b2b-admin-customers \n\n`\n\nIf everything went well, you can find the app by acessing **Admin > Customers > Customers** or acessing the URL `/admin/customers`\n\n## ✅ Features\n\nThe list below presents every feature of this application, where the ones that are checked are already implemented. The features that are yet to come are unchecked.\n\n> Please, whenever a new feature from the list below is implemented, mind marking the checkbox and create a feature demo.\n\n* [Listing](#listing)\n* [Memorize visibility fields](#memorize-visibility-fields)\n* [Search](#search)\n* [Filters](#filters)\n* [Creation](#creation)\n* [Details view](#details-view)\n* [Edition](#edition)\n* Deletion of profile (GDPR/LGPD)\n* Address association listing\n* Schema viewing with user-level configuration\n* Counters\n\n## 🎥 Demonstration\n\n**Listing** \n\n\n\n**Memorize visibility fields** \n\nThe visibility fields is a feature to toggle visibility of table columns.\n\nHere we have an additional feature that saves the preferred column visibility configuration of the end user, maintaining your configurations even after a page refresh and future visits to this page.\n\n\n\n**Search** \n\nThe search input uses the fields: **E-mail**, **First Name** or **Last Name** to filter the results that matches the terms searched while also displaying the results on the table.\n\n\n\n**Filters** \n\nWith these filters it is possible refine your search. You can filter by: **E-mail**, **First Name**, **Last Name**, **Document ID**, **Document** or **Receive Newsletter**.\n\nEvery filter has conditionals for you to choose from, it could be **equal**, **not equal** or **contains**.\n\n **Creation** \n\n\n\n**Details view**  **Edition** \n\n\n\n## ☕ Developing\n\n1. Clone this repo `git clone https://github.com/vtex/admin-customers`\n2. `yarn --cwd react/` for code completion\n3. `vtex link`\n4. Navigate to `workspace--account.myvtex.com/admin/app/example`\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Customers Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/apps/vtex.b2b-admin-customers%23customers-admin)\n\n[🚀 Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/apps/vtex.b2b-admin-customers%23-installation)\n\n[✅ Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/apps/vtex.b2b-admin-customers%23-features)\n\n[🎥 Demonstration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/apps/vtex.b2b-admin-customers%23-demonstration)\n\n[☕ Developing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers/docs/apps/vtex.b2b-admin-customers%23-developing)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_16f66ade
|
[
{
"role": "system",
"content": "You are a VTEX 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 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/search-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-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/search-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/search-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/search-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/search-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/search-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/getting-started)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/catalog-overview)\n\n[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/marketplace-overview)\n\n[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/orders-overview)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/checkout-overview)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/payments-overview)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/fulfillment)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview)\n\n[Pricing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/pricing-overview)\n\n[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/promotions-overview)\n\n[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/subscriptions)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/getting-started)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview)\n\nSearch\n\n> **Help us improve our documentation!** Tell us about your experience with this article by filling out [this form](https://read.calvincode.net/reader?url=https://forms.gle/fQoELRA1yfKDqmAb8).\n\nIntelligent Search is a [VTEX IO](https://read.calvincode.net/reader?url=https://vtex.com/us-en/store-framework/) alternative to Legacy Search. It assists the customer in their purchase journey and presents results from the first interaction with the search bar. The tool displays search and product suggestions that may interest the user. Intelligent Search also corrects spelling errors and understands words not contained in the product information.\n\n## Setting up the Intelligent Search\n\n### Search\n\nThe [VTEX Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search) is responsible for handling 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 that enhance the search experience, such as the autocomplete feature.\n\n\n\n### Intelligent Search API\n\nThe [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23overview) allows you to consult the information about the user's search in your store and its terms. You can also access information about banners, facets, and suggested terms.\n\n## Customizing the search experience of your store\n\n### Search Result\n\n[VTEX Search Result app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-result) is responsible for handling the result fetched by the [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23overview) and displaying it to users. The app exports all store blocks expected in a search results page, such as the filters and the product gallery.\n\n\n\n### Search Bar\n\nThe [Search Bar component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar) shows a search bar with autocomplete options and displays the matching products.\n\n\n\n### Autocomplete\n\nThe [Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete) is an alternative for the default VTEX autocomplete. The functionality displays previous search results based on current and previous searches. These results are presented in four different lists, which can be together or separated, depending on the customer's interaction.\n\n\n\n### Banners\n\n[Banners](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-banner) are the functionality responsible for displaying banners as promotional actions on the customer's search result page. This process is done by associating the words and filters selected when searching for these banners.\n\n### Suggestions\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-suggestions) is a component used to suggest search terms similar to the current query.\n\n### DidYouMean\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-didyoumean) is a component used to suggest a possible misspelling correction to the current query.\n\n## Search Control\n\nThe [Search Control](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/search-control-fulltextsearchbox) control is responsible for generating the search box. Besides the search filed, the control renders a combo for restricting a search in one department.\n\n## Customizing the search result\n\nYou can provide your customers with a more customized experience navigating the search result. You may want to present custom search results for each customer or even engage your users with specific products through a URL.\n\n* [Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-segmenting-the-search-result)\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)\n* [Creating a custom search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-custom-search-results-page)\n\n\n\n## Integrating an external search provider with VTEX\n\nThe [Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/search-integration-guide) defines the contract between an external search provider and a VTEX store running on VTEX IO. If a search provider adheres to this protocol, it can completely replace the original VTEX search capabilities without needing to implement any frontend pages or react components.\n\n* [Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-search-provider-overview)\n* [Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-search-provider-specification)\n* [Recipe](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-search-provider-recipe)\n* [Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-search-provider-reference)\n\n## Integrating your search with Google services\n\nYou can integrate your store's search to some Google features, such as the Google Chrome language processing and Google Analytics. These integrations can help retailers analyze user queries, measure the store's main searched terms, and create a more accessible environment for customers.\n\n* [Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-google-search-console)\n* [Setting up Google Analytics search tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-analytics-search-tracking)\n* [Speech to Text Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-speech-to-text)\n\n## Consulting search information using Legacy Search\n\nLegacy Search allows you to query, search and sort products in the catalog using fulltext, category, and brand search terms.\n\n* [Legacy Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api%23overview)\n* [How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/how-search-parameters-work)\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/Getting-Started/search-overview.md)\n\n[Fulfillment« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview//docs/guides/fulfillment)[PricingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview//docs/guides/pricing-overview)\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[Setting up the Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23setting-up-the-intelligent-search)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23search)[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23intelligent-search-api)\n\n[Customizing the search experience of your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23customizing-the-search-experience-of-your-store)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23search-result)[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23search-bar)[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23autocomplete)[Banners](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23banners)[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23suggestions)[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23didyoumean)\n\n[Search Control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23search-control)\n\n[Customizing the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23customizing-the-search-result)\n\n[Integrating an external search provider with VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23integrating-an-external-search-provider-with-vtex)\n\n[Integrating your search with Google services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23integrating-your-search-with-google-services)\n\n[Consulting search information using Legacy Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23consulting-search-information-using-legacy-search)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/search-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Setting up the Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23setting-up-the-intelligent-search)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23search)[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23intelligent-search-api)\n\n[Customizing the search experience of your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23customizing-the-search-experience-of-your-store)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23search-result)[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23search-bar)[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23autocomplete)[Banners](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23banners)[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23suggestions)[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23didyoumean)\n\n[Search Control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23search-control)\n\n[Customizing the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23customizing-the-search-result)\n\n[Integrating an external search provider with VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23integrating-an-external-search-provider-with-vtex)\n\n[Integrating your search with Google services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23integrating-your-search-with-google-services)\n\n[Consulting search information using Legacy Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview/docs/guides/search-overview%23consulting-search-information-using-legacy-search)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_55022b89
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides configuration 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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-section-api-quick-start-guides/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-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/configuration-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/configuration-section-api-quick-start-guides/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/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/configuration-section-api-quick-start-guides/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/configuration-section-api-quick-start-guides/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/configuration-section-api-quick-start-guides/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/configuration-section-api-quick-start-guides/docs/guides/clear-orderform-message-field-from-cart)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-section-api-quick-start-guides/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-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/configuration-section-api-quick-start-guides/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-section-api-quick-start-guides/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-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/configuration-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/configuration-section-api-quick-start-guides/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/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/configuration-section-api-quick-start-guides/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/configuration-section-api-quick-start-guides/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/configuration-section-api-quick-start-guides/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/configuration-section-api-quick-start-guides/docs/guides/clear-orderform-message-field-from-cart)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-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/configuration-section-api-quick-start-guides/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/guides/checkout-api-overview)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides/docs/guides/configuration-section-api-quick-start-guides)\n\nConfiguration\n\nThis section contains the quick start guides of the endpoints described in the [Configuration section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-api-overview%23configuration) of the Checkout API Reference.\n\n* [Get an account's orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-an-account-orderform-configuration)\n* [Update an account's orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/update-an-account-orderform-configuration)\n* [Get and update the seller exchange window](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-and-update-the-seller-exchange-window)\n* [Clear orderForm message field from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/clear-orderform-message-field-from-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/configuration-section-api-quick-start-guides.md)\n\n[Adding merchant context information to the cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides//docs/guides/add-merchant-context-information-to-the-cart)[Getting an account orderForm configurationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/configuration-section-api-quick-start-guides//docs/guides/get-an-account-orderform-configuration)\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/configuration-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_882a8c89
|
[
{
"role": "system",
"content": "You are a VTEX 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 interactively inspect blocks on a store framework 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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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-interactively-inspect-blocks-on-a-store-framework-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/how-to-interactively-inspect-blocks-on-a-store-framework-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/how-to-interactively-inspect-blocks-on-a-store-framework-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/how-to-interactively-inspect-blocks-on-a-store-framework-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/how-to-interactively-inspect-blocks-on-a-store-framework-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/how-to-interactively-inspect-blocks-on-a-store-framework-store/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/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/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/store-framework-styling)\n\n[Interactively inspecting storefront blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store)\n\nInteractively inspecting storefront blocks\n\nWhen customizing your Store Theme, it is essential to understand the structure and properties of the individual blocks that make up your storefront. To facilitate this process, VTEX provides an interactive inspection tool that allows you to analyze and gain insights into each block. You can use this tool to identify the VTEX IO app responsible for exporting a particular block, examine its name, and explore its associated classes.\n\n## Before you begin\n\nBefore you begin inspecting the blocks on your storefront, ensure that you have set up a development workspace. If you haven't created one yet, follow the guide on [creating a development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) to get started.\n\n## Instructions\n\n1. Open your web browser and enter the following URL: `https://{workspace}--{account}.myvtex.com/{path}/?__inspect`. Replace `{workspace}` with the name of your development workspace and `{account}` with your VTEX account name. You can also modify or remove `{path}` to access the specific store path you want to inspect. This URL will direct you to an interactive inspection tool designed to help you analyze and understand the blocks within your Store Theme.\n2. To inspect a particular block, hover your mouse over it. The inspection tool will provide you with pertinent information about the block, including the VTEX IO app responsible for exporting it, the block's name, and its associated classes.\n\n\n\nYou can use this tool to better understand the structure of your Store Theme and facilitate your [storefront customization.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization)\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/how-to-interactively-inspect-blocks-on-a-store-framework-store.md)\n\n[Customizing your store’s typography« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store//docs/guides/vtex-io-documentation-customizing-your-stores-typography)[Using the Markers prop to customize a block's messageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store//docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message)\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-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store%23instructions)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/styling-your-store/how-to-interactively-inspect-blocks-on-a-store-framework-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/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store/docs/guides/how-to-interactively-inspect-blocks-on-a-store-framework-store%23instructions)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_66b45d41
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore go live 4 integrating the vtex checkout in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-before-you-begin)\n\n[1\\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-1-configuring-external-dns)\n\n[2\\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-2-integrating-the-vtex-login)\n\n[3\\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)\n\n[4\\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-overview)\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-before-you-begin)\n\n[1\\. Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-1-configuring-external-dns)\n\n[2\\. Integrating the VTEX Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-2-integrating-the-vtex-login)\n\n[3\\. Integrating the VTEX Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout)\n\n[4\\. Integrating the VTEX Order Placed and My Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-overview)\n\n3\\. Integrating the VTEX Checkout\n\nIn this guide, you'll learn how to integrate your **FastStore** project with the [**VTEX Checkout**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/checkout-vtex-overview--7wcprkM7yZUflOqbzAN5SI). The Checkout comprehends the pages responsible for receiving the shopper's information necessary to process an order.\n\nTo successfully integrate the VTEX Checkout with your FastStore project, you must ensure that:\n\n* Shoppers will be presented with an updated version of the Order Placed page once they place an order.\n* All links in the Header and Footer of the Checkout point to your FastStore website.\n\n---\n\n## Before you begin\n\nBefore proceeding any further, make sure you have already [configured the custom domain name of your FastStore website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns).\n\n---\n\n## Instructions\n\n### Step 1 - Setting up the Order Placed page\n\nTake the following steps to guarantee shoppers will be redirected to the newest version of the **Order Placed** page in your store:\n\n1. In the **VTEX Admin**, access **Store Settings > Storefront > Checkout**.\n2. Click on the **gear button** `⚙` in the **Default** card.\n3. Change to the **Code** tab.\n4. Select `checkout-confirmation-custom.js` under **Files**.\n5. Add the following JavaScript code in the editor: \ncheckout-confirmation-custom.js \n`` 1 \n// WARNING: THE USAGE OF CUSTOM SCRIPTS IS NOT SUPPORTED. VTEX IS NOT LIABLE FOR ANY DAMAGES THIS MAY CAUSE. \n2 \n// THIS MAY BREAK YOUR STORE AND STOP SALES. IN CASE OF ERRORS, PLEASE DELETE THE CONTENT OF THIS SCRIPT. \n3 \n \n4 \nconst og = new URLSearchParams(location.search).get('og') \n5 \nwindow.location.assign( \n6 \n `${window.location.origin}/api/io${window.location.pathname}?og=${og}` \n7 \n) \n ``\n6. Click on **Save**. Notice that, as soon as you hit the _Save_ button, your changes will be live to all clients. \n\n\n### Step 2 - Adjusting the Header and Footer links of the Checkout pages\n\nWe now need to update the links presented in the Header and Footer of the Checkout pages, guaranteeing that all links point to your FastStore website. To do that, take the following steps.\n\n1. Still in the VTEX Admin at the **Store Settings > Storefront > Checkout > Default > Code** tab, click on `checkout-header` under **Template**.\n2. Edit the `checkout-header` code according to your scenario, making sure all links are pointing to your FastStore website. For example: \ncheckout-header.js \n`1 \n<div class=\"container\"> \n2 \n- <a href=\"/\" title=\"Home Page\">Your logo here!</a> \n3 \n+ <a href=\"https://www.vtexfaststore.com\" title=\"Home Page\">FastStore</a> \n4 \n<hr> \n5 \n</div> \n`\n3. Click on **Save**. Notice that, as soon as you hit the _Save_ button, your changes will be live to all clients.\n\nOnce you adjust all the Header links of the Checkout pages, make sure to repeat the process in the [step 2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout%23step-2---adjusting-the-header-and-footer-links-of-the-checkout-pages) for the `checkout-footer` file to adjust the Checkout Footer.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/3-integrating-the-vtex-checkout.mdx)\n\n[2\\. Integrating the VTEX Login« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-2-integrating-the-vtex-login)[4\\. Integrating the VTEX Order Placed and My AccountNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-4-integrating-the-vtex-order-placed-and-my-account)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23instructions)\n\n[Step 1 - Setting up the Order Placed page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23step-1-setting-up-the-order-placed-page)[Step 2 - Adjusting the Header and Footer links of the Checkout pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23step-2-adjusting-the-header-and-footer-links-of-the-checkout-pages)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/go-live/3-integrating-the-vtex-checkout.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23instructions)\n\n[Step 1 - Setting up the Order Placed page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23step-1-setting-up-the-order-placed-page)[Step 2 - Adjusting the Header and Footer links of the Checkout pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-4-integrating-the-vtex-checkout/docs/guides/faststore/go-live-3-integrating-the-vtex-checkout%23step-2-adjusting-the-header-and-footer-links-of-the-checkout-pages)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_1450bc8e
|
[
{
"role": "system",
"content": "You are a VTEX 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 mtls in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-mtls/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/api-reference)\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-mtls/docs/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-mtls/docs/storefront-development)\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-mtls/docs/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-mtls/docs/troubleshooting)\n\n[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-mtls/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/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-mtls/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n[Managing SSL Certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/managing-ssl-certificates)\n\n[Implementing Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls)\n\n[Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls)\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/data-protection-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-mtls/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/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-mtls/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n[Managing SSL Certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/managing-ssl-certificates)\n\n[Implementing Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls)\n\n[Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls)\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/data-protection-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-mtls/docs/guides)\n\nVTEX Shield\n\n[Implementing Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls)\n\nImplementing Mutual Transport Layer Security (mTLS)\n\nLearn how to generate, request, and use certificates to securely authenticate with VTEX services using mTLS.\n\n> This feature is part of [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you're already a VTEX client and would like to adopt VTEX Shield for your business, contact our [Commercial Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you're not yet a VTEX client but are interested in this solution, complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/contact/).\n\nWhen making requests to VTEX services using [mTLS](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/mutual-transport-layer-security-mtls--6YR3SoynJMfeEKGlY1Cqlo), VTEX validates whether the certificate was issued and signed by its internal Certificate Authority (CA). This guide walks you through the process of obtaining and managing certificates for mTLS authentication.\n\n## Step 1 - Generating a Certificate Signing Request (CSR)\n\nThe first step is to generate a Certificate Signing Request (CSR) using [OpenSSL 3.0.0](https://read.calvincode.net/reader?url=https://openssl-library.org/news/openssl-3.0-notes/index.html) or higher. This process generates the CSR (`.csr`) and private key (`.key`) files.\n\nOpen a terminal and run the command below, replacing the values in `{{ }}` with your specific information:\n\n`1\n\nopenssl req -new -subj \"/CN={{APP_NAME}}/OU={{TENANT}}/L={{CITY}}/ST={{STATE}}/C={{COUNTRY:2CHARS}}\" -out APP_CERT_REQUEST.csr -nodes -sha512 -newkey rsa:2048 -keyout APP_CERT_PRIVATE_KEY.key \n\n`\n\nThe fields `CN` (Common Name) and `OU` (Organizational Unit) are mandatory and must contain the application name and account name, respectively.\n\nSave both generated files (`.csr` and `.key`) for the next step.\n\n## Step 2 - Issuing a certificate signed by VTEX\n\nOnce you've [generated the CSR](#step-1-generating-a-certificate-signing-request-csr), use the `POST` [Sign certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/mtls-api%23post-/api/edge/private-certificates/sign) endpoint to request a certificate signed by VTEX's Certificate Authority. This request allows you to submit a CSR and receive a signed certificate.\n\n### Required permission\n\nTo use this endpoint, your user or API key must have access to the following License Manager resource. Otherwise, a 403 status code error will be returned.\n\n| Product | Category | Resource |\n| ------- | ---------------------- | ------------------ |\n| CDN API | Certificate management | Update certificate |\n\nThere are no predefined roles for these resources. To use this endpoint, you must create a [custom role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-roles--qGtNQpKSSAduX94l2WZBW%23creating-custom-roles) and add the above resource. Learn more about roles and resources in the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) documentation.\n\n### Request example\n\nThe request body should contain the [previously generated CSR](#step-1-generating-a-certificate-signing-request-csr) as plain text:\n\n`1\n\ncurl --request post \\ \n\n2\n\n --url https://apiexamples.vtexcommercestable.com.br/api/edge/private-certificates/sign \\ \n\n3\n\n --header 'Content-Type: text/plain' \\ \n\n4\n\n --header 'X-VTEX-API-AppKey: ' \\ \n\n5\n\n --header 'X-VTEX-API-AppToken: ' \\ \n\n6\n\n --data '-----BEGIN CERTIFICATE REQUEST----- \n\n7\n\n*** \n\n8\n\n-----END CERTIFICATE REQUEST----- \n\n9\n\n' \n\n`\n\n> The account in the request must match the one specified in the `OU` field of the CSR.\n\n### Response\n\nIf successful, the API responds with the certificate in plain text:\n\n`1\n\n-----BEGIN CERTIFICATE----- \n\n2\n\n*** \n\n3\n\n-----END CERTIFICATE----- \n\n`\n\nSave this content to a `.crt` file. You'll use it along with the private key (`.key`) to authenticate requests.\n\n> Learn more in the `POST` [Sign certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/mtls-api%23post-/api/edge/private-certificates/sign) API reference.\n\n## Step 3 - Making requests with the certificate\n\nWith the certificate issued, you can now authenticate your requests to VTEX using mTLS. See examples using [Postman](https://read.calvincode.net/reader?url=https://www.postman.com/) and cURL below.\n\n### Using Postman\n\nTo test mTLS requests with Postman, attach your certificate and private key directly in the tool's settings. Follow the steps below:\n\n1. Open **Postman** and go to **Settings**.\n2. Navigate to the **Certificates** tab.\n3. Define the **Host** for the call.\n4. In **CRT file**, add the certificate file (`.crt`).\n5. In **KEY file**, add the private key (`.key` file generated earlier with the CSR).\n6. Click **Add** to save the certificate configuration.\n\n\n\nOnce configured, any request made to the specified host will automatically include the certificate, allowing you to test mTLS-protected endpoints.\n\n### Using cURL\n\nIf you prefer to test or integrate mTLS requests via the command line, you can use `cURL` to send requests with your certificate and private key.\n\nUse the following example to authenticate a request with mTLS:\n\n`1\n\ncurl --location 'https://{{account}}.vtexcommercestable.com.br/api/vtexid/credential/validate' \\ \n\n2\n\n--cert {{client.crt}} \\ \n\n3\n\n--key {{client.key}} \\ \n\n4\n\n--header 'Content-Type: application/json' \\ \n\n5\n\n--data '{ \n\n6\n\n \"token\": \"{{user_token}}\" \n\n7\n\n} \n\n8\n\n' \n\n`\n\n> Replace `{{client.crt}}` and `{{client.key}}` with the paths to your certificate and private key files, and insert a valid token in the request body.\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 Shield/implementing-mtls.md)\n\n[Managing SSL Certificates« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls//docs/guides/managing-ssl-certificates)[Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls//docs/guides/revoking-ssl-private-certificates-when-using-mtls)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Step 1 - Generating a Certificate Signing Request (CSR)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23step-1-generating-a-certificate-signing-request-csr)\n\n[Step 2 - Issuing a certificate signed by VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23step-2-issuing-a-certificate-signed-by-vtex)\n\n[Required permission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23required-permission)[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23request-example)[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23response)\n\n[Step 3 - Making requests with the certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23step-3-making-requests-with-the-certificate)\n\n[Using Postman](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23using-postman)[Using cURL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23using-curl)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Shield/implementing-mtls.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Step 1 - Generating a Certificate Signing Request (CSR)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23step-1-generating-a-certificate-signing-request-csr)\n\n[Step 2 - Issuing a certificate signed by VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23step-2-issuing-a-certificate-signed-by-vtex)\n\n[Required permission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23required-permission)[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23request-example)[Response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23response)\n\n[Step 3 - Making requests with the certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23step-3-making-requests-with-the-certificate)\n\n[Using Postman](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23using-postman)[Using cURL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-mtls/docs/guides/implementing-mtls%23using-curl)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_3feeb26f
|
[
{
"role": "system",
"content": "You are a VTEX 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 homologation requirements for 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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-vtex-app-store/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-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-homologation-requirements-for-vtex-app-store/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-homologation-requirements-for-vtex-app-store/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store)\n\nApp Store Guidelines\n\nBefore submitting your app to the homologation process and [making it available in the App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-10-making-your-app-publicly-available%23submitting-your-app-to-the-vtex-app-store), you must ensure that your app complies with the following guidelines:\n\n[App monetizationLearn how to monetize your app at the VTEX App Store with our different business models.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)[Marketing guidelinesPrepare your app's page and promote it at the VTEX App Store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-business-guidelines-marketing-assets)[User experience guidelinesRefer to our recommended practices for designing an IO app.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-design-guidelines)[Engineering guidelinesRefer to our coding guidelines to guarantee the quality and usability of your IO app.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-engineering-guidelines)[Documentation guidelinesRefer to our documentation guidelines to create clear, engaging, and effective documentation for your IO app.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-docs-guidelines)\n\nThese guidelines describe the business, design, and engineering requirements enforced by the VTEX App Store to guarantee the quality, viability, and usability of VTEX apps.\n\n> The SLA for the homologation process is 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-sending-the-app-data-for-validation).\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.md)\n\n[Using the Docs builder to publish app documentation« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store//docs/guides/using-the-docs-builder-to-publish-app-documentation)[App monetizationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store//docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\nSee also\n\n[App monetizationApp Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-homologation-requirements-for-vtex-app-store/docs/guides/vtex-io-documentation-business-guidelines-app-monetization)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Perks/vtex-io-documentation-homologation-requirements-for-vtex-app-store.md)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_fecb4b30
|
[
{
"role": "system",
"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 delivery promise notification api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/delivery-promise-notification-api/)\n\nDelivery Promise\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/delivery-promise-notification-api/)\n\nDelivery Promise\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[PuCreate or change store configuration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/customer-credit-api%23put-/api/creditcontrol/storeconfig)[PuUpdate external product availabilityNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/delivery-promise-notification-api/docs/api-reference/delivery-promise-notification-api%23put-/delivery-promises/external-sellers/-sellerId-/products)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_07f760b2
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore overrides components and props 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/faststore/overrides-components-and-props-v1/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-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/faststore/overrides-components-and-props-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/faststore/overrides-components-and-props-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/faststore/overrides-components-and-props-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/faststore/overrides-components-and-props-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/faststore/overrides-components-and-props-v1/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-overview)\n\n[Overriding native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-component-props)\n\n[Overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-native-component)\n\n[Overriding section styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-getoverriddensection-function)\n\n[Syncing components with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms)\n\n[Migrating Overrides v1 to v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-migrating-v1-to-v2)\n\n[Overriding native components and props (v1)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-overview)\n\n[Overriding native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-component-props)\n\n[Overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-native-component)\n\n[Overriding section styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-section-styles)\n\n[\\`getOverriddenSection\\` function](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-getoverriddensection-function)\n\n[Syncing components with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-syncing-components-with-the-headless-cms)\n\n[Migrating Overrides v1 to v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-migrating-v1-to-v2)\n\n[Overriding native components and props (v1)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1)\n\n[Section override - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/override-use-cases-overview)\n\n[Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developing-and-overriding-components-creating-a-new-section)\n\n[List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developing-and-overriding-components-list-of-native-sections)\n\n[Experimental exports - Hooks and Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Section override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-overview)\n\nOverriding native components and props (v1)\n\n> This guide is for stores using Section overrides v1\\. For instructions on how to use Section overrides v2, refer to the [Section overrides v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-overview)\n\nIn this guide, you will learn how to modify a component's behavior using additional properties in your store code and create new components by overriding their native equivalents.\n\nThese features are useful when you need a customized behavior for a specific component not available in the [FastStore native options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections).\n\n> We highly recommend considering [overriding props](#override-native-components-props) or utilizing the [theming tools](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components) provided by `@faststore/core` to achieve the desired behavior. Overriding a component inside a section will compromise the existing integration developed in [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23faststorecore) by losing updates for that component.\n\n## Before you begin\n\n### Ensure you have a functioning FastStore project\n\nMake sure you have a functioning FastStore project after following the [FastStore onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-overview) and [setting up the project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-setting-up-the-project).\n\n### Check the version compatibility of your `faststore/core` package\n\nThis feature is available for stores using `@faststore/core` 2.1.36 version and above.\n\n### Choose a native section and the component you want to customize\n\nThe [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23faststorecore) package provides a set of native sections, each consisting of different components with unique functionalities. Refer to the [List of native sections and overridable components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections%23faststore-native-sections) to explore available native sections.\n\n### Consider two aspects of this feature\n\nKeep in mind the following aspects when using this feature:\n\n* **This feature is experimental**: The feature may not function as expected.\n* **Some sections contain multiple instances of the same component**: When overriding a component or passing additional props to it, consider that all instances will be affected by this change.\n\n---\n\n## Override native component's props\n\nOverriding props allows you to customize a component's behavior while preserving its native integration. This approach is useful when you want to modify specific aspects of a native component.\n\nAll component customizations in FastStore are performed within a section, and to override props, you need to choose the desired native section and component from the [List of available native sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections%23faststore-native-sections).\n\nFor this guide, we'll use the [BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button%23props) component to make the customization.\n\nHere's how the initial component looks like with the `size` prop set as `regular` in the PDP (Product Details Page):\n\n\n\n### Instructions\n\n#### Step 1 - Setting up the `overrides` folder\n\n1. After choosing a native section to be customized from the [list of available native sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections), open your FastStore project in any code editor of your preference.\n2. Go to the `src` folder, create the `components` folder and inside it, create the `overrides` folder. You can run the following command to create them:\n\nmacOS and Linux\n\nWindows\n\n`1\n\nmkdir src/components src/components/overrides \n\n`\n\n1. Inside the `overrides` folder, create a new file named after the chosen native section. For example, if you chose the `ProductDetails` section for customization, create a new file named `ProductDetails.tsx` under the `src/components/overrides` directory.\n\nmacOS and Linux\n\nWindows\n\n`1\n\ntouch src/components/overrides/ProductDetails.tsx \n\n`\n\n1. Copy and paste the following code snippet into the file:\n\n`1\n\nimport { SectionOverride } from '@faststore/core' \n\n2\n\n \n3\n\nconst SECTION = 'ProductDetails' as const \n\n4\n\n \n5\n\nconst override: SectionOverride = { \n\n6\n\n section: SECTION, \n\n7\n\n components: {} \n\n8\n\n} \n\n9\n\n \n10\n\nexport { override } \n\n`\n\n> Change the value of the `SECTION` variable to the name of the section you want to override. In the given example, we set the `SECTION` variable to `ProductDetails` to override this specific section.\n\n1. Save your changes.\n\n#### Step 2 - Setting up the override\n\n1. Open the `ProductDetails.tsx` file created in the [Setting up the overrides folder step](#step-1-setting-up-the-overrides-folder) and add the following code:\n\n{8-9}\n\n`1\n\nimport { SectionOverride } from '@faststore/core' \n\n2\n\n \n3\n\nconst SECTION = 'ProductDetails' as const \n\n4\n\n \n5\n\nconst override: SectionOverride = { \n\n6\n\n section: SECTION, \n\n7\n\n components: { \n\n8\n\n BuyButton: { props: { size: 'small', iconPosition: 'right' } }, \n\n9\n\n }, \n\n10\n\n} \n\n11\n\n \n12\n\nexport { override } \n\n`\n\nThis code overrides the `BuyButton` props `size` and `iconPosition`. You'll see a smaller button than the initial one and the cart icon positioned on the right side.\n\n1. Run `yarn dev` in the terminal to start the development server. Access the provided localhost URL in your browser and go to the product details page to see the updated `BuyButton` component:\n\n\n\n> Remember: props changed via Headless CMS overlap the changes made through [override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overriding-components-and-props%23override-native-components-props). For example, if you change a prop through override and also change it using Headless CMS, the final prop's value will be the one added using CMS.\n\n---\n\n## Overriding a native component\n\nNow that you know how to [override a component's prop](#override-native-components-props), learn how to override a native component to use a custom component.\n\nFor example, you may want to replace the current `BuyButton` component from the `ProductDetails` section to meet your business needs.\n\nCurrently, when the `BuyButton` is clicked, it opens the `CartSideBar` as its default behavior:\n\n\n\nFor this guide, we will create a custom Buy Button that, once you click on it, displays an `alert` for the customer and the custom Product Title.\n\n### `BuyButton`\n\n#### Step 1 - Create your custom component\n\n1. Inside the `components` folder, create a file named `CustomBuyButton.tsx`. _If you haven't created the `components` folder yet, see the [Setting up the overrides folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overriding-components-and-props%23step-1---setting-up-the-overrides-folder) step._\n\nmacOS and Linux\n\nWindows\n\n`1\n\ntouch src/components/CustomBuyButton.tsx \n\n`\n\n> When creating a custom component, it's important to choose a name that distinguishes it from the native component. For example, `Custom{ComponentName}` \\= `CustomBuyButton`.\n\n1. Add the following code into `CustomBuyButton.tsx` file:\n\nCustomBuyButton.tsx\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { Button as UIButton } from '@faststore/ui' \n\n3\n\n \n4\n\nexport function CustomBuyButton() { \n\n5\n\n return ( \n\n6\n\n <UIButton \n\n7\n\n variant=\"primary\" \n\n8\n\n onClick={() => { \n\n9\n\n alert('Hello User!') \n\n10\n\n }} \n\n11\n\n > \n\n12\n\n New Buy Button \n\n13\n\n </UIButton> \n\n14\n\n ) \n\n15\n\n} \n\n`\n\nThe provided code imports the [Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button) component from the [@faststore/ui](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/) package. The code defines the `CustomBuyButton` component that displays an alert message when clicked based on the behavior we want. However, you have the flexibility to customize the component to achieve a different behavior if needed.\n\n#### Step 2 - Overriding the component\n\n1. Choose a component to override from the [list of overridable components of each native section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-list-of-native-sections). In this example, we are overriding the `BuyButton` component in the `ProductDetails` section.\n2. Navigate to `src/components/overrides` that we've created [before](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overriding-components-and-props%23step-1---setting-up-the-overrides-folder).\n3. Open the `ProductDetails.tsx` file and update it with the following code:\n\nProductDetails.tsx\n\n`1\n\nimport { SectionOverride } from '@faststore/core' \n\n2\n\nimport { CustomBuyButton } from '../CustomBuyButton' \n\n3\n\n \n4\n\nconst SECTION = 'ProductDetails' as const \n\n5\n\n \n6\n\nconst override: SectionOverride = { \n\n7\n\n section: SECTION, \n\n8\n\n components: { \n\n9\n\n BuyButton: { Component: CustomBuyButton }, \n\n10\n\n }, \n\n11\n\n} \n\n12\n\n \n13\n\nexport { override } \n\n`\n\n1. Run `yarn dev` in the terminal to start the development server. Access the provided localhost URL in your browser. Navigate to the product details page, you should see the CustomBuyButton component in place of the previous BuyButton component.\n\n\n\nBy using your custom component, you may need to customize it from scratch. See [Customizing a New Component when using Override](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-components%23customizing-a-new-component-when-using-override) guide for more details about styling it.\n\n### `Product Title`\n\n1. After [Setting up the overrides folder](#step-1-setting-up-the-overrides-folder), inside the `components` folder, create the `CustomProductTitle.tsx` file.\n2. Add the following to the file:\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { ProductTitle, Tag } from '@faststore/ui' \n\n3\n\n \n4\n\n \n5\n\nexport default function CustomProductTitle() { \n\n6\n\n return ( \n\n7\n\n <section> \n\n8\n\n <ProductTitle title={<h1>New headphones</h1>} /> \n\n9\n\n <Tag variant=\"warning\" label=\"On sale\" onClose={() => {}} /> \n\n10\n\n </section> \n\n11\n\n ) \n\n12\n\n} \n\n`\n\nThis code creates a custom `ProductTitle` component displaying the product title and a tag indicating that the product is on sale.\n\n1. In the `overrides` folder, create the `ProductDetails.tsx` file.\n2. Add the following code to the `ProductDetails.tsx` file to render the new `CustomProductTitle` component.\n\n`1\n\nimport { SectionOverride } from '@faststore/core' \n\n2\n\n \n3\n\nimport CustomProductTitle from '../CustomProductTitle' \n\n4\n\n \n5\n\nconst SECTION = 'ProductDetails' as const \n\n6\n\n \n7\n\nconst override: SectionOverride = { \n\n8\n\n section: SECTION, \n\n9\n\n components: { \n\n10\n\n ProductTitle: { Component: CustomProductTitle }, \n\n11\n\n }, \n\n12\n\n} \n\n13\n\n \n14\n\nexport { override } \n\n`\n\n1. Run `yarn dev` in the terminal to start the development server and access the provided localhost URL in your browser.\n\n---\n\n## Overriding components while maintaining default configuration\n\nIn specific scenarios, when you want to keep the default integration or component configuration partially, you can use prior integrations within your custom component.\n\n> Note that this will only work if your custom component's props are compatible with the overriding component. We encourage using [FastStore UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/) to leverage existing features, basic styles, and better props compatibility.\n\nBuilding upon our previous example, we could pass the `BuyButton` props to our new component. This approach allows us to incorporate the icon and cart sidebar integration while introducing additional functionality to the `onClick` function, such as triggering an alert or sending an event to analytics.\n\nCustomBuyButton.tsx\n\n`1\n\nimport React from 'react' \n\n2\n\nimport { Button as UIButton, ButtonProps } from '@faststore/ui' \n\n3\n\n \n4\n\nexport function CustomBuyButton(props: ButtonProps) { \n\n5\n\n return ( \n\n6\n\n <UIButton \n\n7\n\n {...props} \n\n8\n\n variant=\"primary\" \n\n9\n\n onClick={(event) => { \n\n10\n\n alert('You will love this product!') \n\n11\n\n props.onClick?.(event) \n\n12\n\n }} \n\n13\n\n > \n\n14\n\n New Buy Button \n\n15\n\n </UIButton> \n\n16\n\n ) \n\n17\n\n} \n\n`\n\n\n\nIn this example, when clicked, the `CustomBuyButton` component will display an alert message and then open the `CartSideBar`, keeping its default behavior.\n\nThis feature can open up numerous possibilities for exploration and customization in your store. Happy exploring! 🎉\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/overrides/components-and-props-v1.mdx)\n\n[Migrating Overrides v1 to v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-migrating-v1-to-v2)[Section override - Use casesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/override-use-cases-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23before-you-begin)\n\n[Ensure you have a functioning FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23ensure-you-have-a-functioning-faststore-project)[Check the version compatibility of your faststore/core package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23check-the-version-compatibility-of-your-faststorecore-package)[Choose a native section and the component you want to customize](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23choose-a-native-section-and-the-component-you-want-to-customize)[Consider two aspects of this feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23consider-two-aspects-of-this-feature)\n\n[Override native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23override-native-components-props)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23instructions)\n\n[Overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23overriding-a-native-component)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23buybutton)[Product Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23product-title)\n\n[Overriding components while maintaining default configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23overriding-components-while-maintaining-default-configuration)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/developing-and-overriding-components/overrides/components-and-props-v1.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23before-you-begin)\n\n[Ensure you have a functioning FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23ensure-you-have-a-functioning-faststore-project)[Check the version compatibility of your faststore/core package](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23check-the-version-compatibility-of-your-faststorecore-package)[Choose a native section and the component you want to customize](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23choose-a-native-section-and-the-component-you-want-to-customize)[Consider two aspects of this feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23consider-two-aspects-of-this-feature)\n\n[Override native component's props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23override-native-components-props)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23instructions)\n\n[Overriding a native component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23overriding-a-native-component)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23buybutton)[Product Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23product-title)\n\n[Overriding components while maintaining default configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1/docs/guides/faststore/overrides-components-and-props-v1%23overriding-components-while-maintaining-default-configuration)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_52fc709f
|
[
{
"role": "system",
"content": "You are a VTEX 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 a second address to the order in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-a-second-address-to-the-order/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/api-reference)\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-a-second-address-to-the-order/docs/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-a-second-address-to-the-order/docs/storefront-development)\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-a-second-address-to-the-order/docs/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-a-second-address-to-the-order/docs/troubleshooting)\n\n[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-a-second-address-to-the-order/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\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-a-second-address-to-the-order/docs/guides/data-protection-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-a-second-address-to-the-order/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/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/adding-a-second-address-to-the-order/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\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-a-second-address-to-the-order/docs/guides/data-protection-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-a-second-address-to-the-order/docs/guides)\n\nOrders\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/actions-orders)\n\n[Adding a second address for invoicing an order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/adding-a-second-address-to-the-order)\n\nAdding a second address for invoicing an order\n\nFor B2B businesses, it is common to add to the invoice an address that is different from the one registered for delivery, since the location where the product will be received is often different from the billing address.\n\nVTEX Admin allows you to add a second address only in the case of [Pickup Points](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) because there will be only one address for the invoice. For other cases, adding a second address must be done via API, using the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) object.\n\nThe `orderForm` is the main object processed by VTEX Checkout, and one of the most important data structures in VTEX stores' architecture.\n\nThere are two ways to manipulate data from the `orderForm` to enter a second address:\n\n* Using the vtex.js library\n* Through API REST\n \n> Although it is possible to create a custom interface superimposed on that of VTEX containing the second address field, we do not recommend it, because it increases the chances of errors in order management.\n\n \n## vtex.js\n\nThe vtex.js is a library of JavaScript functions that will do the API requests. The function used for this is the `sendAttachment`. Fore more information, see the [specific library documentation](https://read.calvincode.net/reader?url=https://github.com/vtex/vtex.js/tree/master/docs/checkout%23sendattachmentattachmentid-attachment-expectedorderformsections).\n\n## API REST\n\nTo add a second address to an order via API, make a POST request to the endpoint below:\n\n`/api/checkout/pub/orderForm/{{orderFormId}}/attachments/invoiceData`\n\nThe `{{orderFormId}}` value must be replaced by the ID of the orderForm that you want to manipulate.\n\nIn the `orderForm` object there is the object` invoiceData`, which contains information about the order's invoice and contains the field `address`. This field must be set with the second address you wish to add. The request body looks like the example below:\n\n \n`1\n\n{ \n\n2\n\n \"address\": { \n\n3\n\n \"postalCode\": \"22250-040\", \n\n4\n\n \"city\": \"Rio de Janeiro\", \n\n5\n\n \"state\": \"RJ\", \n\n6\n\n \"country\": \"BRA\", \n\n7\n\n \"street\": \"Praia Botafogo\", \n\n8\n\n \"number\": \"300\", \n\n9\n\n \"neighborhood\": \"Botafogo\", \n\n10\n\n \"complement\": null, \n\n11\n\n \"reference\": null, \n\n12\n\n \"geoCoordinates\": [ \n\n13\n\n -43.18218231201172, \n\n14\n\n -22.94549560546875 \n\n15\n\n ] \n\n16\n\n } \n\n17\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/Orders/actions-orders/adding-a-second-address-to-the-order.md)\n\n[Using VTEX Admin filters on orders via API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order//docs/guides/using-orders-management-filters-in-api)[Enabling Manual Prices for Subscriptions v3Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order//docs/guides/enabling-manual-prices-for-subscriptions-v3)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/adding-a-second-address-to-the-order%23vtexjs)\n\n[API REST](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/adding-a-second-address-to-the-order%23api-rest)\n\nWas this helpful?\n\n 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/adding-a-second-address-to-the-order.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[vtex.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/adding-a-second-address-to-the-order%23vtexjs)\n\n[API REST](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-a-second-address-to-the-order/docs/guides/adding-a-second-address-to-the-order%23api-rest)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_267a2c47
|
[
{
"role": "system",
"content": "You are a VTEX 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 availabilitysubscriber in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-availabilitysubscriber/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-availabilitysubscriber/docs/api-reference)\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-availabilitysubscriber/docs/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-availabilitysubscriber/docs/storefront-development)\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-availabilitysubscriber/docs/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-availabilitysubscriber/docs/troubleshooting)\n\n[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-availabilitysubscriber/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/updates/release-notes)\n\nAvailability Subscriber\n\nThe `availability-subscriber` component shows the availability subscriber form displayed when a product isn't available. This component can be imported and used by any VTEX App.\n\n\n\nThis component only collects the emails of the customers that subscribed to receive updates about a specific out-of-stock product. It does not email shoppers automatically when the product gets back in stock.\n\n> Alternatively, check the [Availability Notify component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-availability-notify), which renders a subscription form when a product is unavailable and also emails the shopper when the requested product is back in stock.\n\n## Before you begin\n\nBefore configuring the Availability Subscriber component in your theme, make sure you've already configured a **JSON schema in Master Data** to collect the emails correctly. Otherwise, the subscriber form won't be properly saved with the shoppers' emails. Please refer to the [Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-product-availability-form) guide for more information.\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 `availability-subscriber` block as a child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n+ \"availability-subscriber” \n\n4\n\n ] \n\n5\n\n } \n\n`\n\nThe Availability Subscriber component does not have any props. Hence, once added to your Product Details Page template, the Availability Subscriber component is ready for use.\n\n### Blocks API\n\nWhen implementing this component as a block, various inner blocks may be available. The following interface lists the blocks available within `AvailabilitySubscriber` and describes if they are mandatory or optional.\n\n`1\n\n \"availability-subscriber\": { \n\n2\n\n \"component\": \"AvailabilitySubscriber\" \n\n3\n\n } \n\n`\n\nFor now this block does not have any mandatory or optional blocks.\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| content |\n| error |\n| form |\n| input |\n| inputEmail |\n| inputName |\n| submit |\n| subscriberContainer |\n| subscribeLabel |\n| success |\n| title |\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-availabilitysubscriber.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/guides/vtex-store-components-availabilitysubscriber%23before-you-begin)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/guides/vtex-store-components-availabilitysubscriber%23configuration)\n\n[Blocks API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/guides/vtex-store-components-availabilitysubscriber%23blocks-api)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/guides/vtex-store-components-availabilitysubscriber%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-availabilitysubscriber.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/guides/vtex-store-components-availabilitysubscriber%23before-you-begin)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/guides/vtex-store-components-availabilitysubscriber%23configuration)\n\n[Blocks API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/guides/vtex-store-components-availabilitysubscriber%23blocks-api)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-availabilitysubscriber/docs/guides/vtex-store-components-availabilitysubscriber%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_81bdfdb0
|
[
{
"role": "system",
"content": "You are a VTEX 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 radio group in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-radio-group/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-radio-group/docs/api-reference)\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-radio-group/docs/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-radio-group/docs/storefront-development)\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-radio-group/docs/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-radio-group/docs/troubleshooting)\n\n[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-radio-group/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-radio-group/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-radio-group/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/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-radio-group/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/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-radio-group/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/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-radio-group/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-radio-group/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-radio-group/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-radio-group/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/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-radio-group/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-radio-group/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/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-radio-group/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-radio-group/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/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-radio-group/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/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-radio-group/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/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-radio-group/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-radio-group/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-radio-group/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-radio-group/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/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-radio-group/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-radio-group/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-radio-group/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-overview)\n\nRadioGroup\n\nAllows users to select a single option from a list of two or more mutually exclusive options.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/RadioGroup)\n\nThe `RadioGroup` allows users to select a single option from a list of two or more mutually exclusive options.\n\nExample\n\nCode\n\nFirst option\n\nSecond option\n\nThird option\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { RadioGroup, RadioField } 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/Radio/styles.scss' \n\n`\n\n`1\n\n@import '@faststore/ui/src/components/molecules/RadioField/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 `RadioGroup` styles using the following data attributes:\n\n`data-fs-radio-group-option`\n\n---\n\n## Props\n\n| Name | Type | Description | Default |\n| ----------------- | ------------------------------------ | -------------------------------------------------------- | ------- |\n| **name\\*** | string | Name to link children by context. | |\n| **selectedValue** | string \\| number | Value of checked child. | |\n| **onChange** | ChangeEventHandler<HTMLInputElement> | Function that is triggered when any children is checked. | |\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/radio-group.mdx)\n\n[RadioField« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-field)[RatingNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-rating)\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-radio-group/docs/guides/faststore/molecules-radio-group%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group%23import-styles)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group%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/radio-group.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-radio-group/docs/guides/faststore/molecules-radio-group%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group%23import-styles)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-radio-group/docs/guides/faststore/molecules-radio-group%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_6a7246cf
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtexarg abtester in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/updates/release-notes)\n\nAB Tester\n\nThe A/B Tester app allows you to list, start and finish A/B tests via the VTEX Admin.\n\n\n\nIn the following, you'll learn how to install and use the A/B Tester app.\n\n---\n\n## Configuration\n\nTake the following steps to install the AB Tester app on your VTEX Admin.\n\n1. Open the terminal and use the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) to log in to the desired VTEX account.\n2. Install the A/B Tester app in the `master` workspace to enable A/B testing on your store website by running: \n`1 \nvtex use master \n2 \nvtex install vtex.ab-tester \n`\n3. Install the **A/B Tester Admin app** in the `master` workspace: \n`1 \nvtex install vtexarg.abtester \n`\n\n## Usage\n\nAfter installing the AB Tester app, you'll be able to:\n\n* Create A/B tests.\n* Compare A/B test results.\n* Finish an A/B test.\n\n### Creating an A/B test\n\nIn the following step by step, learn how to set up a new A/B test. Notice that, before proceeding any further, you must already have a [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace) containing the changes you want to evaluate.\n\n1. Access the VTEX Admin.\n2. Go to **Extensions Hub > Installed Apps > AB Tester**.\n3. Click on **Create new AB test**.\n4. Fill out the presented fields as in the following: \n * **Workspace Name -** Enter the name of the production workspace containing the changes you want to examine via the A/B test. \n * **Traffic Proportion -** Enter the desired traffic proportion to be destined for the **master** workspace during the first hours of the A/B test. This value must be any whole number between 0 and 10000\\. For example, to set 90% of the traffic to the master workspace, enter 9000. \n * **Amount of Time -** Enter the amount of time (in hours) during which the specified **Traffic Proportion** will be maintained. After this period, the traffic proportions of the test will be automatically updated by the A/B testing system. Enter `0` if you prefer the A/B testing system to take care of your website traffic distribution from the start. \n > The A/B testing automatically balances traffic every 3 minutes according to the conversion or revenue rates. \n * **Test Type -** Enter what the A/B test must evaluate: revenue or conversion.\n5. Click on **Save**.\n\nOnce you save your changes, the A/B test will start immediately, splitting your website traffic according to your preferences.\n\n### Comparing results\n\nAfter creating your A/B test, the **AB Tester** app will provide a table containing some metrics that will help you evaluate and interpret the test status. This table contains the following information:\n\n* **Conversion** \\- Conversion rate percentage that each workspace presented during the test.\n* **Conversion (last 24hrs)** \\- Conversion rate percentage that each workspace presented during the test's last 24 hours.\n* **N. of Sessions** \\- Total number of sessions of each workspace since the beginning of the test.\n* **N. of Sessions (last 24hrs)** \\- Number of sessions for each workspace during the test's last 24 hours.\n\n### Finishing an A/B Test\n\nAlthough automatic, an A/B test will not end by itself. Take the following steps to terminate an A/B test:\n\n1. Access the VTEX Admin.\n2. Go to **Extensions Hub > Installed Apps > AB Tester** and scroll the horizontal bar until you see a Kebab menu.\n3. Click on the Kebab menu and click on **Finish A/B Test**.\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/vtexarg-abtester.md)\n\nSee also\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/vtexarg-abtester/docs/guides/vtexarg-abtester%23configuration)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides/vtexarg-abtester%23usage)\n\n[Creating an A/B test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides/vtexarg-abtester%23creating-an-ab-test)[Comparing results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides/vtexarg-abtester%23comparing-results)[Finishing an A/B Test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides/vtexarg-abtester%23finishing-an-ab-test)\n\nWas this helpful?\n\n 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/vtexarg-abtester.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/vtexarg-abtester/docs/guides/vtexarg-abtester%23configuration)\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides/vtexarg-abtester%23usage)\n\n[Creating an A/B test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides/vtexarg-abtester%23creating-an-ab-test)[Comparing results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides/vtexarg-abtester%23comparing-results)[Finishing an A/B Test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester/docs/guides/vtexarg-abtester%23finishing-an-ab-test)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_18011b97
|
[
{
"role": "system",
"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 minicart 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.minicart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/guides/basic-components)\n\nMinicart\n\nOfficial extension\n\nVersion: 2.68.0\n\nLatest version: 2.68.0\n\n[](#contributors-)\n\n> Minicart v1 block has been deprecated in favor of Minicart v2, which can be customized using the blocks defined by [Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list) and [Checkout Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary). If you still use Minicart v1, see the [Minicart v1 documentation](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart/blob/383d7bbd3295f06d1b5854a0add561a872e1515c/docs/README.md).\n\nThe Minicart is a block that displays a summary list of all items added to the shopping cart, fetched from the Checkout OrderForm API.\n\n\n\n## Configurating Minicart\n\n1. Import the Minicart app to your theme dependencies in the `manifest.json`, as shown below:\n\n`1\n\n\"dependencies\": { \n\n2\n\n \"vtex.minicart\": \"2.x\" \n\n3\n\n} \n\n`\n\n1. Add the `minicart.v2` block to your `header`. For example:\n\n`1\n\n\"header.full\": { \n\n2\n\n \"blocks\": [\"header-layout.desktop\", \"header-layout.mobile\"] \n\n3\n\n }, \n\n4\n\n \n5\n\n \"header-layout.desktop\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"header-row#1-desktop\", \n\n8\n\n ] \n\n9\n\n }, \n\n10\n\n \n11\n\n \"header-row#1-desktop\": { \n\n12\n\n \"children\": [\"minicart.v2\"], \n\n13\n\n }, \n\n`\n\n> Minicart v2 will only effectively function if the store uses the [add-to-cart app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.add-to-cart-button) instead of the [buy-button block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/buybutton) in blocks such as the Shelf and the Product Details page. This is because Minicart v2 was built based on an indirect dependency on the Add to Cart button. This means that even if Minicart v2 is correctly configured in the code, it cannot be rendered by other shopping buttons, such as the Buy button.\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------- |\n| variation | enum | Minicart behavior when rendered. Possible values for displaying the VTEX Minicart are: popup (appears as a pop-up window on the homepage), drawer (appears as a sidebar), link (redirects the user to the Checkout page when clicked), popupWithLink (combines link and popup functionalities), and block (displays the Minicart as a fixed block on the page). | drawer |\n| drawerSlideDirection | enum | Slide direction for the drawer Minicart opening. Possible values are: rightToLeft or leftToRight. | rightToLeft |\n| linkVariationUrl | string | Link associated with the link Minicart. | undefined |\n| maxDrawerWidth | number | Maximum width (in pixels) for the drawer Minicart when opened. | 440 |\n| openOnHover | boolean | Indicates whether the popup Minicart should open when the user hovers over it. | false |\n| quantityDisplay | enum | Shows the quantity badge even when the amount of products in the cart is zero. Possible values are: always or not-empty or never. | not-empty |\n| itemCountMode | enum | Quantity badge behavior when displaying the total items added to Minicart. Possible values are: total (quantity badge displays the number of items added to the cart), distinct (only displays the number of different products added to the cart), totalAvailable (displays the number of available items added to the cart), and distinctAvailable (displays the number of different _and_ available products added to the cart). | distinct |\n| backdropMode | enum | Controls whether the backdrop should be displayed when the drawer Minicart is opened or not. Possible values are: visible (renders the backdrop) or none (renders the drawer without backdrop). | none |\n| MinicartIcon | block | Icon displayed on the Minicart button. This prop value must match the block name responsible for rendering the desired icon. | icon-cart (from the [Store Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-icons/) app) |\n| customPixelEventId | string | Store event ID responsible for triggering the minicart.v2 to automatically open on the interface. | undefined |\n| customPixelEventName | string | Store event name responsible for triggering the minicart.v2 to automatically open on the interface. Some examples are: 'addToCart' and 'removeFromCart'. Note that using this prop will make the minicart.v2 open in **every** event with the specified name if no customPixelEventId is specified. | undefined |\n| classes | CustomCSSClasses | Used to override default CSS handles. To better understand how this prop works, we recommend reading about it [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only useful when importing this block as a React component. | undefined |\n\n### Advanced configurations\n\nThe default implementation for `minicart.v2` can be highly customizable by using other blocks. Currently, its default implementation is as follows:\n\n`1\n\n// This is the default block implementation for the minicart-layout \n\n2\n\n{ \n\n3\n\n \"minicart.v2\": { \n\n4\n\n \"props\": { \n\n5\n\n \"MinicartIcon\": \"icon-cart#minicart-icon\" \n\n6\n\n }, \n\n7\n\n \"children\": [\"minicart-base-content\"] \n\n8\n\n }, \n\n9\n\n \"icon-cart#minicart-icon\": { \n\n10\n\n \"props\": { \n\n11\n\n \"size\": 24 \n\n12\n\n } \n\n13\n\n }, \n\n14\n\n \"minicart-base-content\": { \n\n15\n\n \"blocks\": [\"minicart-empty-state\"], \n\n16\n\n \"children\": [\"minicart-product-list\", \"flex-layout.row#minicart-footer\"] \n\n17\n\n }, \n\n18\n\n \"flex-layout.row#minicart-footer\": { \n\n19\n\n \"props\": { \n\n20\n\n \"blockClass\": \"minicart-footer\" \n\n21\n\n }, \n\n22\n\n \"children\": [\"flex-layout.col#minicart-footer\"] \n\n23\n\n }, \n\n24\n\n \"flex-layout.col#minicart-footer\": { \n\n25\n\n \"children\": [\"minicart-summary\", \"minicart-checkout-button\"] \n\n26\n\n }, \n\n27\n\n \"minicart-product-list\": { \n\n28\n\n \"blocks\": [\"product-list#minicart\"] \n\n29\n\n }, \n\n30\n\n \"product-list#minicart\": { \n\n31\n\n \"blocks\": [\"product-list-content-mobile\"] \n\n32\n\n }, \n\n33\n\n \"minicart-summary\": { \n\n34\n\n \"blocks\": [\"checkout-summary.compact#minicart\"] \n\n35\n\n }, \n\n36\n\n \"minicart-checkout-button\": { \n\n37\n\n \"props\": { \n\n38\n\n \"finishShoppingButtonLink\": \"/checkout/#/orderform\" \n\n39\n\n } \n\n40\n\n }, \n\n41\n\n \n42\n\n \"checkout-summary.compact#minicart\": { \n\n43\n\n \"children\": [\"summary-totalizers#minicart\"], \n\n44\n\n \"props\": { \n\n45\n\n \"totalizersToShow\": [\"Items\", \"Discounts\"] \n\n46\n\n } \n\n47\n\n }, \n\n48\n\n \"summary-totalizers#minicart\": { \n\n49\n\n \"props\": { \n\n50\n\n \"showTotal\": true, \n\n51\n\n \"showDeliveryTotal\": false \n\n52\n\n } \n\n53\n\n }, \n\n54\n\n \"minicart-empty-state\": { \n\n55\n\n \"children\": [\"flex-layout.row#empty-state\"] \n\n56\n\n }, \n\n57\n\n \"flex-layout.row#empty-state\": { \n\n58\n\n \"children\": [\"flex-layout.col#empty-state\"] \n\n59\n\n }, \n\n60\n\n \"flex-layout.col#empty-state\": { \n\n61\n\n \"children\": [ \n\n62\n\n \"icon-cart#minicart-empty-state\", \n\n63\n\n \"rich-text#minicart-default-empty-state\" \n\n64\n\n ], \n\n65\n\n \"props\": { \n\n66\n\n \"horizontalAlign\": \"center\", \n\n67\n\n \"verticalAlign\": \"middle\", \n\n68\n\n \"rowGap\": 5 \n\n69\n\n } \n\n70\n\n }, \n\n71\n\n \"icon-cart#minicart-empty-state\": { \n\n72\n\n \"props\": { \n\n73\n\n \"size\": 64, \n\n74\n\n \"blockClass\": \"minicart-empty-state\" \n\n75\n\n } \n\n76\n\n }, \n\n77\n\n \"rich-text#minicart-default-empty-state\": { \n\n78\n\n \"props\": { \n\n79\n\n \"text\": \"Your cart is empty.\" \n\n80\n\n } \n\n81\n\n } \n\n82\n\n} \n\n`\n\nThe default implementation of `minicart.v2` consists of the `JSON` code shown above, which is used behind the scenes whenever you use this block in your store.\n\nTo customize the Minicart configuration, you can copy the code and modify it to your needs.\n\nFor detailed instructions on how to configure each of the blocks that make up `minicart.v2`, read the [Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-list) and [Checkout Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.checkout-summary) documentations.\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS handles |\n| ----------------------------- |\n| arrowUp |\n| minicartCheckoutButton |\n| minicartContainer |\n| minicartContentContainer |\n| minicartFooter |\n| minicartIconContainer |\n| minicartProductListContainer |\n| minicartQuantityBadge |\n| minicartSideBarContentWrapper |\n| minicartTitle |\n| minicartWrapperContainer |\n| popupChildrenContainer |\n| popupContentContainer |\n| popupWrapper |\n\n[Menu« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.menu)[Order PlacedNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.order-placed)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configurating Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.minicart%23configurating-minicart)\n\n[Advanced configurations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.minicart%23advanced-configurations)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.minicart/docs/apps/vtex.minicart%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_139ed62c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore using themes pages in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/styling-overview)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-overview)\n\nStyling a section\n\nFastStore provides the flexibility to use mixins for styling your page sections.\n\n> This content is currently under development.\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/using-themes/pages.mdx)\n\n[Styling a component« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-components)[Importing FastStore UI component stylesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-pages/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/using-themes/pages.mdx)\n\nCopy page\n\nOn this page\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_eee33851
|
[
{
"role": "system",
"content": "You are a VTEX 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 tag manager in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\n[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/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-tag-manager/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-tag-manager/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-tag-manager/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-tag-manager/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-tag-manager/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)\n\n[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)\n\nSetting up Google Tag Manager\n\nExplore how to track and analyze store data using Google Analytics 4.\n\nAfter installing the VTEX IO [Google Tag Manager app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager), configure the necessary variables, triggers, and tags to set it up in your store.\n\nIn this guide, you will learn how to track and analyze store data using Google Analytics 4 (GA4). The guide covers:\n\n* Configuring GA4 events by downloading and importing a container file; adding the necessary tags, triggers, and variables; and updating the Measurement ID field with your Google tag ID.\n* Testing the GA4 Configuration tag to ensure it fires correctly on every page and confirming that GA4 Event tags accurately track user actions, such as viewing a product or adding a product to the cart.\n* Using Google Analytics DebugView and Reports to check if events are being received and data is populating your reports.\n* Tracking key user actions — including product impressions, add-to-cart events, and completed orders — by leveraging Pixel Apps and GA4 events.\n\n## Before you begin\n\n### Get the VTEX IO Google Tag Manager app\n\nInstall and configure the VTEX IO Google Tag Manager app. For more information, see the guide [Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager).\n\n### Create a Google Analytics 4 (GA4) Configuration tag\n\nCreate a Google Analytics 4 (GA4) Configuration tag using your Measumerent ID in [Google Tag Manager (GTM)](https://read.calvincode.net/reader?url=https://tagmanager.google.com/). For more information, see the Google article [Set up the Google Analytics 4 Configuration tag](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/9442095).\n\n## Instructions\n\n### Step 1 - Setting up GA4 events\n\nAfter creating the GA4 Configuration tag, set up GA4 events as follows:\n\n1. Download the [GTM container file](https://read.calvincode.net/reader?url=https://developers.vtex.com/container-template.json) to preload all necessary tags, triggers, and variables.\n2. Import the container file by following Google’s [Import a container](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/6106997?%23import) guide. This will add all the necessary tags, triggers, and variables to the workspace. \n\n3. In the GTM container, go to the GA4 Configuration tag, and edit the **Measurement ID** field with your Google tag ID (G- ID). \n> To find your Google tag ID, check the [Find your Google tag ID](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/9539598?sjid=16676572490197811169-SA%23find-G-ID) guide.\n\n### Step 2 - Testing tags in Google Tag Manager\n\nTo test if the GA4 Configuration tag is firing correctly on every page, use the [Preview mode](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/6107056) in GTM. Additionally, check if the GA4 Event tags are firing accurately for user actions, such as viewing a product or adding a product to the cart.\n\n### Step 3 - Testing events sent to Google Analytics 4\n\nTo check if the events are being received and the reports are populated with data, go to the Google Analytics Admin and use the [DebugView](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/7201382) to make sure the events are arriving and the [Reports](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/9212670) are getting the data.\n\n\n\nTo see the available events that GA4 can track, check the [Overview of trackable events](#overview-of-trackable-events) section.\n\n## Overview of trackable events\n\nThis section provides a list of events that GA4 can track and explains the `view_promotion` event, which is usually attached to the promotion banner carousel displayed by the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout) block.\n\n### View promotion\n\nThe [GA4 view\\_promotion](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fpromotion) event expects the product name or ID associated with it.\n\nThis event is commonly attached to the promotion banner carousel displayed by the Slider Layout block. For example, you can use Site Editor to configure the `Product ID` and `Product Name`. To access Site Editor, go to **Storefront > Site Editor** in the VTEX Admin.\n\n\n\n### Supported events\n\nCheck the available events that [Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pixel-apps) can listen to, along with their corresponding names in Universal Analytics (UA) and Google Analytics 4 (GA4):\n\n| VTEX | UA | GA4 |\n| ---------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |\n| vtex:promoView | promoView | [view\\_promotion](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fpromotion) |\n| vtex:promotionClick | promoClick | [select\\_promotion](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23select%5Fpromotion) |\n| vtex:productImpression | impressions | [view\\_item\\_list](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fitem%5Flist) |\n| vtex:productClick | click | [select\\_item](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23select%5Fitem) |\n| vtex:productView | detail | [view\\_item](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fitem) |\n| vtex:addToCart | add | [add\\_to\\_cart](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23add%5Fto%5Fcart) |\n| vtex:removeFromCart | remove | [remove\\_from\\_cart](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23remove%5Ffrom%5Fcart) |\n| vtex:viewCart | Not applicable | [view\\_cart](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fcart) |\n| vtex:beginCheckout | checkout | [begin\\_checkout](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23refund) |\n| vtex:addShippingInfo | Not applicable | [add\\_shipping\\_info](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23add%5Fshipping%5Finfo) |\n| vtex:addPaymentInfo | Not applicable | [add\\_payment\\_info](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23add%5Fpayment%5Finfo) |\n| vtex:orderPlaced | purchase | [purchase](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23purchase) |\n| vtex:refund | Not applicable | [refund](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23refund) |\n| vtex:search | Not applicable | [search](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23search) |\n| vtex:share | Not applicable | [share](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23share) |\n| vtex:addToWishlist | Not applicable | [add\\_to\\_wishlist](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23add%5Fto%5Fwishlist) |\n\n### Partially supported events\n\nThe following events are not fully supported yet. Although the GTM app will listen and format them into GA4, corresponding VTEX event triggers have not been implemented yet:\n\n| VTEX | GA4 |\n| ----------- | ------------------------------------------------------------------------------------------------------------------------- |\n| vtex:login | [login](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23login) |\n| vtex:signUp | [sign\\_up](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23sign%5Fup) |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/google-tag-manager/vtex-io-documentation-setting-up-google-tag-manager.md)\n\n[Installing Google Tag Manager« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager//docs/guides/vtex-io-documentation-installing-google-tag-manager)[Setting up cross-border storesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager//docs/guides/store-framework-setting-up-cross-border-stores)\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-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23before-you-begin)\n\n[Get the VTEX IO Google Tag Manager app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23get-the-vtex-io-google-tag-manager-app)[Create a Google Analytics 4 (GA4) Configuration tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23create-a-google-analytics-4-ga4-configuration-tag)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23instructions)\n\n[Step 1 - Setting up GA4 events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-1-setting-up-ga4-events)[Step 2 - Testing tags in Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-2-testing-tags-in-google-tag-manager)[Step 3 - Testing events sent to Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-3-testing-events-sent-to-google-analytics-4)\n\n[Overview of trackable events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23overview-of-trackable-events)\n\n[View promotion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23view-promotion)[Supported events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23supported-events)[Partially supported events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23partially-supported-events)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/google-tag-manager/vtex-io-documentation-setting-up-google-tag-manager.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-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23before-you-begin)\n\n[Get the VTEX IO Google Tag Manager app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23get-the-vtex-io-google-tag-manager-app)[Create a Google Analytics 4 (GA4) Configuration tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23create-a-google-analytics-4-ga4-configuration-tag)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23instructions)\n\n[Step 1 - Setting up GA4 events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-1-setting-up-ga4-events)[Step 2 - Testing tags in Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-2-testing-tags-in-google-tag-manager)[Step 3 - Testing events sent to Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-3-testing-events-sent-to-google-analytics-4)\n\n[Overview of trackable events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23overview-of-trackable-events)\n\n[View promotion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23view-promotion)[Supported events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23supported-events)[Partially supported events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23partially-supported-events)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_20247442
|
[
{
"role": "system",
"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 productsummaryspecificationbadges 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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/docs/api-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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/docs/storefront-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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/docs/troubleshooting)\n\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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryspecificationbadges/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryspecificationbadges/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryspecificationbadges/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryspecificationbadges/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryspecificationbadges/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/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/productsummaryspecificationbadges/docs/vtex-io-apps)\n\nProduct Specification Badges\n\n[vtex.product-summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary)\n\nVersion: 2.91.0\n\nLatest version: 2.91.0\n\n\n\n> The Product Specification Badges block has been deprecated in favor of the [Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-specifications) app. Although support for this block is still available, we strongly recommend that you update your store theme with the Product Specifications app to stay up with the component's evolution.\n\nUse this component to show badges based on your product specifications inside your product page.\n\n### Configuration\n\nThis component must be configured to be able to display the specifications properly. Its props can be configured via `blocks.json` and they are:\n\n| Prop name | Type | Description | Default value |\n| ---------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| specificationGroupName | String | The name of the specification group in which the desired specifications are | \"\" |\n| specificationName | String | Pass the name of the specification you want to target. If left empy, will target all of the group | \"\" |\n| visibleWhen | String | Pass this if you want the specification to be displayed only if it has this exact value. If left empty, the badge will be showed regardless of the specification value. | \"\" |\n| displayValue | SPECIFICATION\\_NAME or SPECIFICATION\\_VALUE or string | Choose the value that will appear if the specification condition is met and the badge will be showed. Pass SPECIFICATION\\_NAME if you want to display the specification name. Pass SPECIFICATION\\_VALUE if you want to display its value. Pass any other custom string to display it. | null |\n| specificationsOptions | Array<Option> | Pass this if you want to control the conditions to show certain specifications. Each value of the array should be a valid object of the Option format. | null |\n| orientation | vertical or horizontal | Determines if the group of specifications are showed horizontally or vertically | vertical |\n| blockClass | string | Allows to pass a custom name to be added to component css classes | null |\n\n`Option` type:\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| specificationName | String | Pass the name of the specification you want to target. If empty, option will not be checked. | \"\" |\n| visibleWhen | string | Pass this if you want this option to be applied when the specification has the exactly same value as specified in visibleWhen. If left empty, the badge will be showed regardless of the specification value. | null |\n| displayValue | SPECIFICATION\\_NAME or SPECIFICATION\\_VALUE or string | Choose the value that will appear if the option condition is met and the badge will be showed. Pass SPECIFICATION\\_NAME if you want to show the specification name. Pass SPECIFICATION\\_VALUE if you want to show its value. Pass any other custom string to show it. | null |\n\nImportant note: All products come with a default `allSpecifications` group, that is a group that combines all specifications in your product. If you manually create another group and add a specification in it, this specification will also appear in the `allSpecifications` group. So, if you want to apply your conditions to all specification, regardless of group, you must pass the value `allSpecifications`.\n\n### Example 1\n\nLet's say your product has this specification groups:\n\n`1\n\n// specificationGroups array \n\n2\n\n[ \n\n3\n\n { \n\n4\n\n name: 'Group', \n\n5\n\n specifications: [ \n\n6\n\n { \n\n7\n\n name: 'On Sale', \n\n8\n\n values: ['True'], \n\n9\n\n }, \n\n10\n\n ], \n\n11\n\n }, \n\n12\n\n { \n\n13\n\n name: 'Group 2', \n\n14\n\n specifications: [ \n\n15\n\n { \n\n16\n\n name: 'Demo', \n\n17\n\n values: ['True'], \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n name: 'PromoExclusion', \n\n21\n\n values: ['1'], \n\n22\n\n } \n\n23\n\n ], \n\n24\n\n }, \n\n25\n\n { \n\n26\n\n name: 'allSpecifications', \n\n27\n\n specifications: [ \n\n28\n\n { \n\n29\n\n name: 'On Sale', \n\n30\n\n values: ['True'], \n\n31\n\n }, \n\n32\n\n { \n\n33\n\n name: 'Demo', \n\n34\n\n values: ['True'], \n\n35\n\n }, \n\n36\n\n { \n\n37\n\n name: 'PromoExclusion', \n\n38\n\n values: ['1'], \n\n39\n\n }, \n\n40\n\n ], \n\n41\n\n }, \n\n42\n\n ] \n\n`\n\nIf you want to display all specifications with the value `True`, you could then pass:\n\n`1\n\n\"product-specification-badges\": { \n\n2\n\n \"props\": { \n\n3\n\n \"specificationGroupName\": \"allSpecifications\", \n\n4\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n5\n\n \"visibleWhen\": \"True\" \n\n6\n\n } \n\n7\n\n }, \n\n`\n\nIn this case, it will appear the `On Sale` and `Demo` badges (because you passed the `SPECIFICATION_NAME` in `displayValue`).\n\n### Example 2\n\nUsing the specification groups from example 1, we can get the same result with the specificationOptions prop:\n\n`1\n\n \"product-specification-badges\": { \n\n2\n\n \"props\": { \n\n3\n\n \"specificationGroupName\": \"allSpecifications\", \n\n4\n\n \"specificationsOptions\": [{ \n\n5\n\n \"specificationName\": \"On Sale\", \n\n6\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n7\n\n \"visibleWhen\": \"True\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"specificationName\": \"Demo\", \n\n11\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n12\n\n \"visibleWhen\": \"True\" \n\n13\n\n }] \n\n14\n\n } \n\n15\n\n }, \n\n`\n\n### Example 3\n\n`1\n\n// specificationGroups array \n\n2\n\n[ \n\n3\n\n { \n\n4\n\n name: 'Group', \n\n5\n\n specifications: [ \n\n6\n\n { \n\n7\n\n name: 'On Sale', \n\n8\n\n values: ['True'], \n\n9\n\n }, \n\n10\n\n ], \n\n11\n\n }, \n\n12\n\n { \n\n13\n\n name: 'Group 2', \n\n14\n\n specifications: [ \n\n15\n\n { \n\n16\n\n name: 'Demo', \n\n17\n\n values: ['True'], \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n name: 'PromoExclusion', \n\n21\n\n values: ['1'], \n\n22\n\n } \n\n23\n\n ], \n\n24\n\n }, \n\n25\n\n { \n\n26\n\n name: 'allSpecifications', \n\n27\n\n specifications: [ \n\n28\n\n { \n\n29\n\n name: 'On Sale', \n\n30\n\n values: ['True'], \n\n31\n\n }, \n\n32\n\n { \n\n33\n\n name: 'Demo', \n\n34\n\n values: ['My Cool Value'], \n\n35\n\n }, \n\n36\n\n { \n\n37\n\n name: 'PromoExclusion', \n\n38\n\n values: ['1'], \n\n39\n\n }, \n\n40\n\n ], \n\n41\n\n }, \n\n42\n\n ] \n\n`\n\nIf you want to show the value for the `Demo`\u001d specification, you could pass:\n\n`1\n\n \"product-specification-badges\": { \n\n2\n\n \"props\": { \n\n3\n\n \"specificationGroupName\": \"allSpecifications\", \n\n4\n\n \"specificationsOptions\": [{ \n\n5\n\n \"specificationName\": \"On Sale\", \n\n6\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n7\n\n \"visibleWhen\": \"True\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"specificationName\": \"Demo\", \n\n11\n\n \"displayValue\": \"SPECIFICATION_VALUE\", \n\n12\n\n }] \n\n13\n\n } \n\n14\n\n }, \n\n`\n\nFinal result: will appear the `On Sale` badge and a badge with `My Cool Value`.\n\nNote the use of `SPECIFICATION_VALUE` in `displayValue` and the lack of `visibleWhen` in `Demo`.\n\n### Example 4\n\nUsing the example given in example 3.\n\nTo show a custom string you could do:\n\n`1\n\n \"product-specification-badges\": { \n\n2\n\n \"props\": { \n\n3\n\n \"specificationGroupName\": \"allSpecifications\", \n\n4\n\n \"specificationsOptions\": [{ \n\n5\n\n \"specificationName\": \"On Sale\", \n\n6\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n7\n\n \"visibleWhen\": \"True\" \n\n8\n\n }, \n\n9\n\n { \n\n10\n\n \"specificationName\": \"Demo\", \n\n11\n\n \"displayValue\": \"SPECIFICATION_VALUE\", \n\n12\n\n }, \n\n13\n\n { \n\n14\n\n \"specificationName\": \"PromoExclusion\", \n\n15\n\n \"displayValue\": \"Cool Promo\", \n\n16\n\n }] \n\n17\n\n } \n\n18\n\n }, \n\n`\n\nFinal result: will appear the `On Sale` badge, a badge with `My Cool Value` and a badge with the string `Cool Promo`.\n\nNote the usage of a custom value in the `displayValue` config.\n\n### Usage tip\n\nYou can use our `stack-layout` to show the badges over your product image for example.\n\n`1\n\n \"stack-layout\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"product-images\", \n\n4\n\n \"product-specification-badges\" \n\n5\n\n ] \n\n6\n\n }, \n\n7\n\n \n8\n\n \"product-specification-badges\": { \n\n9\n\n \"props\": { \n\n10\n\n \"specificationGroupName\": \"allSpecifications\", \n\n11\n\n \"displayValue\": \"SPECIFICATION_NAME\", \n\n12\n\n \"specificationName: \"On Sale\", \n\n13\n\n \"visibleWhen\": \"True\" \n\n14\n\n } \n\n15\n\n }, \n\n16\n\n \"flex-layout.row#product-image\": { \n\n17\n\n \"children\": [\"product-images\"] \n\n18\n\n }, \n\n`\n\n## 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| groupContainer |\n| badgeContainer |\n| badgeText |\n\nNote: each badge also receives a class `badgeContainer` with its specification name slug appended to it. Example: on specification `On Sale` the badge will also have the class `badgeContainer--on-sale`.\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/productsummaryspecificationbadges/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[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryspecificationbadges/docs/apps/vtex.product-summary/productsummaryspecificationbadges%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_03a130da
|
[
{
"role": "system",
"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 pick and pack protocol api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-protocol-api/)\n\nAuthentication\n\nService integration\n\nCarriers\n\nShipping updates\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/intelligent-search-api/)\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-protocol-api/)\n\nAuthentication\n\nService integration\n\nCarriers\n\nShipping updates\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeList shipments by order ID« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-api%23get-/shipments/-orderId-)[PoCreate JWT tokenNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-protocol-api%23post-/token)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_962eae2c
|
[
{
"role": "system",
"content": "You are a VTEX 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 configuration 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/payments-configuration-guides/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-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/payments-configuration-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/payments-configuration-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/payments-configuration-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/payments-configuration-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/payments-configuration-guides/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-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/payments-configuration-guides/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/payments-configuration-guides)\n\n[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/setting-up-the-type-of-interest-rate)\n\n[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/setting-up-merchant-id-in-apple-pay)\n\n[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/cardholder-document-configuration)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\n\n[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/metadata-information-in-payment-transactions)\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-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/payments-configuration-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/payments-configuration-guides/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-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/payments-configuration-guides/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/master-data)\n\n---\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/payments-configuration-guides)\n\n[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/setting-up-the-type-of-interest-rate)\n\n[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/setting-up-merchant-id-in-apple-pay)\n\n[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/cardholder-document-configuration)\n\n[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)\n\n[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/metadata-information-in-payment-transactions)\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-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/payments-configuration-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/payments-configuration-guides/docs/guides)\n\nPayments\n\n[Configuration Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/payments-configuration-guides)\n\nConfiguration Guides\n\nThe articles listed below will present the necessary steps to make payment settings.\n\n| Article | Description |\n| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |\n| [Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate) | How to identify the payment methods' ID and set up the interest rate type using the Payments Gateway API. |\n| [Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay) | How to set up Merchant ID in Apple Pay. |\n| [Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration) | How to configure a cardholder document field to be displayed at checkout. |\n| [Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions) | How to activate the anti-fraud flow for debit card transactions. |\n| [Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions) | How to insert metadata information into your payment transactions. |\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/brunoamui)\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/Payments/payments-configuration-guides.md)\n\n[Interacting with Master Data v1 through VTEX IO services« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides//docs/guides/interacting-with-master-data-v1-through-vtex-io-services)[Setting up the type of interest rateNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides//docs/guides/setting-up-the-type-of-interest-rate)\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/brunoamui)\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/Payments/payments-configuration-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_1ffbfa82
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides best practices for avoiding rate limit errors in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/authentication)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/api-response-codes)\n\nError handling and best practices\n\n[Handling errors and exceptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/handling-errors-and-exceptions)\n\n[Best practices for avoiding rate limit errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/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/best-practices-for-avoiding-rate-limit-errors/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/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/best-practices-for-avoiding-rate-limit-errors/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/authentication)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/api-response-codes)\n\nError handling and best practices\n\n[Handling errors and exceptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/handling-errors-and-exceptions)\n\n[Best practices for avoiding rate limit errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/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/best-practices-for-avoiding-rate-limit-errors/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/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/best-practices-for-avoiding-rate-limit-errors/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/api-usage)\n\nError handling and best practices\n\n[Best practices for avoiding rate limit errors](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors)\n\nBest practices for avoiding rate limit errors\n\nLearn how to responsibly manage rate limits for fair and reliable usage of VTEX Core Commerce APIs.\n\nRate limits serve as crucial control mechanisms for managing the volume and frequency of requests made to an API. Exceeding these limits can lead to disruptions in service and a temporary suspension of access to [VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference). This article delves into the best practices for responsibly dealing with rate limits while ensuring your apps and store code adhere to ethical and responsible digital practices.\n\n## Implement efficient data retrieval techniques\n\nImplementing efficient data retrieval techniques is pivotal in optimizing system performance and ensuring seamless operations. This section delves into the best practices for minimizing resource usage while maximizing the efficiency of [VTEX IO apps](#vtex-io-apps) and [Storefront implementations](#storefront-implementation).\n\n### VTEX IO apps\n\nWhen developing VTEX IO apps, it is generally advised to avoid direct API communication in favor of implementing dedicated [Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients). VTEX IO Clients come equipped with several built-in features that enhance the functionality and performance of your apps:\n\n* **Cache:** Clients come equipped with efficient caching mechanisms that store and retrieve data, reducing the strain on services and improving response times.\n* **Native metrics support:** Clients integrate with performance monitoring and analytics tools, providing insights into service usage and performance.\n* **Retry and timeout options:** Clients offer flexible configurations for retries and timeout, ensuring the robustness and resilience of your app when confronted with network issues or service unavailability.\n* **Billing tracking:** Clients can track usage and resource consumption, aiding in billing and cost optimization.\n\nNote that VTEX offers a selection of native Clients within the `@vtex/clients` library, streamlining the interaction with services like VTEX Core Commerce APIs and other internal resources. However, if your VTEX IO app requires integration with external services not covered by the `@vtex/clients` library, you can employ the `@vtex/api` to harness type support and develop your own custom clients.\n\n### Storefront implementation\n\nWe strongly advise the adoption of GraphQL in storefront implementations as it offers various advantages, particularly in avoiding potential rate-limit errors. GraphQL allows developing applications that precisely request and receive only the necessary data to fulfill the frontend. This ability is key in reducing over-fetching and minimizing the data transferred, effectively alleviating the burden on API endpoints. Additionally, by aggregating multiple data requirements into a single request, GraphQL streamlines the data retrieval process, optimizing efficiency and decreasing the number of necessary requests for a given operation.\n\nTo leverage these capabilities, check our specialized [frontend solutions](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/store-development--3fHF3GIjK8UugnQKIakpl9/5DTcawNjc5MovtD7HNqURl) designed to harness the benefits of GraphQL.\n\n## Cache data\n\nCaching can play a crucial role in helping applications manage rate limits more effectively. Instead of always retrieving the data through a new request to VTEX Core Commerce APIs, this strategy retrieves data from a cache, which is usually a faster storage medium. By avoiding repeated queries to external APIs, the request volume decreases.\n\nTo effectively implement data caching and reduce the need for repeated API requests, consider the following:\n\n* **Identify cacheable data:** Determine which data can benefit from caching. Typically, this includes data that is frequently read and relatively static.\n* **Select a cache server close to the client:** Select a cache server close to the client so data can be retrieved with lower latency and faster response times. Note that the physical distance between the client and cache server plays a significant role in determining data retrieval speed.\n* **Set expiry times:** Define how long data should be cached before it is considered stale. You may set it as cacheable for minutes, days, or longer.\n* **Implement strategies for cache invalidation:** Implement strategies for cache invalidation, which ensure that the cache is updated when the underlying data changes.\n\n## Prioritize requests\n\nSome requests may be more critical than others. Prioritize essential requests over non-essential ones. This can be achieved by implementing a queue system or distinguishing between high and low-priority requests.\n\nThe business logic of your app or integration often dictates the importance of certain operations. For example, operations initiated by user interactions, like submitting a form, usually take precedence over background tasks.\n\n* **Define priority levels:** Establish a hierarchy of request priority levels. For example, high, medium, and low.\n* **Categorize requests:** Assign each request a priority level based. Consider the following: \n * **Business logic:** Identity requests crucial for core business functions, such as checkout processes, account management, or high-traffic pages. \n * **User interactions:** Prioritize requests that directly affect user experience, like loading times for key pages or features. \n * **Service Level Agreements (SLAs):** Ensure priority levels align with SLAs, giving precedence to requests stipulated in high-priority agreements. \n * **Interdependencies:** Consider the impact of delaying certain requests on subsequent actions or dependent processes.\n* **Implement a queue system:** Use a queue or scheduling mechanism to manage and execute requests based on their priority.\n* **Handle errors and exceptions:** Ensure that error handling takes into account request priority. For high-priority requests, implement more aggressive error recovery strategies.\n\n### Example\n\nSuppose that, during a sale event, a store starts experiencing a surge in traffic. To safeguard the user experience and ensure that critical functions remain accessible, the store employs a strategy of prioritizing incoming requests.\n\nDuring this period, requests are categorized and handled with a deliberate focus on user needs and performance. For example, checkout requests are granted the highest priority. The store ensures that these requests are processed without any undue delays, allowing customers to successfully complete their purchases.\n\nIn contrast, non-essential features, such as social sharing options, are granted the lowest priority, meaning these features may be temporarily deprioritized or even disabled. By applying this prioritization approach, the store assures that critical functions are available to users without interruption, even during peak traffic.\n\n## Implement optimized retries with exponential backoff\n\nProactively manage your requests by avoiding unnecessary or excessive API calls. Excessive API calls can degrade your app's performance, increasing response times. If the service responds with rate limit exceeded errors, consider implementing exponential backoff, which gradually increases the delay between retry attempts to reduce the load on the service.\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/best-practices-for-avoiding-rate-limit-errors.md)\n\n[Handling errors and exceptions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors//docs/guides/handling-errors-and-exceptions)[Getting startedNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors//docs/guides/getting-started)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Implement efficient data retrieval techniques](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23implement-efficient-data-retrieval-techniques)\n\n[VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23vtex-io-apps)[Storefront implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23storefront-implementation)\n\n[Cache data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23cache-data)\n\n[Prioritize requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23prioritize-requests)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23example)\n\n[Implement optimized retries with exponential backoff](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23implement-optimized-retries-with-exponential-backoff)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/best-practices-for-avoiding-rate-limit-errors.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Implement efficient data retrieval techniques](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23implement-efficient-data-retrieval-techniques)\n\n[VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23vtex-io-apps)[Storefront implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23storefront-implementation)\n\n[Cache data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23cache-data)\n\n[Prioritize requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23prioritize-requests)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23example)\n\n[Implement optimized retries with exponential backoff](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/best-practices-for-avoiding-rate-limit-errors/docs/guides/best-practices-for-avoiding-rate-limit-errors%23implement-optimized-retries-with-exponential-backoff)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_11e0e59a
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides authentication 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/authentication-overview/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-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/authentication-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/authentication-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/authentication-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/authentication-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/authentication-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/authentication)\n\nAuthentication\n\nAuthentication is a crucial aspect of API integrations, backend, and frontend app development. It ensures authorized access by requiring valid credentials like API keys or tokens. This shields sensitive data, prevents breaches, and builds user trust. Get started with VTEX authentication for developers with the following guides:\n\n* [API authentication using application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)\n* [API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens)\n* [App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens)\n\nThere are different contexts in which authentication is required in the regular functioning of a VTEX store. Below are some example use cases and the recommended authentication methods.\n\n| **Use case** | **Indicated authentication methods** |\n| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Backend VTEX IO app | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) via VTEX IO context, or, if needed, [app authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens) via VTEX IO context |\n| Frontend VTEX IO app | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) via VTEX IO context |\n| Self-hosted backend request to VTEX APIs | [Application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) |\n| Self-hosted frontend request to VTEX APIs | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) |\n\n## Single sign on integrations\n\nVTEX allows stores to integrate with external identity providers to provide single sign on (SSO) experiences to shoppers and Administrative users. You can learn more about this in the article [Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/login-integration-guide) and below you can find more information on these and other SSO use cases:\n\n* [Store SSO with OAuth 2.0](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2)\n* [Admin SSO with SAML 2.0](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2)\n* [Use your VTEX account as an OAuth provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x)\n\n## Learn more\n\n* **Authorization**: [Users](https://read.calvincode.net/reader?url=https://help.vtex.com/en/subcategory/users--63DHe3VQEEE6Uuua8gIs2M), [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) and [License Manager Resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)\n* **Auditability**: [Audit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/searching-for-events-on-audit--5RXf9WJ5YLFBcS8q8KcxTA)\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/Getting-Started/authentication/authentication.md)\n\n[Making your first request« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview//docs/guides/making-your-first-request)[API authentication using API keysNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview//docs/guides/api-authentication-using-api-keys)\n\nSee also\n\n[API authentication using API keysGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-authentication-using-api-keys)[API authentication using user tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/api-authentication-using-user-tokens)[App authentication using auth tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/app-authentication-using-auth-tokens)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Single sign on integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/authentication%23single-sign-on-integrations)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/authentication%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/Getting-Started/authentication/authentication.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Single sign on integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/authentication%23single-sign-on-integrations)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication-overview/docs/guides/authentication%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_f0b478f9
|
[
{
"role": "system",
"content": "You are a VTEX 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 tooltip in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-tooltip/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-tooltip/docs/api-reference)\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-tooltip/docs/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-tooltip/docs/storefront-development)\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-tooltip/docs/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-tooltip/docs/troubleshooting)\n\n[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-tooltip/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-tooltip/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-tooltip/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/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-tooltip/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/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-tooltip/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/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-tooltip/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-tooltip/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-tooltip/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-tooltip/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/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-tooltip/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-tooltip/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/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-tooltip/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-tooltip/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/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-tooltip/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/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-tooltip/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/atoms-overview)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-overview)\n\n[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-accordion)\n\n[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-alert)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-breadcrumb)\n\n[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-buy-button)\n\n[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-card)\n\n[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-carousel)\n\n[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-cart-item)\n\n[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-checkbox-field)\n\n[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-discount-badge)\n\n[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-dropdown)\n\n[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-gift)\n\n[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-icon-button)\n\n[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-input-field)\n\n[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-link-button)\n\n[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-modal)\n\n[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-navbar-links)\n\n[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-order-summary)\n\n[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-popover)\n\n[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-product-card)\n\n[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-product-price)\n\n[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-product-title)\n\n[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-quantity-selector)\n\n[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-radio-field)\n\n[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-radio-group)\n\n[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-rating)\n\n[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-rating-field)\n\n[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-region-bar)\n\n[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-auto-complete)\n\n[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-dropdown)\n\n[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-history)\n\n[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-input-field)\n\n[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-products)\n\n[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-search-top)\n\n[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-select-field)\n\n[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-sku-selector)\n\n[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-table)\n\n[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tag)\n\n[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-textarea-field)\n\n[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-toast)\n\n[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-toggle)\n\n[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-toggle-field)\n\n[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/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-tooltip/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-tooltip/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-tooltip/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-tooltip/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/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-tooltip/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-tooltip/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-tooltip/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/components-index)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-overview)\n\nTooltip\n\nTooltip provides contextual information.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Tooltip)\n\n`Tooltip` is a component that provides contextual information when users hover over or click an element.\n\nExample\n\nCode\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Tooltip } 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/Tooltip/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-button-height | var(--fs-control-tap-size) |\n| \\--fs-tooltip-z-index | var(--fs-z-index-high) |\n| \\--fs-tooltip-background | var(--fs-color-neutral-6) |\n| \\--fs-tooltip-text-color | var(--fs-color-text-inverse) |\n| \\--fs-tooltip-border-radius | var(--fs-border-radius) |\n| \\--fs-tooltip-padding | var(--fs-spacing-2) |\n| \\--fs-tooltip-gap | var(--fs-spacing-1) |\n| \\--fs-tooltip-transition-property | opacity |\n| \\--fs-tooltip-transition-timing | var(--fs-transition-timing) |\n| \\--fs-tooltip-transition-function | var(--fs-transition-function) |\n\n### Indicator\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | ---------------------------------------------------------------------------------- |\n| \\--fs-tooltip-indicator-size | var(--fs-spacing-1) |\n| \\--fs-tooltip-indicator-distance-edge | var(--fs-spacing-3) |\n| \\--fs-tooltip-indicator-distance-base | var(--fs-spacing-1) |\n| \\--fs-tooltip-indicator-translate | calc(var(--fs-tooltip-indicator-size) + var(--fs-tooltip-indicator-distance-base)) |\n\n---\n\n## Data attributes\n\nYou can target and override `Tooltip` styles using the following data attributes:\n\n`data-fs-tooltip`\n\n`data-fs-tooltip-wrapper`\n\n`data-fs-tooltip-content`\n\n`data-fs-tooltip-dismiss-button`\n\n`data-fs-tooltip-indicator`\n\n---\n\n## Props\n\n| Name | Type | Description | Default | | | | | | | | | | |\n| ----------------- | --------------------------- | -------------------------------------------------------------------------------------- | --------------- | -------------- | ------------------------ | --------------------------- | ------------------- | ------------ | -------------------------------------------------- | ------------- | ---------- | ------------------------------------------------------------------------------------ | ---------- |\n| **content\\*** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Text/content of the tooltip. | | | | |\n| **placement** | \"top-start\" \\| \"top-center\" | \"top-end\" | \"right-start\" | \"right-center\" | \"right-end\" | \"bottom-start\" | \"bottom-center\" | \"bottom-end\" | \"left-start\" | \"left-center\" | \"left-end\" | Defines the side or side-alignment (e.g., \"top-center\", \"right-end\") of the tooltip. | top-center |\n| **dismissible** | false \\| true | If the tooltip can be closed by a button. | false | | | | | | | | | | |\n| **onDismiss** | (ev: any) => void | Called when the dismiss button is clicked. | | | | | | | | | | | |\n| **children\\*** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Element that activates the tooltip on hover/focus. | | | | |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-tooltip | | | | | | | | | | |\n| **maxWidth** | number | Maximum width of the tooltip. | 300 | | | | | | | | | | |\n| **describedById** | string | ID for the tooltip content to be used with aria-describedby. | tooltip-content | | | | | | | | | | |\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/tooltip.mdx)\n\n[ToggleField« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-toggle-field)[OrganismsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/organisms-overview)\n\nContributors\n\n3\n\n[](https://github.com/mariana-caetano)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23design-tokens)\n\n[Indicator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23indicator)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%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/tooltip.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-tooltip/docs/guides/faststore/molecules-tooltip%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23import-styles)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23design-tokens)\n\n[Indicator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23indicator)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tooltip/docs/guides/faststore/molecules-tooltip%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_3ce6e324
|
[
{
"role": "system",
"content": "You are a VTEX 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 payment information to the cart in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-api-overview)\n\n[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/custom-data-1)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/customization)\n\n[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/discounts)\n\n[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/features)\n\n[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/orders-2)\n\n[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-security)\n\n[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/shopping-cart-section-api-quick-start-guides)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Getting a customer profile by email](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/getting-a-customer-profile-by-email)\n\n[Adding customer profile information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-customer-profile-information-to-the-cart)\n\n[Add shipping address and select delivery option](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-shipping-address-and-delivery-option-to-the-cart)\n\n[Adding customer preferences to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-customer-preferences-to-the-cart)\n\n[Adding marketing information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-marketing-information-to-the-cart)\n\n[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-cart-items)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\n[Adding merchant context information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/add-merchant-context-information-to-the-cart)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/configuration-section-api-quick-start-guides)\n\n[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)\n\n[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/region-section-api-quick-start-guides)\n\n[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-error-codes)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides)\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/checkout-api-overview)\n\n[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/cart-attachments-section-api-quick-start-guides)\n\n[Adding payment information to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart)\n\nAdding payment 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 payment information to the shopping cart via API.\n\n> The payment information attached to the shopping cart does not determine the final order payment method. However, it allows the platform to update any relevant information that might be affected by the payment method.\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 payment 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 payment information to the shopping cart\n\nTo add payment information to the shopping cart, you need to use the [Add payment data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pub/orderForm/-orderFormId-/attachments/paymentData) 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/paymentData`\n\nAdditionally, you must send the request body containing the following payment information:\n\n* `paymentSystem`: Payment system ID.\n* `paymentSystemName`: Payment system name.\n* `group`: Payment system group.\n* `installments`: Number of installments.\n* `installmentsInterestRate`: Installment interest rate.\n* `installmentsValue`: Amount of each installment.\n* `value`: Total payment amount.\n* `referenceValue`: Base value used to calculate total order amount with interest.\n* `hasDefaultBillingAddress`: Indicates whether the billing address for this order is the default address.\n\nSee a request body example below:\n\n`1\n\n{ \n\n2\n\n \"payments\": [ \n\n3\n\n { \n\n4\n\n \"paymentSysytem\": 1, \n\n5\n\n \"paymentSystemName\": \"Boleto Bancário\", \n\n6\n\n \"group\": \"bankInvoicePaymentGroup\", \n\n7\n\n \"installments\": 3, \n\n8\n\n \"installmentsInterestRate\": 0, \n\n9\n\n \"installmentsValue\": 100, \n\n10\n\n \"value\": 300, \n\n11\n\n \"referenceValue\": 300, \n\n12\n\n \"hasDefaultBillingAddress\": false \n\n13\n\n } \n\n14\n\n ] \n\n15\n\n} \n\n`\n\nIf you are using a gift card as a payment method, the request body can be similar to this:\n\n`1\n\n{ \n\n2\n\n \"giftCards\": [ \n\n3\n\n { \n\n4\n\n \"redemptionCode\": \"480030010012333619\", \n\n5\n\n \"provider\": \"CartaoPresente\", \n\n6\n\n \"value\": 15289, \n\n7\n\n \"balance\": 100000, \n\n8\n\n \"name\": null, \n\n9\n\n \"caption\": null, \n\n10\n\n \"id\": \"480030010012333619\", \n\n11\n\n \"inUse\": true, \n\n12\n\n \"isSpecialCard\": false, \n\n13\n\n \"groupName\": null \n\n14\n\n } \n\n15\n\n ] \n\n16\n\n} \n\n`\n\nAfter sending the request, the endpoint will return the response body containing the payment information in the shopping cart, as in the example below:\n\n`1\n\n... \n\n2\n\n\"paymentData\": { \n\n3\n\n \"updateStatus\": \"updated\", \n\n4\n\n \"installmentOptions\": [ \n\n5\n\n { \n\n6\n\n \"paymentSystem\": \"1\", \n\n7\n\n \"bin\": null, \n\n8\n\n \"paymentName\": \"Boleto Bancário\", \n\n9\n\n \"paymentGroupName\": \"bankInvoicePaymentGroup\", \n\n10\n\n \"value\": 300, \n\n11\n\n \"installments\": [ \n\n12\n\n { \n\n13\n\n \"count\": 3, \n\n14\n\n \"hasInterestRate\": false, \n\n15\n\n \"interestRate\": 0, \n\n16\n\n \"value\": 300, \n\n17\n\n \"total\": 300, \n\n18\n\n \"sellerMerchantInstallments\": [ \n\n19\n\n { \n\n20\n\n \"id\": \"COSMETICS2\", \n\n21\n\n \"count\": 3, \n\n22\n\n \"hasInterestRate\": false, \n\n23\n\n \"interestRate\": 0, \n\n24\n\n \"value\": 300, \n\n25\n\n \"total\": 300 \n\n26\n\n } \n\n27\n\n ] \n\n28\n\n } \n\n29\n\n ] \n\n30\n\n } \n\n31\n\n... \n\n`\n\n> ️ For more information on 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* **Message error example (code ORD020)**: `\"Invalid payment\"`. The `referenceValue` information has not been sent. \\[block:code\\]\n\n`1\n\n{ \n\n2\n\n \"fields\": {}, \n\n3\n\n \"error\": { \n\n4\n\n \"code\": \"ORD020\", \n\n5\n\n \"message\": \"Invalid payment\", \n\n6\n\n \"exception\": null \n\n7\n\n }, \n\n8\n\n \"operationId\": \"9d14e7af-a63d-4c26-8974-bad734b758da\" \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\n3\n\n[](https://github.com/ricardoaerobr)\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/adding-payment-information-to-the-cart.md)\n\n[Add cart items« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart//docs/guides/add-cart-items)[Adding merchant context information to the cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart//docs/guides/add-merchant-context-information-to-the-cart)\n\nContributors\n\n3\n\n[](https://github.com/ricardoaerobr)\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/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding payment information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23adding-payment-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-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/adding-payment-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/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23getting-shopping-cart-information)\n\n[Adding payment information to the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23adding-payment-information-to-the-shopping-cart)\n\n[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23error-codes)\n\n[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-information-to-the-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/adding-payment-information-to-the-cart/docs/guides/adding-payment-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_49715e25
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides consult store search terms 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/consult-store-search-terms-information/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-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/consult-store-search-terms-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/consult-store-search-terms-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/consult-store-search-terms-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/consult-store-search-terms-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/consult-store-search-terms-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-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[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-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/consult-store-search-terms-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/consult-store-search-terms-information/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-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[How search parameters work](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/how-search-parameters-work)\n\n[Search Control – fulltextSearchBox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/search-control-fulltextsearchbox)\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information)\n\n[Consult product search information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-product-search-information)\n\n[Get banner list for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/get-banner-list-for-a-specific-search)\n\n[Get a list of the possible facets for a specific search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/get-a-list-of-the-possible-facets-for-a-specific-search)\n\n[Segmenting the search result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/vtex-io-documentation-segmenting-the-search-result)\n\n[Access Control List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/access-control-list)\n\n[Delivery promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/delivery-promise-for-headless-stores)\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-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/consult-store-search-terms-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/consult-store-search-terms-information/docs/guides)\n\nSearch\n\n[Consult store search terms information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information)\n\nImproving product discovery with autocomplete suggestions and search insights\n\nTo deliver relevant search results to your store's shoppers, it's essential to understand how they search for products in your store. The [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23overview) offers powerful insights into [popular search terms](#get-the-most-searched-terms) and [autocomplete suggestions](#get-autocomplete-suggested-terms-and-similar-attributes). The sections below outline how to use these tools to optimize your store's search experience.\n\n## Retrieving the most searched terms\n\nTo get your customers' most searched terms, use the [Get list of the 10 most searched terms](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Ftop-searches) endpoint. This endpoint allows you to filter results by specifying a `locale` in the query parameters.\n\nThe response will return the most searched terms in order of popularity along with the number of searches:\n\n\n\n### Response body example\n\n`1\n\n{ \n\n2\n\n \"searches\": [ \n\n3\n\n { \n\n4\n\n \"term\": \"home\", \n\n5\n\n \"count\": 14 \n\n6\n\n }, \n\n7\n\n { \n\n8\n\n \"term\": \"shirt\", \n\n9\n\n \"count\": 10 \n\n10\n\n }, \n\n11\n\n { \n\n12\n\n \"term\": \"top\", \n\n13\n\n \"count\": 9 \n\n14\n\n }, \n\n15\n\n { \n\n16\n\n \"term\": \"tops\", \n\n17\n\n \"count\": 6 \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n \"term\": \"camera\", \n\n21\n\n \"count\": 5 \n\n22\n\n }, \n\n23\n\n { \n\n24\n\n \"term\": \"kit\", \n\n25\n\n \"count\": 5 \n\n26\n\n }, \n\n27\n\n { \n\n28\n\n \"term\": \"work shirt\", \n\n29\n\n \"count\": 2 \n\n30\n\n }, \n\n31\n\n { \n\n32\n\n \"term\": \"shirts\", \n\n33\n\n \"count\": 2 \n\n34\n\n }, \n\n35\n\n { \n\n36\n\n \"term\": \"clothing\", \n\n37\n\n \"count\": 2 \n\n38\n\n }, \n\n39\n\n { \n\n40\n\n \"term\": \"classic shoes\", \n\n41\n\n \"count\": 1 \n\n42\n\n } \n\n43\n\n ] \n\n44\n\n} \n\n`\n\n## Retrieving autocomplete suggested terms and similar attributes\n\nTo gather data on [autocomplete suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-search-autocomplete) and similar attributes, use the [Get list of suggested terms and attributes similar to the search term](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Fautocomplete-suggestions) endpoint. You can refine the response by defining the `locale` and `query` parameters.\n\nThe response will return the searched terms by popularity order and the corresponding autocomplete suggestions for each term.\n\n\n\n### Response body example\n\n`1\n\n{ \n\n2\n\n \"searches\": [ \n\n3\n\n { \n\n4\n\n \"term\": \"tv\", \n\n5\n\n \"count\": 28861, \n\n6\n\n \"attributes\": [ \n\n7\n\n { \n\n8\n\n \"key\": \"departamento\", \n\n9\n\n \"value\": \"tvs-e-video\", \n\n10\n\n \"labelKey\": \"Departamento\", \n\n11\n\n \"labelValue\": \"TVs e Vídeo\" \n\n12\n\n }, \n\n13\n\n { \n\n14\n\n \"key\": \"categoria\", \n\n15\n\n \"value\": \"tvs\", \n\n16\n\n \"labelKey\": \"Categoria\", \n\n17\n\n \"labelValue\": \"TVs\" \n\n18\n\n }, \n\n19\n\n { \n\n20\n\n \"key\": \"subcategoria\", \n\n21\n\n \"value\": \"receptor-de-controle-de-acesso\", \n\n22\n\n \"labelKey\": \"Subcategoria\", \n\n23\n\n \"labelValue\": \"Receptor de Controle de Acesso\" \n\n24\n\n } \n\n25\n\n ] \n\n26\n\n }, \n\n27\n\n { \n\n28\n\n \"term\": \"smarth tv\", \n\n29\n\n \"count\": 2308 \n\n30\n\n }, \n\n31\n\n { \n\n32\n\n \"term\": \"painel para tv\", \n\n33\n\n \"count\": 975 \n\n34\n\n }, \n\n35\n\n { \n\n36\n\n \"term\": \"rack tv\", \n\n37\n\n \"count\": 589 \n\n38\n\n } \n\n39\n\n ] \n\n40\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/Search/consult-store-search-terms-information.md)\n\n[Search Control – fulltextSearchBox« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information//docs/guides/search-control-fulltextsearchbox)[Consult product search informationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information//docs/guides/consult-product-search-information)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Retrieving the most searched terms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23retrieving-the-most-searched-terms)\n\n[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23response-body-example)\n\n[Retrieving autocomplete suggested terms and similar attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23retrieving-autocomplete-suggested-terms-and-similar-attributes)\n\n[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23response-body-example)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Search/consult-store-search-terms-information.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Retrieving the most searched terms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23retrieving-the-most-searched-terms)\n\n[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23response-body-example)\n\n[Retrieving autocomplete suggested terms and similar attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23retrieving-autocomplete-suggested-terms-and-similar-attributes)\n\n[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/consult-store-search-terms-information/docs/guides/consult-store-search-terms-information%23response-body-example)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_90a4a26e
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides service path patterns in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/docs/guides/app-development-guides)\n\n[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/docs/guides/calling-commerce-apis-on-vtex-io)\n\n[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/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/service-path-patterns/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/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/service-path-patterns/docs/app-development)\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/app-development-guides)\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns)\n\nService path patterns\n\nLearn how to define the path for your VTEX IO service route to manage caching and session data effectively.\n\nWhen developing a new [VTEX IO service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-service), you must define a proper path for your service to handle requests effectively. This guide provides insights into service path patterns, outlining the recommended approaches based on the desired behavior.\n\nPaths are specified within the `service.json` file. Check the following example:\n\nservice.json\n\n`1\n\n{ \n\n2\n\n \"memory\": 256, \n\n3\n\n \"ttl\": 10, \n\n4\n\n \"timeout\": 2, \n\n5\n\n \"minReplicas\": 2, \n\n6\n\n \"maxReplicas\": 4, \n\n7\n\n \"routes\": { \n\n8\n\n \"status\": { \n\n9\n\n \"path\": \"/_v/status/:code\", \n\n10\n\n \"public\": true \n\n11\n\n } \n\n12\n\n } \n\n13\n\n} \n\n`\n\nFor more information on developing service apps, refer to [Developing services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/developing-services-on-vtex-io).\n\n## Path patterns\n\nThere are three possible path formats, each influencing the behavior of your service.\n\nLet's delve into these patterns using an illustrative example of implementing the service `/examplepath/123`. You can change how VTEX handles requests to this service by appending `/_v/segment` or `/_v/private` to the beginning of your path. This means you have three possible paths in this example:\n\n* **Public:** `/examplepath/123`\n* **Segment dependent:** `/_v/segment/examplepath/123`\n* **Private:** `/_v/private/examplepath/123`\n\nVTEX has an edge layer that handles all requests to the platform, including those related to VTEX IO apps. Given this architecture, each of these possible paths is handled differently in terms of caching and cookie management. Refer to the [Sessions System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview) guide to learn more about how VTEX handles cookies.\n\nCheck the table below for a comprehensive overview of the behavior of different path patterns:\n\n| **Path type** | **Pattern** | **Cookies behavior** | **Caching behavior** | **Example use case** |\n| ----------------- | ----------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |\n| Public | {yourPath} | No guarantee that the app will receive the cookies from the request. | VTEX edge will cache the service's response whenever possible. | Retrieving information that does not vary according to user or segment, such as product images. |\n| Segment dependent | /\\_v/segment/{yourPath} | The app will receive the [vtex\\_segment cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23cookie-vtexsegment) | VTEX edge will cache the service's response based on the received segment. | Retrieving information that may change depending on the segment. For instance, applying promotions according to the shopper's selected currency. |\n| Private | /\\_v/private/{yourPath} | The app will receive both the [vtex\\_segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23cookie-vtexsegment) and [vtex\\_session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview%23cookie-vtexsession) cookies. | VTEX will not cache the service's response. | Retrieving information depending on the shopper's identity or session, such as the shopper's order history or registered address. |\n\n## Troubleshooting\n\n### Unavailable cookies with CloudFront CDN\n\nIf your store uses CloudFront as a CDN and you encounter difficulties in obtaining the expected cookies from the app’s service context, [open a ticket](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) with the VTEX support team to report the issue.\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/service-path-patterns.md)\n\n[Receiving Order Notifications« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns//docs/guides/how-to-receive-order-notifications-on-vtex-io)[Configuring dynamic routes in VTEX IO servicesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns//docs/guides/configuring-dynamic-routes-in-vtex-io-services)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23path-patterns)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23troubleshooting)\n\n[Unavailable cookies with CloudFront CDN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23unavailable-cookies-with-cloudfront-cdn)\n\nWas this helpful?\n\n 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/service-path-patterns.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23path-patterns)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23troubleshooting)\n\n[Unavailable cookies with CloudFront CDN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/service-path-patterns/docs/guides/service-path-patterns%23unavailable-cookies-with-cloudfront-cdn)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f591b543
|
[
{
"role": "system",
"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 ProductSpecifications 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/ProductSpecifications/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/ProductSpecifications/docs/api-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/ProductSpecifications/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/ProductSpecifications/docs/storefront-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/ProductSpecifications/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/ProductSpecifications/docs/troubleshooting)\n\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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/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/ProductSpecifications/docs/vtex-io-apps)\n\nProduct Specifications\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 Specifications block has been deprecated in favor of the [Product Specifications app](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-specifications/).** Although support for this block is still granted, we strongly recommend you to update your store theme with the Product Specification's blocks in order to keep up with the component's evolution.\n\nThe `product-specifications` block shows the technical [specifications](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/what-are-fields-or-specifications--2lB4AgibEseceMggKE2k2m) of a product.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-specifications` 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-specifications#product\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `product-specifications` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"product-specifications#product\": { \n\n2\n\n \"props\": { \n\n3\n\n \"shoudCollapseOnTabChange\": true, \n\n4\n\n \"collapsible\": \"desktopOnly\" \n\n5\n\n } \n\n6\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ------------------------- | ------------------------------------ | -------------------------------------------------------------------------------------------------------------- | ------------- |\n| collapsible | mobileOnly\\|desktopOnly|always|never | Defines when the content of the specifications should be collapsed. | always |\n| hiddenSpecifications | String\\[\\] | Name of the specifications to be hidden. | \\[\\] |\n| shouldCollapseOnTabChange | Boolean | If it should collapse if you change the tab. | false |\n| showSpecificationsTab | Boolean | Shows the component in the tabs mode if true. | false |\n| visibleSpecifications | String\\[\\] | Name of the specifications to be presented. Only provide one of hiddenSpecifications or visibleSpecifications. | \\[\\] |\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| specificationItemProperty\\[data-specification=\"{specificationName}\"\\] |\n| specificationItemSpecifications |\n| specificationsTab |\n| specificationsTable |\n| specificationsTableBody |\n| specificationsTableContainer |\n| specificationsTableHead |\n| specificationsTablePropertyHeading |\n| specificationsTableSpecificationHeading |\n| specificationsTableRow |\n| specificationsTabsContainer |\n| specificationsTitle |\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/ProductSpecifications/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/ProductSpecifications/docs/apps/vtex.store-components@3.178.5/ProductSpecifications%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.store-components@3.178.5/ProductSpecifications%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductSpecifications/docs/apps/vtex.store-components@3.178.5/ProductSpecifications%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_71c92329
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides 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/authentication/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/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/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/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/authentication/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/authentication/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/authentication/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication)\n\n[API authentication using API keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-api-keys)\n\n[Rotating VTEX API tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/rotating-vtex-api-tokens)\n\n[App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/app-authentication-using-auth-tokens)\n\n[API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-user-tokens)\n\n[Checking which user is currently authenticated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/checking-which-user-is-currently-authenticated)\n\n[Expiring a shopper's password](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/expiring-a-shoppers-password)\n\n[Refresh token flow for headless implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/refresh-token-flow-for-headless-implementations)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/authentication/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/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/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/authentication/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-usage)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication)\n\nAuthentication\n\nAuthentication is a crucial aspect of API integrations, backend, and frontend app development. It ensures authorized access by requiring valid credentials like API keys or tokens. This shields sensitive data, prevents breaches, and builds user trust. Get started with VTEX authentication for developers with the following guides:\n\n* [API authentication using application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys)\n* [API authentication using user tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens)\n* [App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens)\n\nThere are different contexts in which authentication is required in the regular functioning of a VTEX store. Below are some example use cases and the recommended authentication methods.\n\n| **Use case** | **Indicated authentication methods** |\n| ----------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| Backend VTEX IO app | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) via VTEX IO context, or, if needed, [app authentication token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens) via VTEX IO context |\n| Frontend VTEX IO app | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) via VTEX IO context |\n| Self-hosted backend request to VTEX APIs | [Application keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-api-keys) |\n| Self-hosted frontend request to VTEX APIs | [User token](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/api-authentication-using-user-tokens) |\n\n## Single sign on integrations\n\nVTEX allows stores to integrate with external identity providers to provide single sign on (SSO) experiences to shoppers and Administrative users. You can learn more about this in the article [Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/login-integration-guide) and below you can find more information on these and other SSO use cases:\n\n* [Store SSO with OAuth 2.0](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-webstore-oauth2)\n* [Admin SSO with SAML 2.0](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2)\n* [Use your VTEX account as an OAuth provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.oauth-provider-admin@2.x)\n\n## Learn more\n\n* **Authorization**: [Users](https://read.calvincode.net/reader?url=https://help.vtex.com/en/subcategory/users--63DHe3VQEEE6Uuua8gIs2M), [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) and [License Manager Resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3)\n* **Auditability**: [Audit](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/searching-for-events-on-audit--5RXf9WJ5YLFBcS8q8KcxTA)\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/Getting-Started/authentication/authentication.md)\n\n[Making your first request« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication//docs/guides/making-your-first-request)[API authentication using API keysNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication//docs/guides/api-authentication-using-api-keys)\n\nSee also\n\n[API authentication using API keysGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-api-keys)[API authentication using user tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/api-authentication-using-user-tokens)[App authentication using auth tokensGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/app-authentication-using-auth-tokens)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Single sign on integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication%23single-sign-on-integrations)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication%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/Getting-Started/authentication/authentication.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Single sign on integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication%23single-sign-on-integrations)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/authentication/docs/guides/authentication%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_648ffe23
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration product updates in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-guide)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates)\n\nHow to get product updates\n\nThis section of the integration guide goes over the process of updating SKUs that are already integrated in the marketplace. The information flows according to the diagram below:\n\n\n\nTo begin the integration of this process, it is necessary to have a search Endpoint configured, in order to receive notifications.\n\n## How to configure the affiliate endpoint\n\nTo use this flow, the connector should provide an endpoint according to the standard:\n\n`https://{endpointDoAfiliado}/api/notification/`\n\nThis endpoint should be configured in the VTEX affiliate registration page. Check out our [Configuring an Affiliate](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials%5F187) article.\n\n## VTEX Notification\n\nWhen creating a new product or SKU in VTEX a notification will be sent through the url configured in the section above. The table below presents the fields sent in this notification’s payload. The connector should use this data to implement the new product registration flow, described in the scenarios that will follow.\n\nFields sent in the notification:\n\n| Name | Description |\n| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| idSKU | SKU ID in VTEX |\n| productId | Product ID in VTEX |\n| an | Seller’s account name in VTEX, shown in the store’s VTEX Admin url. |\n| idAffiliate | Affiliate ID generated automatically in the configuration. |\n| DateModified | Date when the item was updated |\n| isActive | Identifies whether the product is active or not. In case it is “false”, it means the product was deactivated in VTEX and should be blocked in the marketplace. We recommend that the inventory level is zeroed in the marketplace, and the product is blocked. In case the marketplace doesn’t allow it to be deactivated, the product should be excluded, along with any existing correspondences in the connector. |\n| StockModified | Identifies that the inventory level has been altered. Connectors should send an [Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/-fulfillmentEndpoint-/pvt/orderForms/simulation) request to collect updated information. |\n| PriceModified | Identifies that the price has been altered. Connectors should send an [Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/-fulfillmentEndpoint-/pvt/orderForms/simulation) request to collect updated information. |\n| HasStockKeepingUnitModified | Identifies that the product/SKU registration data has changed, like name, description, weight, etc |\n| HasStockKeepingUnitRemovedFromAffiliate | Identifies that the product is no longer associated with the trade policy. In case the marketplace doesn’t allow it to be deactivated, the product should be excluded, along with any existing correspondences in the connector. |\n\n\n\n## Integration flow\n\n1. Connector validates the VTEX <> Marketplace authentication. In case it has expired, perform the update routine defined in the marketplace’s documentation. Otherwise, connectors should log the error AND put the VTEX notification in a contingency queue.\n2. After receiving the VTEX notification, connectors should: a. Check which store the product belongs to, through the “an” parameter. b. If the HasStockKeepingUnitModified is defined as true, the product should be registered or updated in the marketplace. c. Collect details from every SKU using the [Get details of an SKU associated with a sales channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-) endpoint. d. Validate if the product is active through 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, through the `isActive` property. e. Validate if the product is associated with the trade policy used in the marketplace integration through the `salesChannel` property. f. Identify whether the SKU conforms to the marketplace’s product registration rules. g. Validate if the product’s category is mapped in the marketplace. \nIn case it is not mapped, the marketplace should put the SKU in the approvement’s queue, until the [mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper%23post-/api/mkp-category-mapper/categories/marketplace/-id-) is complete. h. Use [Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/-fulfillmentEndpoint-/pvt/orderForms/simulation) (without postalCode) to check if price and inventory are configured in the selected trade policy.\n\nIf all validations pass, the product or SKU is sent to the marketplace and the operation is logged according to information described in the [Logs made available for users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs) section.\n\nIf the IDs between VTEX and the marketplace differ, the connector should store both values. This information will be used for SKU update operations.\n\n### Recommendations\n\nTo avoid processing gaps due to the big volume of information of the initial load of products, we recommend:\n\n* Using an async messaging architecture, using individual queues by context and store.\n* Creating mechanisms that respect the marketplace API limit rates. We suggest the standard use of the _Circuit Breaker_ integration.\n* In case any of the steps listed above presents failures in communication, we suggest using the contingency mechanism of _deadLetters_.\n* Being TotalReader: whenever possible, in the data transformation process, using standard values accepted by the marketplace, in case the information is not filled or sent by VTEX.\n* In case the marketplace’s processing is in lots - meaning that the connector assembles a group of SKUs, guaranteeing the the limit of records per lot is respected, according to marketplace riles, and sending them to the marketplace at once - it is fundamental to control the lot’s processing, to avoid sending SKU updates without making sure that the product exists in the marketplace.\n* Keeping a states table to know which SKUs have not been integrated with success, attempt date and the response received. This allows the system to use the contingency flow effectively, avoiding infinite loops, and avoiding reaching the request limit.\n\n> Make sure to check out our Recommendations for performing the steps above successfully.\\\\nBe mindful to make all validations at once, and before the SKU’s publication in the marketplace’s catalog. In case there’s an error detected, the connector presents the seller a list of actions to correct. This way we can avoid the correct - publish - correct cycle. \\\\n\\\\nIf products do not apply to steps a, b and c, an error log must be filed, and the connector should collect the next items on the list obtained by step 2.\n\n## API Reference\n\nUse the endpoints described below to get SKU, price and inventory details. It is important to note that when consuming this API, the connector must have a valid VTEX App Key and App Token. You can also [download our Postman collection](https://read.calvincode.net/reader?url=https://www.getpostman.com/collections/95a809929905a50e2b7b) to access the API. The diagram illustrates the endpoints used in the integration:\n\n\n\n> All parameters in the endpoints below must be declared in the request. In case one of the parameters does not have a value, you must still send it as `null`.\",\n\n[Get list of SKUs associated with a sales channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitidsbysaleschannel)\n\n[Get details of an SKU associated with a sales channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-)\n\n[Check if product is active](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/product/-productId-)\n\n[Simulate price and inventory levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/-fulfillmentEndpoint-/pvt/orderForms/simulation)\n\n## Scenario 1: Update information of an SKU already published\n\nAfter receiving the VTEX Catalog notification of product or SKU updates, connectors should update the published item’s information on the marketplace:\n\n1. Validate if the `isActive` property is `true`. If otherwise, skip to Scenario 3.\n2. Check if the VTEX `idSKU` and `idSkuMarketplace` are mapped, and if the SKU is already published on the marketplace.\n3. Evaluate if the notification message has the `HasStockKeepingUnitModified` property set as `true`. If otherwise, validate the other JSON properties and execute the following scenarios, if needed.\n4. Use [Get product details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/productget/-productId-) API.\n5. Use [Get details of an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitbyid/-skuId-)API.\n6. Use [Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol%23post-/-fulfillmentEndpoint-/pvt/orderForms/simulation) (without postalCode) to check if price and inventory are configured in the selected trade policy.\n7. Perform category mapping routines through VTEX Mapper. In case the mapping does not exist, log an error, and direct the message to the contingency queue, while logging and alerting the user about the error.\n8. Make the necessary data transformations and [Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23log-messages) errors if needed.\n9. Send data to the marketplace.\n10. Register operation’s logs. Check out [Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23content-of-the-messages) for this step.\n\nIn case steps 4, 5 or 6 present errors, connectors should create contingency mechanisms to repeat them.\n\n## Scenario 2: Deactivate SKU from VTEX\n\n1. Validate if the `isActive` property is “false”.\n2. [Get SKU information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-).\n3. Check if the VTEX `idSKU` and `idSkuMarketplace` are mapped, and if the SKU is already published on the marketplace. Otherwise, [Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23log-messages) errors and skip to Scenario 1.\n4. Send an SKU block or deactivation request to the marketplace. If the marketplace does not allow this operation, skip to Scenario 4.\n5. Register operation’s logs. Check out [Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23content-of-the-messages) for this step.\n\nIn case step 2 presents errors, connectors should create contingency mechanisms to repeat them.\n\n## Scenario 3: Activate SKU from VTEX\n\n1. Validate if the `isActive` property is “true”.\n2. [Get SKU information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-).\n3. Check if the VTEX `idSKU` and `idSkuMarketplace` are mapped, and if the SKU is already published on the marketplace. Otherwise, [Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23log-messages) errors and skip to Scenario 1.\n4. Send SKU activation to the marketplace. The endpoint used for this step varies according to the marketplace, but it should be the marketplace’s activate/deactivate published SKU.\n5. Register operation’s logs. Check out [Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23content-of-the-messages) for this step.\n\nIn case step 2 presents errors, connectors should create contingency mechanisms to repeat them. We recommend using a queue to control exceptions.\n\n## Scenario 4: Delete SKU from VTEX\n\nNote that this scenario should only be executed if the marketplace does not offer the product block or deactivation options.\n\n1. Validate if the `isActive` property is “false”.\n2. [Get SKU information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-).\n3. Check if the VTEX `idSKU` and `idSkuMarketplace` are mapped, and if the SKU is already published on the marketplace. Otherwise, [Log](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23log-messages) errors and skip to Scenario 1.\n4. Send “Delete SKU request” to the marketplace. The endpoint used for this step varies according to the marketplace.\n5. Once the Delete SKU operation is confirmed, clean the SKU mapping. This step is performed within the connector’s mapping database.\n6. Register operation’s logs. Check out [Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23content-of-the-messages) for this step.\n\nIn case step 2 presents errors, connectors should create contingency mechanisms to repeat them.We recommend using a queue to control exceptions.\n\n> Make sure that all steps are logged as either success or failure, to offer the operation’s full traceability. Check out the [Logs made available for users](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs) page to learn more.\"\n\n## What VTEX needs to validate the integration flow\n\nTo consider the integration validated by VTEX, the connector should:\n\n1. Follow the step by step of the catalog integration flow.\n2. Check if flows comply with the scenarios described.\n3. Validate log messages contained in the table of Log’s [Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-logs%23content-of-the-messages).\n4. Perform the performance test to validate response time, and SKU processing time from a set of 5000 SKUs.\n5. Create tutorials for the final user (including text, videos and diagrams), including a step by step guide explaining how the connector created works. The documentation should be published in the production environment with easy access and navigation.\n6. Create a table that explicits which data is mandatory and which is recommended when registering products or SKUs, and to improve the offer’s positioning in the marketplace’s storefront.\n7. Create a table with known error logs and actions that the user can do to solve the problem.\n\n> Tables should follow the format below. They will be implemented in the integration according to the connector’s documentation.\n\n### Template table for field mapping\n\n| VTEX field | How to fill it in VTEX | VTEX API | Marketplace field |\n| ---------- | ---------------------- | --------------------------------- | ----------------- |\n| Name | Catalog page | /api/catalog/pvt/stockkeepingunit | ShortName |\n| Image | Catalog page (SKU) | Images | |\n\nContributors\n\n3\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-product-updates.md)\n\n[How to get a new product to offer in the marketplace« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates//docs/guides/external-marketplace-integration-new-products)[Product and Category MappingsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates//docs/guides/external-marketplace-integration-catalog-mapping)\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[How to configure the affiliate endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23how-to-configure-the-affiliate-endpoint)\n\n[VTEX Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23vtex-notification)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23integration-flow)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23recommendations)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23api-reference)\n\n[Scenario 1: Update information of an SKU already published](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23scenario-1-update-information-of-an-sku-already-published)\n\n[Scenario 2: Deactivate SKU from VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23scenario-2-deactivate-sku-from-vtex)\n\n[Scenario 3: Activate SKU from VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23scenario-3-activate-sku-from-vtex)\n\n[Scenario 4: Delete SKU from VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23scenario-4-delete-sku-from-vtex)\n\n[What VTEX needs to validate the integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23what-vtex-needs-to-validate-the-integration-flow)\n\n[Template table for field mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23template-table-for-field-mapping)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-product-updates.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[How to configure the affiliate endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23how-to-configure-the-affiliate-endpoint)\n\n[VTEX Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23vtex-notification)\n\n[Integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23integration-flow)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23recommendations)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23api-reference)\n\n[Scenario 1: Update information of an SKU already published](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23scenario-1-update-information-of-an-sku-already-published)\n\n[Scenario 2: Deactivate SKU from VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23scenario-2-deactivate-sku-from-vtex)\n\n[Scenario 3: Activate SKU from VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23scenario-3-activate-sku-from-vtex)\n\n[Scenario 4: Delete SKU from VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23scenario-4-delete-sku-from-vtex)\n\n[What VTEX needs to validate the integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23what-vtex-needs-to-validate-the-integration-flow)\n\n[Template table for field mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-product-updates/docs/guides/external-marketplace-integration-product-updates%23template-table-for-field-mapping)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_315eaa38
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore api extensions use cases adding installment information in the product details page in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Adding a contact form to the landing page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-a-contact-form-to-a-landing-page)\n\n[Adding available installment information in PDP](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Adding a contact form to the landing page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-a-contact-form-to-a-landing-page)\n\n[Adding available installment information in PDP](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-overview)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-overview)\n\nAdding Installment Information in the Product Details Page\n\nThis guide outlines how you can display available product installment options on your Product Details Page (PDP).\n\n> For detailed instructions on API extensions, see the [API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview) guide.\n\n## Context\n\nYou want to display installment details (number, amount, payment system) on the PDP. This feature allows customers to view installment details directly on the product page, supporting their decision-making.\n\n## Implementation\n\n### Creating GraphQL files\n\nFirst, you must configure the necessary GraphQL files to retrieve and structure the installment data.\n\n1. In your store repository, go to the `src` folder. If you don’t have it, create a `graphql` folder.\n2. Inside `graphql`, create the `vtex` folder.\n3. In the `vtex` folder, create two other subfolders, `resolvers` and `typeDefs`.\n\n> For further information on code implementation, see the [vtex](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/tree/main/src/graphql/vtex) folder available in the playground.store repository.\n\n### Defining the types\n\nNow that the file structure is in place, let's define the data structure for our installment information using GraphQL.\n\nIn the `typeDefs` folder, create a `product.graphql` file to define the schema. Add the following schema definitions:\n\n* `Installments`: Specifies the structure of each installment option. Each installment has properties for:\n* `installmentPaymentSystemName`: Name of the payment system used (e.g., Credit Card).\n* `installmentValue`: Amount of each installment.\n* `installmentInterest`: Interest rate applied per installment.\n* `installmentNumber`: Total number of installments offered.\n* `StoreProduct`: Type that is being extended to include a new field called `availableInstallments`. This field is a list of installment objects, representing all the available installment options for the product.\n\n### Creating resolvers\n\nNow that we've defined the structure of our installment information (GraphQL types), let's create the rationale for retrieving and formatting this information using a resolver function. Resolvers essentially act as gateways between your frontend and backend, processing data requests.\n\nIn the `resolvers` folder, create a `product.ts` file to handle the installment information rationale. Add the following code.\n\n* `productResolver`: Defines a resolver for the `StoreProduct` type.\n* `availableInstallments`: Retrieves the installment information from the `commertialOffer` property of the first seller (`sellers[0]`).\n* `installments.length`: Checks if there are any installments (`installments.length`). If not, an empty array is returned.\n* The code iterates through each installment and maps it to a new object with the desired properties (`installmentPaymentSystemName`, `installmentValue`, etc.).\n\n#### Consolidating resolvers\n\nIn the `resolvers` folder, create an `index.ts` file to consolidate the resolvers.\n\n* The `index.ts` file exports resolvers by default, acting as a central hub for all your resolver functions.\n* `resolvers`:Combines the imported resolver with any other resolvers you might have in your project (represented by the ellipsis `...`).\n\n### Using fragments\n\nNow that we've defined the `availableInstallments` field using GraphQL types and resolvers, we need to specify where this data will be used in your storefront queries. This is achieved through GraphQL fragments.\n\n1. In the `src` folder of your store code, create a `fragments` folder.\n2. In the `fragments` folder, create the following files: \n * `ClientProduct.ts`: Defines the client-side fragment. \n * `ServerProduct.ts`: Defines the server-side fragment.\n3. In the `ClientProduct.ts` file, defines the GraphQL fragment for retrieving installment data.\n* `gql`: Imported from @faststore/core/api to construct the GraphQL fragment.\n* `ClientProduct`: Fragment to indicate it extends the product query.\n* The fragment defines the specific fields we want to retrieve from the `availableInstallments` data structure.\n\n#### Adding server-side product fragment for installment details\n\nAdd a product fragment focusing on installment details to ensure consistency in data retrieval on the client and server sides. In the `ServerProduct.ts` file, add the following:\n\n> For further details on code implementation, see the [fragments](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/tree/main/src/fragments) folder available in the playground.store repository.\n\n### Formatting installment values\n\nFor a more user-friendly display, you can format the installment values to include currency symbols and proper locale formatting.\n\n1. In the `src` folder of your store code, create a `utils` folder.\n2. Inside `utils`, create the `priceFormatter.ts` file and add the following:\n* `FaststoreConfig`: Imported to access the current store's locale and currency settings.\n* `priceFormatter`: This function takes a numeric value and formats it according to the store's locale and currency.\n\n> For further details on code implementation, see the [utils](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/tree/main/src/utils) folder available in the playground.store repository.\n\n### Creating a new component with installments\n\nNow that we've established the rationale for retrieving installment data, let's create a new component to display this information alongside the buy button on the PDP.\n\n1. In the `src/components` folder, create two new folders: \n * `BuyButtonWithDetails`: Keeps the component for our enhanced buy button with installment details. \n * `sections/CustomProductDetails`: Keeps the rationale for overriding the default PDP buy button component.\n2. Inside the `BuyButtonWithDetails` folder, create two new files: \n * `BuyButtonWithDetails.tsx` \n * `buy-button-with-details.module.scss`\n3. Inside `BuyButtonWithDetails.tsx`, add the following code.\n* `priceFormatter`: Format installment values.\n* `styles`: Stylesheet for the BuyButtonWithDeatils imported from the `.scss` file.\n* [usePDP](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-consuming-api-extensions): Hook to retrieve the PDP context containing product and extension data.\n* We conditionally display the first installment option if it's interest-free (you can modify this to show all installments).\n* The component renders a section containing the installment information and the buy button.\n\n### Creating a stylesheet for the component\n\nInside `buy-button-with-details.module.scss`, add the code below. The stylesheet styles the component using SCSS. It defines styles for the installment information container and the buy button itself.\n\n### Creating a custom section\n\nBy including the `CustomProductDetails` section in the PDP, you replace the default buy button component with your enhanced `BuyButtonWithDetails` component, which displays both the buy button and the installment information.\n\nIn the `CustomProductDetails` folder , create the `CustomProductDetails.tsx` and add the following code.\n\n> For further details on code implementation, see the [utils](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/tree/main/src/utils) folder available in the playground.store repository.\n\n`1\n\nsrc \n\n2\n\n┗ 📂 graphql \n\n3\n\n ┗ 📂vtex \n\n4\n\n ┣ 📂 resolvers \n\n5\n\n ┗ 📂 typeDefs \n\n`\n\n## Results\n\nOnce you have [set your development mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/building-sections/overrides/sending-components-to-the-headless-cms%23previewing-changes-in-the-development-mode), you can view changes locally by accessing a PDP, such as `https://localhost:3000/adidas-mens-performance-polo-green-night-99984111/p`, and you will see the installment option for the product.\n\n### Before\n\nThe PDP before adding the installment:\n\n\n\n### After\n\nAfter applying the installment option, the information will become available above the `Buy Button`:\n\n\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/api-extensions/api-extensions-use-cases/adding-installment-information-in-the-product-details-page.mdx)\n\n[Adding a contact form to the landing page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-a-contact-form-to-a-landing-page)[Managing URLs with redirects and rewrite pathsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23context)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23implementation)\n\n[Creating GraphQL files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-graphql-files)[Defining the types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23defining-the-types)[Creating resolvers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-resolvers)[Using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23using-fragments)[Formatting installment values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23formatting-installment-values)[Creating a new component with installments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-a-new-component-with-installments)[Creating a stylesheet for the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-a-stylesheet-for-the-component)[Creating a custom section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-a-custom-section)\n\n[Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23results)\n\n[Before](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23before)[After](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23after)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/api-extensions/api-extensions-use-cases/adding-installment-information-in-the-product-details-page.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23context)\n\n[Implementation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23implementation)\n\n[Creating GraphQL files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-graphql-files)[Defining the types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23defining-the-types)[Creating resolvers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-resolvers)[Using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23using-fragments)[Formatting installment values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23formatting-installment-values)[Creating a new component with installments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-a-new-component-with-installments)[Creating a stylesheet for the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-a-stylesheet-for-the-component)[Creating a custom section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23creating-a-custom-section)\n\n[Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23results)\n\n[Before](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23before)[After](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page/docs/guides/faststore/api-extensions-use-cases-adding-installment-information-in-the-product-details-page%23after)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_c99db21f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides catalog 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/catalog-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/catalog-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/catalog-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/catalog-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/catalog-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/catalog-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/catalog-api-overview/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/updates/release-notes)\n\nCatalog API - Overview\n\nThe Catalog API provides methods for managing and retrieving products, SKUs, categories, brands, and other catalog information.\n\n> Check out the new [Catalog onboarding guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-overview). We created this guide to improve the onboarding experience for developers at VTEX. It combines all our Developer Portal documentation about Catalog and focuses on the developer's journey.\n\n## Common parameters\n\n| Parameter name | Description |\n| ----------------------- | --------------------------------------------------------------------------------------- |\n| {{accountName}} | Store account name |\n| {{environment}} | The environment that will be called. Change to vtexcommercestable or vtexcommmercebeta. |\n| {{X-VTEX-API-AppKey}} | Located in the request headers, user authentication key. |\n| {{X-VTEX-API-AppToken}} | Located in the request headers, authentication password. |\n\nAll content between `{{}}` keys must be replaced with the correct data before performing the request.\n\n## Index\n\n### Category\n\nRetrieve, create, or update a Category. A category is a hierarchical level of product classification. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2gkZDjXRqfsq62TlAkj4uf).\n\n* `GET` [Get Category Tree](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/category/tree/-categoryLevels-)\n* `GET` [Get Category by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/category/-categoryId-)\n* `PUT` [Update Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/category/-categoryId-)\n* `POST` [Create Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/category)\n\n### Category Specification\n\nRetrieve all Specifications by Category. For more information about Specification, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP).\n\n* `GET` [Get Specifications By Category ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/specification/field/listByCategoryId/-categoryId-)\n* `GET` [Get Specifications Tree By Category ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/specification/field/listTreeByCategoryId/-categoryId-)\n\n### Brand\n\nRetrieve, create, update, or delete a Brand. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/7i3sB8fgkqUp5NoH5yJtfh).\n\n* `GET` [Get Brand List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/brand/list)\n* `GET` [Get Brand List Per Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/brand/pagedlist)\n* `GET` [Get Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/brand/-brandId-)\n* `POST` [Create Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/brand)\n* `GET` [Get Brand and context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/brand/-brandId-)\n* `PUT` [Update Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/brand/-brandId-)\n* `DELETE` [Delete Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/brand/-brandId-)\n\n### Specification Group\n\nRetrieve, create, or update a Specification Group.\n\n* `GET` [List Specification Group by Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/specification/groupbycategory/-categoryId-)\n* `GET` [Get Specification Group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/specification/groupGet/-groupId-)\n* `POST` [Create Specification Group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/specificationgroup)\n* `PUT` [Update Specification Group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/specificationgroup/-groupId-)\n\n### Specification\n\nRetrieve, create, or delete a Specification. A specification is used to create site browsing filters and to differentiate SKUs and Products within the product page. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP?locale=en).\n\n* `GET` [Get Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/specification/-specificationId-)\n* `PUT` [Update Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/specification/-specificationId-)\n* `POST` [Create Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/specification)\n\n#### Specification Field\n\nRetrieve, create, or update a Specification Field. A specification field allows you to present more detailed items.\n\n* `GET` [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-)\n* `POST` [Create Specification Field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/specification/field)\n* `PUT` [Update Specification Field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog%5Fsystem/pvt/specification/field)\n\n#### Non Structured Specification\n\nRetrieve or delete a Non Structured Specification.\n\n* `GET` [Get Non Structured Specification by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/specification/nonstructured/-Id-)\n* `DELETE` [Delete Non Structured Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/specification/nonstructured/-Id-)\n\n### Specification Value\n\nRetrieve, create, or update a Specification Value.\n\n* `GET` [Get Specification Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/specificationvalue/-specificationValueId-)\n* `PUT` [Update Specification Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/specificationvalue/-specificationValueId-)\n* `POST` [Create Specification Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/specificationvalue)\n\n#### Specification Field Value\n\nRetrieve, create, or update a Specification Field Value.\n\n* `GET` [Get Specification Field Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/specification/fieldValue/-fieldValueId-)\n* `GET` [Get Specification 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-)\n* `POST` [Create Specification Field Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/specification/fieldValue)\n* `PUT` [Update Specification Field Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog%5Fsystem/pvt/specification/fieldValue)\n\n### Product\n\nRetrieve, create, or update a product. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/1wmX3QvQVxbKVmalhIE5Ru).\n\n* `GET` [Get Product and SKU IDs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/GetProductAndSkuIds)\n* `GET` [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-)\n* `PUT` [Update Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/product/-productId-)\n* `GET` [Get Product and its general context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/productget/-productId-)\n* `GET` [Get Product by RefId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/productgetbyrefid/-refId-)\n* `GET` [Get Product's SKUs by Product ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/products/variations/-productId-)\n* `GET` [Get Product Review Rate by Product ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/addon/pvt/review/GetProductRate/-productId-)\n* `POST` [Create Product with Category and Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/product)\n\n### Product Specification\n\nRetrieve, create, or update additional information of a product. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP%23product-specification).\n\n* `GET` [Get Product Specification by Product ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/-productId-/specification)\n* `POST` [Update Product Specification by Product ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/products/-productId-/specification)\n* `GET` [Get Product Specification and its information by Product ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/product/-productId-/specification)\n* `POST` [Associate Product Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/product/-productId-/specification)\n* `DELETE` [Delete all Product Specifications by Product ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/product/-productId-/specification)\n* `DELETE` [Delete a specific Product Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/product/-productId-/specification/-specificationId-)\n* `PUT` [Associate product specification using specification name and group name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/product/-productId-/specificationvalue)\n\n### SKU\n\nRetrieve, create, or update an SKU. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3mJbIqMlz6oKDmyZ2bKJoA).\n\n* `GET` [List all SKU IDs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitids)\n* `GET` [Get SKU and context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitbyid/-skuId-)\n* `GET` [Get SKU by RefId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit)\n* `POST` [Create SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit)\n* `GET` [Get SKU ID by Reference ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitidbyrefid/-refId-)\n* `GET` [Get SKU by Alternate ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitbyalternateId/-alternateId-)\n* `GET` [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-)\n* `POST` [Retrieve SKU ID list by Reference ID list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pub/sku/stockkeepingunitidsbyrefids)\n* `GET` [Get SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-)\n* `PUT` [Update SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-)\n\n### SKU Specification\n\nRetrieve, create, or delete an SKU Specification. SKU Specification is used to create site browsing filters and to differentiate SKUs within the product page. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/2NQoBv8m4Yz3oQaLgDRagP?locale=en%23sku-specifications).\n\n* `GET` [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)\n* `POST` [Associate SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/specification)\n* `PUT` [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)\n* `DELETE` [Delete all SKU Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/specification)\n* `DELETE` [Delete SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/specification/-specificationId-)\n* `PUT` [Associate SKU specification using specification name and group name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-/specificationvalue)\n\n### SKU File\n\nRetrieve, create, or update an SKU file. An SKU file is an image linked to a SKU.\n\n* `GET` [Get SKU Files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/file)\n* `POST` [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)\n* `DELETE` [Delete All SKU Files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/file)\n* `PUT` [Update SKU File](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/-skuId-/file/-skuFileId-)\n* `DELETE` [Delete SKU Image File](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/file/-skuFileId-)\n* `PUT` [Copy Files from an SKU to another SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/stockkeepingunit/copy/-skuIdfrom-/-skuIdto-/file/)\n* `DELETE` [Disassociate SKU File](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/disassociate/-skuId-/file/-skuFileId-)\n\n### SKU Complement\n\nRetrieve, create, or update an SKU Complement. An SKU Complement is an SKU that has a Parent SKU.\n\n* `GET` [Get SKU Complement by SKU ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/complement)\n* `GET` [Get SKU Complements by Complement Type ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/complement/-complementTypeId-)\n* `GET` [Get SKU complements by type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/complements/-parentSkuId-/-type-)\n* `POST` [Create SKU Complement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skucomplement)\n* `GET` [Get SKU Complement by SKU Complement ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/skucomplement/-skuComplementId-)\n* `DELETE` [Delete SKU Complement by SKU Complement ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/skucomplement/-skuComplementId-)\n\n### SKU EAN\n\nRetrieve, create, or update an SKU unique identification code (barcode).\n\n* `GET` [Get SKU by EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitbyean/-ean-)\n* `GET` [Get EAN by SKU ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/ean)\n* `DELETE` [Delete all SKU EAN values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/ean)\n* `POST` [Create SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/ean/-ean-)\n* `DELETE` [Delete SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/ean/-ean-)\n\n### Attachment\n\nRetrieve, create, or update an Attachment. An attachment is used to add custom information about an item. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm).\n\n* `GET` [Get attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/attachment/-attachmentid-)\n* `PUT` [Update attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/attachment/-attachmentid-)\n* `DELETE` [Delete attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/attachment/-attachmentid-)\n* `POST` [Create attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/attachment)\n* `GET` [Get all attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/attachments)\n\n### SKU Attachment\n\nRetrieve, create, or update an SKU Attachment. An attachment is used to add custom information about the item. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm).\n\n* `POST` [Associate SKU Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuattachment)\n* `DELETE` [Dissociate attachments and SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/skuattachment)\n* `GET` [Get SKU Attachments by SKU ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunit/-skuId-/attachment)\n* `DELETE` [Delete SKU Attachment by Attachment Association ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/skuattachment/-skuAttachmentAssociationId-)\n* `POST` [Associate attachments to an SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/sku/associateattachments)\n\n### SKU Service\n\nCreate, update, or delete an SKU Service. A service is an item that may come with a product, optionally, and with a cost. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-service--46Ha8CEEQoC6Y40i6akG0y).\n\n* `GET` [Get SKU Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/skuservice/-skuServiceId-)\n* `PUT` [Update SKU Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/skuservice/-skuServiceId-)\n* `DELETE` [Dissociate SKU Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/skuservice/-skuServiceId-)\n* `POST` [Associate SKU Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservice)\n\n#### SKU Service Attachment\n\nAssociate or disassociate an Attachment to an SKU Service.\n\n* `POST` [Associate SKU Service Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservicetypeattachment)\n* `DELETE` [Dissociate Attachment by Attachment ID or SKU Service Type ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/skuservicetypeattachment)\n* `DELETE` [Dissociate Attachment from SKU Service Type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/skuservicetypeattachment/-skuServiceTypeAttachmentId-)\n\n#### SKU Service Type\n\nCreate, update, or delete an SKU Service Type. A service type is the behavior configuration of a service.\n\n* `POST` [Create SKU Service Type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservicetype)\n* `GET` [Get SKU Service Type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/skuservicetype/-skuServiceTypeId-)\n* `PUT` [Update SKU Service Type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/skuservicetype/-skuServiceTypeId-)\n* `DELETE` [Delete SKU Service Type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/skuservicetype/-skuServiceTypeId-)\n\n#### SKU Service Value\n\nCreate, update, or delete an SKU Service Value. Service value is how much the customer will be charged for the service.\n\n* `POST` [Create SKU Service Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/skuservicevalue)\n* `GET` [Get SKU Service Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/skuservicevalue/-skuServiceValueId-)\n* `PUT` [Update SKU Service Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/skuservicevalue/-skuServiceValueId-)\n* `DELETE` [Delete SKU Service Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/skuservicevalue/-skuServiceValueId-)\n\n### SKU Kit\n\nRetrieve, create, or update an SKU Kit. A kit is an SKU composed of one or more SKUs. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-kit--5ov5s3eHM4AqAAgqWwoc28).\n\n* `GET` [Get SKU Kit by SKU ID or Parent SKU ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunitkit)\n* `POST` [Create SKU Kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunitkit)\n* `DELETE` [Delete SKU Kit by SKU ID or Parent SKU ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunitkit)\n* `GET` [Get SKU Kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/stockkeepingunitkit/-kitId-)\n* `DELETE` [Delete SKU Kit by KitId](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunitkit/-kitId-)\n\n### SKU Seller\n\nRetrieve and delete an SKU Seller. An SKU Seller is a seller associated with an SKU. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-seller--5FkLvhZ3Few4CWWIuYOK2w).\n\n* `GET` [Get details of a seller's SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/skuseller/-sellerId-/-sellerSkuId-)\n* `POST` [Remove a seller's SKU binding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/skuseller/remove/-sellerId-/-sellerSkuId-)\n* `POST` [Change Notification with Seller ID and Seller SKU ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/skuseller/changenotification/-sellerId-/-sellerSkuId-)\n* `POST` [Change Notification with SKU ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/skuseller/changenotification/-skuId-)\n\n### Similar Category\n\nRetrieve, create or delete a similar category related to a product. By creating a similar category, the product will be shown in both categories (main and similar).\n\n* `GET` [Get Similar Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/product/-productId-/similarcategory/)\n* `POST` [Add Similar Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/product/-productId-/similarcategory/-categoryId-)\n* `DELETE` [Delete Similar Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/product/-productId-/similarcategory/-categoryId-)\n\n### Collection Beta\n\nThe Beta Collections module provides endpoints to create and manage Collections. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye).\n\n* `GET` [Get All Collections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/collection/search)\n* `GET` [Get All Inactive Collections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/collection/inactive)\n* `POST` [Create Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/collection/)\n* `GET` [Get Collections by search terms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/collection/search/-searchTerms-)\n* `GET` [Import Collection file example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/collection/stockkeepingunit/importfileexample)\n* `POST` [Add products to Collection by imported file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/collection/-collectionId-/stockkeepingunit/importinsert)\n* `POST` [Remove products from Collection by imported file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/collection/-collectionId-/stockkeepingunit/importexclude)\n* `GET` [Get products from a collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/collection/-collectionId-/products)\n\n### Legacy Collection\n\nRetrieve, create, update, or delete a collection. A collection is a group of items. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/4hN41yU8IPeb8HKmmaXoca).\n\n* `GET` [Get Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/collection/-collectionId-)\n* `PUT` [Update Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/collection/-collectionId-)\n* `DELETE` [Delete Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/collection/-collectionId-)\n* `POST` [Create Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/collection)\n\n### Legacy Subcollection\n\nRetrieve, create, or delete an SKU, Brand or Category from a Subcollection, as well as create, delete and update subcollections. A subcollection is a group type associated with a collection. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/3moFonW33dgOYDrU21Z1X0%23group-types).\n\n* `POST` [Add SKU to Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection/-subCollectionId-/stockkeepingunit)\n* `DELETE` [Delete SKU from Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/subcollection/-subCollectionId-/stockkeepingunit/-skuId-)\n* `POST` [Associate Category to Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection/-subCollectionId-/category)\n* `DELETE` [Delete Category from Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/subcollection/-subCollectionId-/brand/-categoryId-)\n* `POST` [Associate Brand to Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection/-subCollectionId-/brand)\n* `DELETE` [Delete Brand from Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/subcollection/-subCollectionId-/brand/-brandId-)\n* `GET` [Get Subcollection by Collection ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/collection/-collectionId-/subcollection)\n* `GET` [Get Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/subcollection/-subCollectionId-)\n* `PUT` [Update Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/subcollection/-subCollectionId-)\n* `DELETE` [Delete Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/subcollection/-subCollectionId-)\n* `POST` [Create Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/subcollection)\n* `POST` [Reposition SKU on the Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/collection/-collectionId-/position)\n\n### Seller\n\nRetrieve, create, or update a Seller. For more information, check [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-seller--5FkLvhZ3Few4CWWIuYOK2w).\n\n* `GET` [Get Seller List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/seller/list)\n* `GET` [Get Seller by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/seller/-sellerId-)\n* `PUT` [Update Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog%5Fsystem/pvt/seller)\n* `POST` [Create Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog%5Fsystem/pvt/seller)\n* `GET` [Get Seller by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sellers/-sellerId-)\n\n### Supplier\n\nRetrieve, create, or update a Supplier.\n\n* `POST` [Create Supplier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/supplier)\n* `PUT` [Update Supplier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23put-/api/catalog/pvt/supplier/-supplierId-)\n* `DELETE` [Delete Supplier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/supplier/-supplierId-)\n\n### Trade Policy\n\nCreate, update, or delete a [trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-sales-policy--563tbcL0TYKEKeOY4IAgAE).\n\n* `GET` [Get Trade Policies by Product ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog/pvt/product/-productId-/salespolicy)\n* `POST` [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-)\n* `DELETE` [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-)\n* `GET` [List all SKUs of a Trade Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitidsbysaleschannel)\n\n#### Sales Channel\n\nRetrieve trade policies (also known as sales channels).\n\n* `GET` [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)\n* `GET` [Get Sales Channel by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pub/saleschannel/-salesChannelId-)\n\n### Product Indexing\n\nRetrieve Product Indexed information.\n\n* `GET` [Get Product Indexed Information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/products/GetIndexedInfo/-productId-)\n\n### Commercial Conditions\n\nRetrieve commercial conditions registered in the store.\n\n* `GET` [Get all commercial conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/commercialcondition/list)\n* `GET` [Get commercial condition](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/commercialcondition/-commercialConditionId-)\n\n### Gift List\n\nRetrieve information about gift lists registered in your store.\n\n* `GET` [Get Gift List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/addon/pvt/giftlist/get/-listId-)\n\nContributors\n\n4\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/jumeyermattosarruda)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Catalog/catalog-api-overview.md)\n\nContributors\n\n4\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/jumeyermattosarruda)\n\nON THIS PAGE\n\n[Common parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23common-parameters)\n\n[Index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23index)\n\n[Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23category)[Category Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23category-specification)[Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23brand)[Specification Group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23specification-group)[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23specification)[Specification Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23specification-value)[Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23product)[Product Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23product-specification)[SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku)[SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-specification)[SKU File](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-file)[SKU Complement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-complement)[SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-ean)[Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23attachment)[SKU Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-attachment)[SKU Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-service)[SKU Kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-kit)[SKU Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-seller)[Similar Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23similar-category)[Collection Beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23collection-beta)[Legacy Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23legacy-collection)[Legacy Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23legacy-subcollection)[Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23seller)[Supplier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23supplier)[Trade Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23trade-policy)[Product Indexing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23product-indexing)[Commercial Conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23commercial-conditions)[Gift List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23gift-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/Catalog/catalog-api-overview.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Common parameters](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23common-parameters)\n\n[Index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23index)\n\n[Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23category)[Category Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23category-specification)[Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23brand)[Specification Group](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23specification-group)[Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23specification)[Specification Value](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23specification-value)[Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23product)[Product Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23product-specification)[SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku)[SKU Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-specification)[SKU File](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-file)[SKU Complement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-complement)[SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-ean)[Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23attachment)[SKU Attachment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-attachment)[SKU Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-service)[SKU Kit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-kit)[SKU Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23sku-seller)[Similar Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23similar-category)[Collection Beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23collection-beta)[Legacy Collection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23legacy-collection)[Legacy Subcollection](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23legacy-subcollection)[Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23seller)[Supplier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23supplier)[Trade Policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23trade-policy)[Product Indexing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23product-indexing)[Commercial Conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23commercial-conditions)[Gift List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-api-overview/docs/guides/catalog-api-overview%23gift-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_87ca2289
|
[
{
"role": "system",
"content": "You are a VTEX 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 button in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-button/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-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/guides/faststore/atoms-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/guides/faststore/atoms-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/guides/faststore/atoms-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/guides/faststore/atoms-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/guides/faststore/atoms-button/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-button/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-button/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/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-button/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/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-button/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/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-button/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-button/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-button/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-button/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/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-button/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-button/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/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-button/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-button/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/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-button/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/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-button/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/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-button/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-button/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-button/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-button/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/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-button/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-button/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-button/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-overview)\n\nButton\n\nButtons indicate actions that users can take.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/Button)\n\nButtons indicate actions that users can take, such as adding an item to the cart, submitting a form, and proceeding with an operation. Use the `Button` component to communicate user actions for the following components:\n\n* `Buy Now` and `Add to Cart` buttons in [Product Cards](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-product-card).\n* Submit or cancel actions on [Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-modal) dialogs.\n\nExample\n\nCode\n\nPrimary\n\nSecondary\n\nTertiary\n\nButton with an Icon\n\nSmall\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Button } 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/Button/styles.scss'; \n\n`\n\nFor details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).\n\n---\n\n## Examples\n\n### Variants\n\n#### Primary\n\nExample\n\nCode\n\nButton\n\n#### Primary Inverse\n\nExample\n\nCode\n\nButton\n\n#### Secondary\n\nExample\n\nCode\n\nButton\n\n#### Secondary Inverse\n\nExample\n\nCode\n\nButton\n\n#### Tertiary\n\nExample\n\nCode\n\nButton\n\n#### Tertiary Inverse\n\nExample\n\nCode\n\nButton\n\n---\n\n### Disabled\n\nExample\n\nCode\n\nButton\n\n### Loading\n\nExample\n\nCode\n\n##### No label\n\nBuy\n\n##### With label\n\nLoading\n\nLoading state\n\n##### Trigger\n\nClick me to trigger loading\n\n### Size\n\n#### Small\n\nExample\n\nCode\n\nButton\n\n#### Small with an icon\n\nExample\n\nCode\n\nButton\n\n### Button with an icon\n\nExample\n\nCode\n\nAdd to Cart\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | ------------------------------------------------------------------------------------ |\n| \\--fs-button-padding | calc(var(--fs-spacing-1) - (var(--fs-button-border-width) \\* 2)) var(--fs-spacing-3) |\n| \\--fs-button-height | var(--fs-control-tap-size) |\n| \\--fs-button-gap | var(--fs-spacing-2) |\n| \\--fs-button-shadow | var(--fs-shadow) |\n| \\--fs-button-shadow-hover | var(--fs-button-shadow) |\n| \\--fs-button-border-radius | var(--fs-border-radius) |\n| \\--fs-button-border-width | var(--fs-border-width-thick) |\n| \\--fs-button-border-color | transparent |\n| \\--fs-button-text-size | var(--fs-text-size-base) |\n| \\--fs-button-text-weight | var(--fs-text-weight-bold) |\n| \\--fs-button-transition-function | var(--fs-transition-function) |\n| \\--fs-button-transition-property | var(--fs-transition-property) |\n| \\--fs-button-transition-timing | var(--fs-transition-timing) |\n\n### Design tokens: Button with an icon\n\nButtons with icons reserve padding and alignment for the glyph and label, improving scannability while preserving clear touch targets and visual balance.\n\n| Local token | Default value/Global token linked |\n| ------------------------- | --------------------------------- |\n| \\--fs-button-icon-padding | 0 var(--fs-spacing-1) |\n\n### Design tokens: Primary\n\nPrimary buttons use high-contrast colors and bold emphasis to highlight the main action on a page, drawing focus and encouraging completion.\n\n| Local token | Default value/Global token linked |\n| ---------------------------------------- | ------------------------------------- |\n| \\--fs-button-primary-text-color | var(--fs-color-primary-text) |\n| \\--fs-button-primary-text-color-hover | var(--fs-button-primary-text-color) |\n| \\--fs-button-primary-text-color-active | var(--fs-button-primary-text-color) |\n| \\--fs-button-primary-bkg-color | var(--fs-color-primary-bkg) |\n| \\--fs-button-primary-bkg-color-hover | var(--fs-color-primary-bkg-hover) |\n| \\--fs-button-primary-bkg-color-active | var(--fs-color-primary-bkg-active) |\n| \\--fs-button-primary-border-color | transparent |\n| \\--fs-button-primary-border-color-hover | var(--fs-button-primary-border-color) |\n| \\--fs-button-primary-border-color-active | var(--fs-button-primary-border-color) |\n| \\--fs-button-primary-shadow-hover | var(--fs-button-shadow-hover) |\n\n### Design tokens: Primary Inverse\n\nPrimary inverse buttons adapt the primary style for dark or colored backgrounds, inverting surfaces and text to maintain prominence and accessible contrast.\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------------ | ---------------------------------------- |\n| \\--fs-button-primary-inverse-text-color | var(--fs-button-primary-bkg-color) |\n| \\--fs-button-primary-inverse-text-color-hover | var(--fs-button-primary-bkg-color) |\n| \\--fs-button-primary-inverse-text-color-active | var(--fs-button-primary-bkg-color) |\n| \\--fs-button-primary-inverse-bkg-color | var(--fs-button-primary-text-color) |\n| \\--fs-button-primary-inverse-bkg-color-hover | var(--fs-color-primary-bkg-light) |\n| \\--fs-button-primary-inverse-bkg-color-active | var(--fs-color-primary-bkg-light-active) |\n| \\--fs-button-primary-inverse-border-color | var(--fs-button-primary-border-color) |\n| \\--fs-button-primary-inverse-border-color-hover | var(--fs-button-primary-border-color) |\n| \\--fs-button-primary-inverse-border-color-active | var(--fs-button-primary-border-color) |\n| \\--fs-button-primary-inverse-shadow-hover | var(--fs-button-shadow-hover) |\n\n### Design tokens: Secondary\n\nSecondary buttons apply moderate emphasis to support alternative actions, providing clear affordance without competing with the primary call to action.\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------ | ------------------------------------------- |\n| \\--fs-button-secondary-text-color | var(--fs-color-secondary-text) |\n| \\--fs-button-secondary-text-color-hover | var(--fs-color-text-inverse) |\n| \\--fs-button-secondary-text-color-active | var(--fs-button-secondary-text-color-hover) |\n| \\--fs-button-secondary-bkg-color | var(--fs-color-secondary-bkg) |\n| \\--fs-button-secondary-bkg-color-hover | var(--fs-color-secondary-bkg-hover) |\n| \\--fs-button-secondary-bkg-color-active | var(--fs-color-secondary-bkg-active) |\n| \\--fs-button-secondary-border-color | var(--fs-button-secondary-text-color) |\n| \\--fs-button-secondary-border-color-hover | var(--fs-button-secondary-bkg-color-hover) |\n| \\--fs-button-secondary-border-color-active | var(--fs-button-secondary-bkg-color-active) |\n| \\--fs-button-secondary-shadow-hover | var(--fs-button-shadow-hover) |\n\n### Design tokens: Secondary Inverse\n\nSecondary inverse buttons tune colors for dark or colored surfaces, preserving contrast and hierarchy while remaining visually subordinate to primary actions.\n\n| Local token | Default value/Global token linked |\n| -------------------------------------------------- | --------------------------------------------------- |\n| \\--fs-button-secondary-inverse-text-color | var(--fs-button-secondary-text-color-hover) |\n| \\--fs-button-secondary-inverse-text-color-hover | var(--fs-button-secondary-text-color) |\n| \\--fs-button-secondary-inverse-text-color-active | var(--fs-button-secondary-inverse-text-color-hover) |\n| \\--fs-button-secondary-inverse-bkg-color | var(--fs-button-secondary-bkg-color) |\n| \\--fs-button-secondary-inverse-bkg-color-hover | var(--fs-button-secondary-text-color-hover) |\n| \\--fs-button-secondary-inverse-bkg-color-active | var(--fs-color-secondary-bkg-light) |\n| \\--fs-button-secondary-inverse-border-color | var(--fs-button-secondary-inverse-text-color) |\n| \\--fs-button-secondary-inverse-border-color-hover | var(--fs-button-secondary-inverse-bkg-color-hover) |\n| \\--fs-button-secondary-inverse-border-color-active | var(--fs-button-secondary-inverse-bkg-color-hover) |\n| \\--fs-button-secondary-inverse-shadow-hover | var(--fs-button-shadow-hover) |\n\n### Design tokens: Tertiary\n\nTertiary buttons use minimal emphasis—often transparent backgrounds and subtle borders—for low-priority or inline actions that should not distract from primary tasks.\n\n| Local token | Default value/Global token linked |\n| ----------------------------------------- | -------------------------------------- |\n| \\--fs-button-tertiary-text-color | var(--fs-color-tertiary-text) |\n| \\--fs-button-tertiary-text-color-hover | var(--fs-button-tertiary-text-color) |\n| \\--fs-button-tertiary-text-color-active | var(--fs-button-primary-bkg-color) |\n| \\--fs-button-tertiary-bkg-color | var(--fs-color-tertiary-bkg) |\n| \\--fs-button-tertiary-bkg-color-hover | var(--fs-color-tertiary-bkg-hover) |\n| \\--fs-button-tertiary-bkg-color-active | var(--fs-color-tertiary-bkg-active) |\n| \\--fs-button-tertiary-border-color | transparent |\n| \\--fs-button-tertiary-border-color-hover | var(--fs-button-tertiary-border-color) |\n| \\--fs-button-tertiary-border-color-active | var(--fs-button-tertiary-border-color) |\n| \\--fs-button-tertiary-shadow-hover | var(--fs-button-shadow-hover) |\n\n### Design tokens: Tertiary Inverse\n\nTertiary inverse buttons adjust low-emphasis styling for dark or colored backgrounds, ensuring legibility and subtle affordance without adding visual weight.\n\n| Local token | Default value/Global token linked |\n| ------------------------------------------------- | -------------------------------------------- |\n| \\--fs-button-tertiary-inverse-text-color | var(--fs-button-secondary-text-color-hover) |\n| \\--fs-button-tertiary-inverse-text-color-hover | var(--fs-button-secondary-text-color-hover) |\n| \\--fs-button-tertiary-inverse-text-color-active | var(--fs-button-secondary-text-color-hover) |\n| \\--fs-button-tertiary-inverse-bkg-color | var(--fs-button-secondary-inverse-bkg-color) |\n| \\--fs-button-tertiary-inverse-bkg-color-hover | var(--fs-button-primary-bkg-color-hover) |\n| \\--fs-button-tertiary-inverse-bkg-color-active | var(--fs-button-primary-bkg-color-active) |\n| \\--fs-button-tertiary-inverse-border-color | var(--fs-button-tertiary-border-color) |\n| \\--fs-button-tertiary-inverse-border-color-hover | var(--fs-button-tertiary-border-color) |\n| \\--fs-button-tertiary-inverse-border-color-active | var(--fs-button-tertiary-border-color) |\n| \\--fs-button-tertiary-inverse-shadow-hover | var(--fs-button-shadow-hover) |\n\n### Design tokens: Disabled\n\nDisabled buttons reduce contrast and suppress interactive feedback to clearly communicate inoperability while preserving layout and alignment.\n\n| Local token | Default value/Global token linked |\n| -------------------------------- | --------------------------------- |\n| \\--fs-button-disabled-bkg-color | var(--fs-color-disabled-bkg) |\n| \\--fs-button-disabled-text-color | var(--fs-color-disabled-text) |\n\n### Design tokens: Loading\n\nLoading buttons allocate spacing and motion for progress feedback—optionally with a label—to indicate that an action is processing.\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | --------------------------------- |\n| \\--fs-button-loading-label-column-gap | var(--fs-spacing-3) |\n\n### Design tokens: Small\n\nSmall buttons tighten padding, height, and icon dimensions for dense layouts, balancing compactness with readability and usable tap targets.\n\n| Local token | Default value/Global token linked |\n| ------------------------------ | --------------------------------------- |\n| \\--fs-button-small-padding | var(--fs-spacing-0) var(--fs-spacing-1) |\n| \\--fs-button-small-min-height | var(--fs-spacing-5) |\n| \\--fs-button-small-gap | var(--fs-spacing-1) |\n| \\--fs-button-small-icon-width | var(--fs-spacing-3) |\n| \\--fs-button-small-icon-height | var(--fs-button-small-icon-width) |\n\n### Design tokens: Small with an icon\n\nSmall icon buttons fine-tune spacing and icon size in compact contexts, maintaining label clarity and alignment within tighter space constraints.\n\n| Local token | Default value/Global token linked |\n| ------------------------------ | --------------------------------------- |\n| \\--fs-button-small-padding | var(--fs-spacing-0) var(--fs-spacing-1) |\n| \\--fs-button-small-min-height | var(--fs-spacing-5) |\n| \\--fs-button-small-gap | var(--fs-spacing-1) |\n| \\--fs-button-small-icon-width | var(--fs-spacing-3) |\n| \\--fs-button-small-icon-height | var(--fs-button-small-icon-width) |\n\n---\n\n## Data attributes\n\nYou can target and override `Button` styles using the following data attributes:\n\n`data-fs-button`\n\n`data-fs-button-variant=\"primary | secondary | tertiary\"`\n\n`data-fs-button-inverse`\n\n`data-fs-button-size=\"small | regular\"`\n\n`data-fs-button-loading=\"true\"`\n\n---\n\n## Props\n\n| Name | Type | Description | Default | | | | | | |\n| ---------------- | ------------------------ | -------------------------------------------------------------------------------------- | -------------------------------------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | --------------------------------------------------- |\n| **testId** | string | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-button | | | | | | |\n| **variant** | \"primary\" \\| \"secondary\" | \"tertiary\" | Specifies the component color variant. | | | | | | |\n| **size** | \"small\" \\| \"regular\" | Specifies the size variant. | regular | | | | | | |\n| **inverse** | false \\| true | Defines the use of inverted colors. | | | | | | | |\n| **disabled** | false \\| true | Specifies that this button should be disabled. | | | | | | | |\n| **icon** | string \\| number | false | true | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | A React component that will be rendered as an icon. |\n| **loading** | false \\| true | Boolean that represents a loading state. | | | | | | | |\n| **loadingLabel** | string | Specifies a label for loading state. | | | | | | | |\n| **iconPosition** | \"left\" \\| \"right\" | Specifies where the icon should be positioned | left | | | | | | |\n\n---\n\n## Best Practices\n\n### ✅ Dos\n\n* Use standard button designs and shapes to make your button **clearly clickable**.\n* Use styles to **communicate the importance of an action** by visually differentiating [primary](#primary) and [secondary](#secondary) buttons.\n* Make buttons **finger-friendly** for mobile users and large enough for **reliable interactions**. Generally, touch targets are at least 44 by 44 CSS pixels.\n* Use **task-specific** words to write button labels.\n* Place the buttons in an **order that reflects a conversation between the user and the system**.\n* Provide visual or audio **feedback on interactions**. Whenever a user interacts with a button, it should change its state to indicate that an action is taking place.\n* Define a style system for your button states (e.g., normal, focus, hover, active, pressed, disabled).\n* Use icon-only buttons only for widespread actions with highly standardized icons, such as a cross for closing.\n* Use the `aria-label` attribute to provide a textual alternative for icon-only buttons.\n\n### ❌ Don'ts\n\n* Don't make users hunt for buttons. Place buttons where users expect to see them or can easily find them.\n* Don't rely on icons to communicate complex actions.\n* Don't use generic words that can potentially confuse users.\n* Avoid cluttering the UI with too many buttons.\n* Avoid having more than one primary action button on the screen at a time.\n* Avoid using disabled buttons, if possible. Instead, prefer to hide the unavailable option.\n* Don't place buttons next to [Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-badge). Although badges and buttons are similar in appearance, badges are not interactive and may confuse users if not used in the proper context.\n* Don't use buttons as [Links](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-link). Links are not intended to invite users to take action. Instead, they redirect users somewhere.\n* Avoid using `aria-label` when the button already has a label.\n\n---\n\n## Related components\n\n* IconButton \nA button that contains only an icon. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-icon-button)\n* Buy Now \nBuyButton \nA button with the intent of directly sending the user to the checkout or cart step. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-buy-button)\n* Link Button \nLinkButton \nSimilar to `Button`, but navigates users between pages instead of executing actions. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-link-button)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/button.mdx)\n\n[Badge« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-badge)[CheckboxNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-checkbox)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23variants)[Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23disabled)[Loading](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23loading)[Size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23size)[Button with an icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23button-with-an-icon)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens)\n\n[Design tokens: Button with an icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-button-with-an-icon)[Design tokens: Primary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-primary)[Design tokens: Primary Inverse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-primary-inverse)[Design tokens: Secondary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-secondary)[Design tokens: Secondary Inverse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-secondary-inverse)[Design tokens: Tertiary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-tertiary)[Design tokens: Tertiary Inverse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-tertiary-inverse)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-disabled)[Design tokens: Loading](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-loading)[Design tokens: Small](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-small)[Design tokens: Small with an icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-small-with-an-icon)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23best-practices)\n\n[✅ Dos](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%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/button.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-button/docs/guides/faststore/atoms-button%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23import-styles)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23examples)\n\n[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23variants)[Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23disabled)[Loading](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23loading)[Size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23size)[Button with an icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23button-with-an-icon)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens)\n\n[Design tokens: Button with an icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-button-with-an-icon)[Design tokens: Primary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-primary)[Design tokens: Primary Inverse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-primary-inverse)[Design tokens: Secondary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-secondary)[Design tokens: Secondary Inverse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-secondary-inverse)[Design tokens: Tertiary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-tertiary)[Design tokens: Tertiary Inverse](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-tertiary-inverse)[Design tokens: Disabled](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-disabled)[Design tokens: Loading](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-loading)[Design tokens: Small](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-small)[Design tokens: Small with an icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23design-tokens-small-with-an-icon)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23props)\n\n[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23best-practices)\n\n[✅ Dos](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%23-donts)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button/docs/guides/faststore/atoms-button%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_9ca29396
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore getting started 5 integrating your project with the headless cms in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-overview)\n\n[1\\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-1-setting-up-your-environment)\n\n[2\\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-2-starting-the-project)\n\n[3\\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-3-running-the-project-locally)\n\n[4\\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-4-understanding-the-project-structure)\n\n[5\\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)\n\n[Setting up the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\n[Structuring Content Types and Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-structuring-content-types-and-sections)\n\n[Promoting your changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-promoting-your-headless-cms-changes)\n\n[6\\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-6-next-steps)\n\n[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-glossary)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-overview)\n\n5\\. Integrating your project with the Headless CMS\n\nConnect your FastStore project with the Headless CMS to manage and publish your store’s content efficiently.\n\nIn this step, you'll connect your FastStore project to [Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/headless-cms-overview) so editors can create, preview, and publish content. You'll also configure the webhooks that keep builds and previews in sync—without this integration, CMS changes won't reach your storefront.\n\n## What you'll accomplish\n\nBy the end of this step, you will have:\n\n* Configured Headless CMS webhooks to trigger builds when content is published\n* Set up preview URLs for content editors to see changes before going live\n* Configured WebOps to communicate CMS updates back to your Git repository\n* Established a complete content workflow where CMS changes automatically sync with your codebase\n\nThis integration enables your content team to manage store content independently while keeping everything in sync with your development workflow.\n\n## Step 1: Configuring the Headless CMS\n\nConfigure the URLs of the webhooks used by the Headless CMS app.\n\n1. In the VTEX Admin, access **Storefront > Headless CMS**.\n2. In the FastStore project interface, click on `Settings` (⚙️).\n3. In **Settings**, click the `Build` tab.\n4. In **Build Webhook URL**, click `Add`.\n5. Enter the following value. _Replace the values between curly brackets according to your scenario._ \n`1 \nhttps://app.io.vtex.com/vtex.cms-builder-sf-jamstack/v1/{account}/master/build-releases \n`\n6. Click **SAVE**.\n\n> When an editor clicks to publish a page using the Headless CMS interface, the CMS calls the **Build Webhook URL**, which changes the page's status to `published`. The CMS then waits for the content to be built in the background.\n\n1. Fill in the **Preview URL** field with your production URL. This URL activates the button on the Headless CMS, allowing you to preview the changes made to a page. _Replace the values between curly brackets according to your scenario._\n\n## Step 2: Communicating WebOps updates to the Headless CMS\n\nIf you are developing your FastStore project with CI/CD and Headless CMS, you must ensure that CI/CD is aware of every CMS update performed via the VTEX Admin. To do so, you must configure the WebOps webhooks responsible for communicating with the Headless CMS as follows.\n\n1. Open your FastStore project in any code editor of your preference.\n2. Edit the `discovery.config.js` file in the root directory of your project.\n3. In the Headless CMS configuration, add the `webhookUrls` property corresponding to your store website as follows: \ndiscovery.config.js \n`1 \n\"vtexHeadlessCms\": { \n2 \n webhookUrls: [ \n3 \n \"https://{account}.myvtex.com/cms-releases/webhook-releases\" \n4 \n ] \n5 \n} \n`\n4. Open a Pull Request in your project, including the previous changes.\n5. Merge the Pull Request.\n\nNow you can make changes to the Headless CMS and check if commits are being created in the project. In the following example, the `Hero` title was modified to `10% off on first purchase`, and we can see that it generated a commit in the repository.\n\n\n\n## Next step\n\nNow that Headless CMS is integrated, set up content types and sections for your editors: [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)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/5-integrating-your-project-with-the-headless-cms.mdx)\n\n[4\\. Understanding the project structure« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-4-understanding-the-project-structure)[Setting up the Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-setting-up-the-headless-cms)\n\nSee also\n\n[VTEX IO CLIGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23what-youll-accomplish)\n\n[Step 1: Configuring the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-1-configuring-the-headless-cms)\n\n[Step 2: Communicating WebOps updates to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-2-communicating-webops-updates-to-the-headless-cms)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%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/5-integrating-your-project-with-the-headless-cms.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What you'll accomplish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23what-youll-accomplish)\n\n[Step 1: Configuring the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-1-configuring-the-headless-cms)\n\n[Step 2: Communicating WebOps updates to the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%23step-2-communicating-webops-updates-to-the-headless-cms)\n\n[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms%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_a6f3949c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides punchout login integration in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout)\n\n[Punchout login integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout)\n\n[Punchout login integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides)\n\nIntegration Guides\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout)\n\n[Punchout login integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration)\n\nPunchout login integration\n\nLearn how to securely integrate external procurement systems with VTEX stores using Punchout login flows and one-time tokens.\n\nThe Punchout login integration enables external procurement systems to authenticate users into a VTEX store without requiring manual credential input. This guide explains how to implement the [Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout) login flow using one-time tokens (OTT) for secure, session-based authentication.\n\nThe flow supports two integration types:\n\n* **[VTEX user flow](#vtex-user-flow):** For procurement users who exist on the VTEX platform. In this flow, the username and password are sent as part of the request body, and VTEX authorizes them.\n* **[Pre-authenticated user flow](#pre-authenticated-user-flow):** For procurement users who don't exist on VTEX. In these cases, VTEX trusts the integrator to authorize these users and receive their username for login.\n\n## How it works\n\nThe authentication flow starts with a request to a Punchout endpoint and ends with the user's browser being redirected to a store page in a logged-in state.\n\nThe authentication process creates a one-time token (OTT) and returns a URL to be accessed by the procurement system. This URL starts a user session in the VTEX store.\n\nExample flow:\n\n1. Start request (VTEX user flow): \n`1 \nhttps://host.com/api/authenticator/punchout/start?returnURL=/checkout \n`\n2. Finish redirect (with OTT): \n`1 \nhttps://host.com/api/authenticator/punchout/finish?ott=TOKEN123 \n`\n3. Final redirect (logged-in session): \n`1 \nhttps://host.com/checkout \n`\n\n> The OTT is short-lived (expires in 5 minutes) and can only be used once.\n\nProcurement UserWebMethodsVTEX Authenticator Servicealt\\[returnURL provided\\]alt\\[VTEX-User Flow (Existing VTEX User)\\]alt\\[returnURL provided\\]alt\\[Pre-Authenticated Flow (Delegated Login)\\]Initiate Punchout Login (username, password, optional returnURL)1POST /api/authenticator/punchout/start {username, password} + returnURL2Validate user credentials3Generate one-time token (OTT)4200 OK with URL (including OTT)5Provide login URL6GET /api/authenticator/punchout/finish?ott={token}7Validate OTT and create session (set session cookie)8302 Redirect to validated returnURL9200 OK (session established)10Initiate Delegated Punchout Login (target username, optional returnURL)11POST /api/authenticator/punchout/authenticated/start {username} + valid auth cookie + returnURL12Validate API key/token and permissions13Generate one-time token (OTT) with delegated subject claim14200 OK with URL (including OTT)15Provide login URL16GET /api/authenticator/punchout/finish?ott={token}17Validate OTT and create session (set session cookie for delegated user)18302 Redirect to validated returnURL19200 OK (session established)20Procurement UserWebMethodsVTEX Authenticator Service\n\n## Start VTEX user flow\n\nThis flow validates the credentials of an existing VTEX user. It requires the user’s email and password. If the validation is positive, the response provides a URL that can be accessed directly via web browsers, initiating a session in the selected host.\n\n> Find more details about this endpoint in `POST` [Start VTEX user punchout flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api%23post-/api/authenticator/punchout/start).\n\n### Request example\n\n`1\n\ncurl -X POST \"https://store.myvtex.com/api/authenticator/punchout/start?returnURL=/checkout\" \\ \n\n2\n\n -H \"Content-Type: application/json\" \\ \n\n3\n\n -d '{ \n\n4\n\n \"username\": \"user@example.com\", \n\n5\n\n \"password\": \"vtex_user_password\" \n\n6\n\n }' \n\n`\n\n### Response body example\n\n`1\n\n{ \n\n2\n\n \"url\": \"https://apiexamples.com/punchout/redirect/OTT123\" \n\n3\n\n} \n\n`\n\n## Start pre-authenticated user flow\n\nThis flow is used when the procurement user doesn’t exist on VTEX. In this case, a password isn't required. An authenticated integration, using a valid API key/API token pair associated with a role that has the `CanPunchout` permission, generates an OTT on behalf of the user. Other authentication methods (such as `VtexIdClientAutCookie`) don't work for this endpoint.\n\nIf the validation is positive, the response provides a URL that can be accessed directly via web browsers, initiating a session created with the username provided in the request body.\n\n> Find more details about this endpoint in `POST` [Start pre-authenticated user punchout flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api%23post-/api/authenticator/punchout/authenticated/start).\n\n### Request example\n\n`1\n\ncurl -X POST \"https://store.myvtex.com/api/authenticator/punchout/authenticated/start?returnURL=/checkout\" \\ \n\n2\n\n -H \"Content-Type: application/json\" \\ \n\n3\n\n -H \"X-VTEX-API-AppKey: your-app-key\" \\ \n\n4\n\n -H \"X-VTEX-API-AppToken: your-app-token\" \\ \n\n5\n\n -d '{ \n\n6\n\n \"username\": \"buyer@company.com\" \n\n7\n\n }' \n\n`\n\n### Response body example\n\n`1\n\n{ \n\n2\n\n \"url\": \"https://apiexamples.com/punchout/redirect/OTT123\" \n\n3\n\n} \n\n`\n\n## Finish redirect\n\nThe finish endpoint exchanges the OTT for VTEX session cookies and completes the authentication process.\n\nIn browser-based integrations, the finish flow happens automatically when the user's browser accesses the URL returned by the start endpoint. This creates a seamless login experience.\n\nFor headless operations where no browser is involved, integrators must explicitly call the finish endpoint to obtain the necessary authentication cookies. This is useful for automated processes or server-side integrations.\n\nThe finish endpoint:\n\n* **Validates the OTT** \n * Checks if the token exists and hasn't expired. \n * Ensures the token hasn't been used before.\n* **Creates a VTEX session** \n * For VTEX user flow: Creates session based on the validated VTEX user. \n * For pre-authenticated flow: Creates session using the username from the token's sub claim. \n * Adds `authMethod: \"Punchout\"` to the session token for tracking login source.\n* **Sets authentication cookies** \n * Returns VTEX session cookies in response headers. \n * These cookies are required for subsequent authenticated requests.\n\n> Find more details about this endpoint in `GET` [Finish punchout login flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/punchout-api%23get-/api/authenticator/punchout/finish).\n\n### Request example\n\n`1\n\ncurl -X GET \"https://store.myvtex.com/api/authenticator/punchout/finish?ott={one_time_token}\" \\ \n\n2\n\n -H \"Content-Type: application/json\" \\ \n\n`\n\n## Security mechanisms\n\nPunchout login flows use the following security mechanisms to protect credentials and redirect behavior:\n\n* **One-Time Tokens (OTT)**: Tokens expire after 5 minutes and can be used only once.\n* **Secure credential handling**: Credentials are validated directly against the VTEX user database (VTEX user flow) or the request is made with secure API credentials (pre-authenticated flow).\n* **Redirect protection**: The `returnURL` is validated against authorized hosts to avoid open redirects.\n\n### Store Framework Content-Security-Policy requirements\n\n> This requirement only applies to [Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework) stores.\n\nIf your store uses Store Framework, you must configure the `Content-Security-Policy` header with the `frame-ancestors` directive to allow your store to be embedded in procurement system iframes. Follow the instructions in [Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store) and set the header as follows:\n\n`1\n\nContent-Security-Policy: frame-ancestors 'self' https://procurement-system-a.com https://*.procurement-system-b.com \n\n`\n\nReplace the example domains with the actual domains of your procurement systems.\n\n> Modern browsers (released in the last 10 years) fully support `frame-ancestors` and will ignore the older `X-Frame-Options` header. Legacy browsers such as Internet Explorer 10 and 11 do not support `frame-ancestors` and may experience issues with Punchout integration. For more information, see [Content Security Policy (CSP)](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Guides/CSP) and [frame-ancestors browser compatibility](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Content-Security-Policy/frame-ancestors%23browser%5Fcompatibility).\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/punchout/punchout-login-integration.md)\n\n[Punchout« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration//docs/guides/punchout)[Offer Management Integration GuideNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration//docs/guides/sent-offers-integration-guide-connectors)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23how-it-works)\n\n[Start VTEX user flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23start-vtex-user-flow)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23request-example)[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23response-body-example)\n\n[Start pre-authenticated user flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23start-pre-authenticated-user-flow)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23request-example)[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23response-body-example)\n\n[Finish redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23finish-redirect)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23request-example)\n\n[Security mechanisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23security-mechanisms)\n\n[Store Framework Content-Security-Policy requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23store-framework-content-security-policy-requirements)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/punchout/punchout-login-integration.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23how-it-works)\n\n[Start VTEX user flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23start-vtex-user-flow)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23request-example)[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23response-body-example)\n\n[Start pre-authenticated user flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23start-pre-authenticated-user-flow)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23request-example)[Response body example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23response-body-example)\n\n[Finish redirect](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23finish-redirect)\n\n[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23request-example)\n\n[Security mechanisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23security-mechanisms)\n\n[Store Framework Content-Security-Policy requirements](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout-login-integration/docs/guides/punchout-login-integration%23store-framework-content-security-policy-requirements)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_792ce16a
|
[
{
"role": "system",
"content": "You are a VTEX 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 optimizing 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/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-performance/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-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-performance/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-performance/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-performance/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-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-performance/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-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-performance/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-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/vtex-io-documentation-best-practices-for-optimizing-performance/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-optimizing-performance/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-optimizing-performance/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/store-framework-managing-performance)\n\n[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings)\n\nEnabling performance settings\n\nFor ecommerce businesses, appealing offers, high-quality products, or brand recognition might not be enough to convert leads if the user experience falls short. Store website performance is essential to the user experience, directly impacting sales conversion rate, user session time, and other metrics. Every millisecond counts and affects the consumer decision-making process and website ranking in search engine results.\n\nThis guide outlines actions you can implement to optimize store performance. These [optimization options](#optimization-options) can improve SEO score and page loading time. You can measure these improvements using tools like [Google Lighthouse](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/lighthouse) and [Google Analytics](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/1205784?hl=en). Learn more in the **Monitoring tools** section in the [Performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-performance) guide.\n\nThis guide is divided into the following sections:\n\n* [Instructions](#instructions): Instructions for enabling and deploying performance optimizations in your store, including workspace setup, Admin configuration, and promoting changes to production.\n* [Optimization options](#optimization-options): Methods to enhance store performance, categorized by: \n * [Store settings](#store-settings): Actions that can be performed directly in the VTEX Admin. \n * [Manual optimizations](#manual-optimizations): Additional manual actions for advanced performance that require direct code changes.\n\n## Instructions\n\n### Step 1 - (Optional) Testing manual optimizations\n\nIf you have implemented [manual optimizations](#manual-optimizations), make sure to use a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) to test them before making your new app version publicly available. Learn more about this process in the guide [Deploying a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available).\n\n### Step 2 - Applying changes in a production workspace\n\n1. Using the terminal and the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/), log in to the desired account by running `vtex login {account}`.\n2. Run the command `vtex use {productionWorkspace} --production` to create and use a **new** [production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-workspace/). \n> Replace the values between the curly braces based on your scenario.\n3. Using your browser, access the Admin for that workspace.\n4. In the account's Admin, go to **Store Settings > Storefront > Store > Advanced**.\n5. Follow the instructions in the [Store settings](#store-settings) section to activate the desired features, then save the changes.\n6. Access your store in the workspace you're using and check whether the performance improvements were applied.\n\n> Changes may take some time to be reflected.\n\n### Step 3 - Testing and analyzing performance\n\n1. Review and test all main pages, ensuring the changes didn't cause any side effects, such as style inconsistencies or undesired behaviors.\n2. Access [Google PageSpeed Insights](https://read.calvincode.net/reader?url=https://developers.google.com/speed/pagespeed/insights).\n3. Using the following URL pattern: `https://{account}.myvtex.com/?workspace={productionWorkspace}`, check store performance in the production workspace where you're currently working.\n\n> Using the standard URL pattern `https://{workspace}--{account}.myvtex.com/` won't show the store performance score in the specified workspace. To analyze performance in a workspace, **you must use the `?workspace={productionWorkspace}` query string** as shown in Step 3.3.\n\n### Step 4 - Making your changes publicly available\n\nIf you're satisfied with the results, run `vtex promote` to promote your workspace and benefit from a faster store. Before promoting your workspace to master, measure the performance improvements by comparing the performance scores in the production and master workspaces.\n\n## Optimization options\n\n### Store settings\n\nStore settings are actions you can configure directly in the VTEX Admin by navigating to **Store Settings > Storefront > Store > Advanced**.\n\n\n\n#### OrderForm optimization\n\nThis action disables the legacy `orderForm` provider.\n\nThe `orderForm` is an object that stores and retrieves data from user orders, including each item added to the cart. To give other Store Theme blocks access to the data stored in the `orderForm` and allow them to render it, Store Framework runs the `OrderFormProvider` object on each store page. This object exports all the necessary `orderForm` information to these blocks.\n\nHowever, all stores using VTEX IO Store Framework currently have two `OrderFormProviders`: a legacy version, still consumed by native blocks such as `minicart` and `buy-button`, and a newer version, better suited for replacement.\n\nWe recommend that stores using `minicart.v2` and `add-to-cart-button` blocks (instead of `minicart` and `buy-button`, respectively) disable the legacy provider. Consuming a single provider will improve store performance.\n\nLearn more in the guide [Enabling OrderForm optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-enabling-order-form-optimization/).\n\n#### Service worker\n\nThis action adds the default service worker provided by VTEX.\n\nThe VTEX IO platform provides a native service worker to every store using Store Framework. If you need to use a third-party service with its service worker, you may face conflicts. You can deactivate the native VTEX service worker to resolve this.\n\nLearn more in the guide [Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker/).\n\n#### Critical CSS optimization\n\nThis action enables CSS optimizations on your pages to boost performance and improve Lighthouse scores. It lets the browser identify and load essential CSS needed for critical, above-the-fold content first, while loading the remaining CSS code asynchronously.\n\n\n\nHowever, by default, the browser initiates the rendering of a web page after it finishes loading, parsing, and executing all related CSS files. Consequently, the more extensive the CSS code, the longer it takes to render the critical part of the page.\n\nThis optimization can be enabled for the following pages:\n\n* Homepage\n* Search page\n* Custom pages\n* Product page\n\n> Enabling these options might cause style inconsistencies in the store layout. Test these changes carefully before enabling them on a production workspace. If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Enable CSS concatenation\n\nThis action concatenates a page's CSS in a single file for faster download, reducing the HTTP requests required to load each CSS file separately.\n\n\n\n#### Enable prefetch\n\nThis action prefetches pages when a user hovers over a link.\n\nWhen enabled, the page content is proactively downloaded in the background when you hover over a link. This means that the page is already loaded or partially loaded when you click the link.\n\n#### Enable lazy runtime\n\nThis action enables lazy loading of page metadata.\n\nBefore displaying a web page, the VTEX IO service app that renders server-side (Render Runtime) interprets the page metadata script. See the example below:\n\n`1\n\n<script> \n\n2\n\n __RUNTIME__ = {\"account\":\"vtexstore\",\"amp\":false,\"bindingChanged\":false,\"binding\":{\"id\":\"aacb04t3-a8fa-4bab-b5bd-2d654d20dcd8\",\"canonicalBaseAddress\":\"vtexstore.vtex.com\"},\"culture\":{\"availableLocales\":[],\"country\":\"USA\",\"currency\":\"USD\",\"language\":\"en\",\"locale\":\"en-US\",\"customCurrencyDecimalDigits\":null,\"customCurrencySymbol\":\"$\"},\"production\":true,\"query\":{},\"settings\":{.... \n\n`\n\nThis script contains significant web page data and can be long, demanding significant browser processing. When you enable lazy runtime, the script is broken into smaller scripts to avoid compromising the total blocking time of the store website. This helps avoid lengthy tasks, leading to a faster store experience.\n\n> Some apps might not work as expected when this option is enabled. Test with caution before enabling it on a production workspace. If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Enable lazy rendering of submenu items\n\nBy enabling this action, menus containing submenus automatically apply the `experimentalOptimizeRendering` prop. This configuration prevents the entire set of `submenus` from loading unnecessarily, as `submenus` only load when the user interacts with the parent menu where the prop is set.\n\n> Google won't be able to track the hidden submenu items for SEO, as their content only loads with user interaction. Make sure your SEO strategy is covered by the store sitemap or the first meaningfully painted content.\n\n#### Enable lazy rendering of search results and facets\n\nThis action enables lazy rendering for the scrollable facet box and search results pages. Content within the user's viewport loads first, and content outside the viewport loads only as the user scrolls.\n\n> Enabling this option might cause unexpected behaviors, such as gaps while scrolling. If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Enable loading scripts asynchronously\n\nThis action allows the browser to load and execute scripts asynchronously. This means the browser doesn't wait for the script to fully download and execute before continuing to parse and render the rest of the page. Instead, it can process other elements of the page concurrently while the script loads in the background.\n\n#### Enable concurrent React mode\n\nThis action helps the store stay responsive by adjusting to the capabilities of the user's device and network speed. This means rendering tasks can be prioritized and interrupted based on user interactions or current network conditions.\n\nFor example, if a user begins typing in a search bar while other content is still loading, concurrent mode can pause loading to process your input, ensuring the search bar remains responsive. Once the input is handled, rendering can resume without perceived delays.\n\n#### Enable fetching filters partially\n\nWhen you enable this action, search results pages display a maximum of 10 facets per filter.\n\nThe search query won't automatically retrieve any additional facets or show them to the user. Instead, a `Show more` button allows users to load the remaining facets.\n\n> A facet is a filter value. For example, `Color` is a filter, and `Blue` is a facet of that filter.\n\n#### Enable executing all GraphQL queries on the product page\n\nThis action allows the product page to fetch additional data necessary to render components positioned above-the-fold. This helps ensure that product details, images, and any other components in the main view display together without delays or missing information.\n\n> Enable this only if your product page truly needs it; otherwise, it may lead to deoptimization.\n\n#### Enable lazy rendering of the page footer\n\nThis action renders the page footer and loads its assets lazily, which helps improve performance when first rendering the page.\n\n#### Enable lazy loading of assets below the fold\n\nThis action enables lazy loading of the JavaScript files of the components below the `_fold_` block. This keeps the initial load fast and reduces unnecessary bandwidth usage for users who never scroll.\n\n#### Enable page number in meta title\n\nThis option adds a `#{Number}` to the HTML title. This helps both users and search engines know exactly which page they're viewing and avoids duplicate titles, which can impact SEO.\n\n> It's best suited for stores using traditional pagination. After enabling, review your page titles to make sure they remain clear and consistent.\n\n#### Canonical URL without URL parameters\n\nThis action removes the map parameter from the canonical URL, so search engines focus on a single, clean address for each page.\n\n> This may cause issues when visiting a page with selected facets. Test with caution after turning it on.\n\n#### Remove store name from title\n\nThis action removes the store name from the end of page titles on product and category pages, resulting in shorter titles that may highlight product keywords better for SEO.\n\n#### Enable custom currency symbol\n\nThis action uses the `Currency Symbol` field defined in the trade policy. This ensures that prices are displayed in the format and symbol your customers expect, which is especially important for international or multi-currency stores.\n\n#### \\[BETA\\] Show sponsored products on search results\n\nThis action enables stores in the Retail Media Network (RMN) pilot to place advertiser-sponsored products alongside organic search results.\n\n> This action is available only for stores that have joined the RMN pilot. For more information, email **[rmn@vtex.com](mailto:rmn@vtex.com)**.\n\n#### Enable default browser navigation\n\nEnabling this action means each store page loads separately with full reloads instead of rendering through the VTEX IO service app on the server (Render Runtime). This default browser navigation can be useful for troubleshooting or when experiencing issues with client-side routing.\n\n> Full-page reloads are generally slower and consume more bandwidth than the standard VTEX navigation. Use this only when necessary for testing or for compatibility, and consider whether the change impacts user experience or conversion rates.\n\n### Manual optimizations\n\nIn addition to the features configured in the VTEX Admin, you can apply manual optimizations directly in the project source code to enhance store performance.\n\n#### Improving scrolling performance\n\nUse the `__fold__` block for scrollable pages. This allows you to specify which interface components load initially (above the fold) and which are lazy-loaded as the user scrolls.\n\nYou can also use the `__fold__.experimentalLazyAssets` block to define which theme blocks should load statically upon the first user interaction.\n\nLearn more about fold blocks in the guide [Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-fold-blocks).\n\n> If you notice any side effects, [open a ticket with VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\n\n#### Reducing the number of menu blocks\n\nIf a menu block doesn't have a submenu, configure it to use `menu-item` blocks as props instead of children.\n\nIn the example below, the main `menu items` (Apparel & Accessories, Home & Decor, and More) can't be modified in their implementation. They must remain as children since they have a trigger to open a `submenu`.\n\n\n\nHowever, the internal `menu-items` (Clothing, Accessories, and Eyeglasses) can be changed from children to props.\n\nPreviously, each `menu-item` was set up as an individual child/block. With the change, the `menu-items` group, declared as props, is treated as a single block, represented by a blue square.\n\nThis approach reduces the number of blocks from 3 to 1, improving store performance.\n\nLearn more about applying both configurations in the [Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.menu) guide.\n\n#### Adjusting image sizes\n\nThe size of images in your store directly impacts performance. To optimize image rendering, follow the practices outlined in the guide [Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/), focusing on the media types used in your theme.\n\n#### Improving search results\n\nTo avoid performance issues on search results pages, use the `skusFilter` and `simulationBehavior` props. These props control the SKUs returned for each product in the search query, determining whether the displayed search data will be current (`skusFilter`) or retrieved from the cache (`simulationBehavior`).\n\nWe recommend setting `skusFilter` to `FIRST_AVAILABLE` to return only the first available SKU for each product, and `simulationBehavior` to `skip` to display search data from the cache.\n\nLearn more about prop configuration in the [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) app documentation.\n\n#### Using lazy loading for sliders\n\nBuild the shelf and carousel blocks of your theme using the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout) component.\n\nSlider Layout uses lazy loading to automatically load images and product information only when users interact with shelves or carousels, reducing page load time. However, having more products in these components may negatively impact website performance.\n\nLearn more about using Slider Layout in the guides [Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-shelf/) and [Building a Carousel using Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-carousel-using-slider-layout/).\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/boosting-performance/vtex-io-documentation-enabling-performance-settings.md)\n\n[Getting started with Lighthouse performance audit« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance//docs/guides/vtex-io-documentation-getting-started-with-lighthouse)[Tracking changes in Lighthouse performance scoreNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance//docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23instructions)\n\n[Step 1 - (Optional) Testing manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-1-optional-testing-manual-optimizations)[Step 2 - Applying changes in a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-2-applying-changes-in-a-production-workspace)[Step 3 - Testing and analyzing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-3-testing-and-analyzing-performance)[Step 4 - Making your changes publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-4-making-your-changes-publicly-available)\n\n[Optimization options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23optimization-options)\n\n[Store settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23store-settings)[Manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23manual-optimizations)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/boosting-performance/vtex-io-documentation-enabling-performance-settings.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23instructions)\n\n[Step 1 - (Optional) Testing manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-1-optional-testing-manual-optimizations)[Step 2 - Applying changes in a production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-2-applying-changes-in-a-production-workspace)[Step 3 - Testing and analyzing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-3-testing-and-analyzing-performance)[Step 4 - Making your changes publicly available](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23step-4-making-your-changes-publicly-available)\n\n[Optimization options](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23optimization-options)\n\n[Store settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23store-settings)[Manual optimizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance/docs/guides/vtex-io-documentation-enabling-performance-settings%23manual-optimizations)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_33cf18f9
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore using themes 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/using-themes-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/using-themes-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/using-themes-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/using-themes-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/using-themes-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/using-themes-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/using-themes-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/using-themes-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/using-themes-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/using-themes-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/using-themes-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/using-themes-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/using-themes-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/using-themes-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/using-themes-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/using-themes-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/using-themes-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/using-themes-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/using-themes-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/using-themes-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/using-themes-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/using-themes-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/using-themes-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/using-themes-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/using-themes-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-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/using-themes-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/using-themes-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/using-themes-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/styling-overview)\n\nTheming\n\nTheming allows you to change the UI of your project by using CSS stylesheets called themes.\n\nThis guide provides an overview of theming in FastStore, explaining the concept of theming, the use of global and local tokens, the structure and architecture of themes, and the naming scheme for design tokens.\n\n---\n\n## Overview\n\nTheming refers to the process of customizing the UI of a project by using CSS stylesheets called themes. Themes consist of configurable design tokens that define the look and feel of the UI.\n\nBy modifying these design tokens, you can change the colors, typography, spacing, and other visual properties to create a unique look and feel for your store. By default, every FastStore project comes with the [Brandless theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview%23brandless-and-the-theming-structure), a basic theme to start your FastStore project.\n\nHowever, you have the option to use one of the [available themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview%23available-themes) or [create a custom theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview%23creating-a-custom-theme).\n\n> You have the flexibility and freedom to style the theme by overriding it using global or local tokens, or by starting from scratch using your preferred styling tool.\n\n---\n\n## Global and Local Tokens\n\nThere are two types of design tokens: global tokens and local tokens.\n\n| Design Token name | Description |\n| ----------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Global tokens** | Structural styles that define the behavior and design patterns of components at a system-wide level. They handle interactions such as showing or hiding dropdown menus and toggles. |\n| **Local tokens** | Design tokens specific to individual components. They control the appearance of graphical elements within components, including typography, colors, borders, and spacing. |\n\nBy configuring global and local tokens, you can create consistent visual styles across your application while allowing for customization at both the system and component levels.\n\n---\n\n## Brandless and the Theming structure\n\nBrandless, the FastStore default theme, is a themeable structure made of two complementary layers: a useful and assorted library of templates for the components and sections, the **Structural Styles**, alongside a comprehensive set of design tokens to further customize them, the **Theme Layer**.\n\nThese two layers are the two main parts of the theming structure:\n\n**Structural Styles** provide the foundational design patterns and handle essential interactions across components. They establish the basic behavior of the UI.\n\nThe **Theme layer** is where the branding and customization happen. It allows you to control design elements such as typography, colors, images, borders, and spacing through design tokens. By adjusting these tokens, you can achieve a distinct visual identity for your application.\n\nYou have the flexibility to customize or override the styles defined in the Structural Styles or Theme layers. Alternatively, you can start from scratch and create your own styles without relying on pre-existing FastStore CSS.\n\nUnderstanding the Structural Styles and Theme layers enables you to create visually appealing and unique user interfaces while maintaining control and flexibility.\n\n\n\n---\n\n## Theming architecture\n\nThe theming architecture is structured as follows:\n\n### Components\n\nThese are fully-featured UI blocks that form part of the larger system. Each component has its own CSS stylesheets called Templates, which determine its appearance and arrangement.\n\n### Local Design Tokens\n\nComponents rely on local design tokens, which are specific to each component. These design tokens define the visual properties of the component, such as colors, typography, and spacing.\n\n### Global Design Tokens\n\nLocal design tokens are connected to global tokens, forming the Theme. Global tokens are responsible for setting the overall visual style of the entire system. They affect the appearance of multiple components and ensure consistency across the application.\n\nThe interaction between components, local design tokens, and global design tokens creates a hierarchical structure allowing modular theming and customization.\n\n\n\n---\n\n## Design Tokens naming scheme\n\nDesign tokens follow a specific naming scheme to ensure predictability and cohesiveness. The naming scheme consists of different parts:\n\n* **Namespacing:** Indicates the origin of the token. For example, in `--fs-color-main-0`, the `--f` indicates that the variable belongs to FastStore-related styles.\n* **Component:** Represents the semantic meaning of the token.\n* **Type:** Specifies the type of property the token affects, such as color, typography, or spacing.\n* **Category:** Defines the category within the type that the token affects.\n* **State:** Indicates the interactive state of the token.\n\n\n\nTo differentiate tokens and provide more context, additional increments can be added to the token's name, such as hierarchy, nested element, variant, or situation.\n\n* **Hierarchy**: Define its tier.\n* **Nested Element**: To style elements contained inside the component.\n* **Variant**: Characteristics that differentiate it from the default version.\n* **Situation**: When they should be used.\n\n\n\n---\n\n## Theme (or global design tokens)\n\nGlobal design tokens are parameters that affect all UI appearance. They are the main configuration file of a Theme. It's constituted of three main groups:\n\n1. Branding Core\n2. UI Essentials\n3. Refinements\n\n\n\n---\n\n## Learn more\n\n* [Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-overview)\n* [Themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview)\n* [Icons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/reference-icons)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/using-themes/overview.mdx)\n\n[Iconography« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/styling-icons)[Styling the layout and breakpointsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-mixins-breakpoints)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23overview)\n\n[Global and Local Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23global-and-local-tokens)\n\n[Brandless and the Theming structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23brandless-and-the-theming-structure)\n\n[Theming architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23theming-architecture)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23components)[Local Design Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23local-design-tokens)[Global Design Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23global-design-tokens)\n\n[Design Tokens naming scheme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23design-tokens-naming-scheme)\n\n[Theme (or global design tokens)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23theme-or-global-design-tokens)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%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/faststore/docs/styling/using-themes/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23overview)\n\n[Global and Local Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23global-and-local-tokens)\n\n[Brandless and the Theming structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23brandless-and-the-theming-structure)\n\n[Theming architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23theming-architecture)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23components)[Local Design Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23local-design-tokens)[Global Design Tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23global-design-tokens)\n\n[Design Tokens naming scheme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23design-tokens-naming-scheme)\n\n[Theme (or global design tokens)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%23theme-or-global-design-tokens)\n\n[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-overview/docs/guides/faststore/using-themes-overview%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_1a37e512
|
[
{
"role": "system",
"content": "You are a VTEX 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 slider in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-slider/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-slider/docs/api-reference)\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-slider/docs/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-slider/docs/storefront-development)\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-slider/docs/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-slider/docs/troubleshooting)\n\n[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-slider/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-slider/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-slider/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/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-slider/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/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-slider/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/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-slider/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-slider/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-slider/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-slider/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/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-slider/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-slider/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/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-slider/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-slider/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/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-slider/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/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-slider/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-overview)\n\n[Badge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-badge)\n\n[Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-button)\n\n[Checkbox](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-checkbox)\n\n[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-icon)\n\n[Input](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-input)\n\n[Label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-label)\n\n[Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-link)\n\n[List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-list)\n\n[Loader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-loader)\n\n[Overlay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-overlay)\n\n[Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-price)\n\n[Radio](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-radio)\n\n[Select](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-select)\n\n[SROnly](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-sr-only)\n\n[Skeleton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-skeleton)\n\n[Slider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider)\n\n[Textarea](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-textarea)\n\n[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/molecules-overview)\n\n[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/organisms-overview)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/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-slider/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-slider/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-slider/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-slider/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/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-slider/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-slider/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-slider/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/components-index)\n\n[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-overview)\n\nSlider\n\nSliders allow users to select a single value from a range.\n\n[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/atoms/Slider)\n\nThe `Slider` component provides an interactive way for users to select a single value from a defined range. Common use cases include adjusting prices, setting volume, or selecting values where precision within boundaries matters.\n\nExample\n\nCode\n\n0500\n\n---\n\n## Usage\n\n### Import the component\n\n`1\n\nimport { Slider } from \"@faststore/ui\"; \n\n`\n\n### Import Styles into your FastStore project\n\nTo apply styles, include the following in your stylesheet:\n\n`1\n\n@import \"@faststore/ui/src/components/atoms/Slider/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### Slider with custom step\n\nExample\n\nCode\n\n050\n\n### Accessible Slider with `aria-value-text`\n\nExample\n\nCode\n\n050\n\n### Slider with custom value labels\n\nExample\n\nCode\n\n0100\n\n10 kg90 kg\n\n---\n\n## Design tokens\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | ---------------------------------------- |\n| \\--fs-slider-height | var(--fs-spacing-2) |\n| \\--fs-slider-border-radius | var(--fs-border-radius-pill) |\n| \\--fs-slider-margin-bottom | var(--fs-spacing-3) |\n| \\--fs-slider-slider-bkg-color | var(--fs-color-neutral-bkg) |\n| \\--fs-slider-slider-selection-bkg-color | var(--fs-color-primary-bkg-light-active) |\n| \\--fs-slider-transition-function | var(--fs-transition-function) |\n| \\--fs-slider-transition-property | var(--fs-transition-property) |\n| \\--fs-slider-transition-timing | var(--fs-transition-timing) |\n\n### Design tokens: Thumb\n\nThumb tokens control the appearance of the slider's draggable handle, including its size, color, border, and hover states.\n\n| Local token | Default value/Global token linked |\n| ------------------------------------- | -------------------------------------- |\n| \\--fs-slider-thumb-size | var(--fs-spacing-4) |\n| \\--fs-slider-thumb-bkg-color | var(--fs-color-primary-bkg) |\n| \\--fs-slider-thumb-bkg-color-hover | var(--fs-color-primary-bkg-hover) |\n| \\--fs-slider-thumb-border-width | var(--fs-border-width) |\n| \\--fs-slider-thumb-border-radius | var(--fs-border-radius-circle) |\n| \\--fs-slider-thumb-border-color | var(--fs-slider-thumb-bkg-color) |\n| \\--fs-slider-thumb-border-color-hover | var(--fs-slider-thumb-bkg-color-hover) |\n\n### Design tokens: Absolute values\n\nAbsolute value tokens define the color for the labels showing the minimum and maximum values on the slider.\n\n| Local token | Default value/Global token linked |\n| --------------------------------------- | --------------------------------- |\n| \\--fs-slider-absolute-values-text-color | var(--fs-color-disabled-text) |\n\n### Design tokens: Value label\n\nValue label tokens set the position and background color for the labels displaying the current slider value.\n\n| Local token | Default value/Global token linked |\n| ---------------------------------- | --------------------------------- |\n| \\--fs-slider-value-label-bottom | var(--fs-spacing-3) |\n| \\--fs-slider-value-label-bkg-color | var(--fs-color-body-bkg) |\n\n---\n\n## Data attributes\n\nYou can target and override Slider styles using the following data attributes:\n\n`data-fs-slider`\n\n`data-fs-slider-absolute-values`\n\n`data-fs-slider-range`\n\n`data-fs-slider-thumb=\"left\" | \"right\"`\n\n`data-fs-slider-value-label=\"min\" | \"max\"`\n\n---\n\n## Props\n\n### Range\n\n| Name | Type | Description | Default |\n| ------------ | ------ | --------------------------------- | ------- |\n| **absolute** | number | The absolute value of the slider. | |\n| **selected** | number | The selected value of the slider. | |\n\n### RangeLabel\n\n| Name | Type | Description | Default |\n| ------- | ------------------- | ------------------------------ | ------- |\n| **min** | string \\| ReactNode | Label for minimum range value. | |\n| **max** | string \\| ReactNode | Label for maximum range value. | |\n\n---\n\n## Related components\n\n* $0$500 \n$100$250 \nMin \nMax \nPriceRange \nPrice Ranges are sliders that allow users to select a maximum and minimum price. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/organisms-price-range)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/atoms/slider.mdx)\n\n[Skeleton« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-skeleton)[TextareaNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-textarea)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/aliceoq)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23import-the-component)[Import Styles into your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23import-styles-into-your-faststore-project)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23examples)\n\n[Slider with custom step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23slider-with-custom-step)[Accessible Slider with aria-value-text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23accessible-slider-with-aria-value-text)[Slider with custom value labels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23slider-with-custom-value-labels)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23design-tokens)\n\n[Design tokens: Thumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23design-tokens-thumb)[Design tokens: Absolute values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23design-tokens-absolute-values)[Design tokens: Value label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23design-tokens-value-label)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23props)\n\n[Range](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23range)[RangeLabel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23rangelabel)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%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/slider.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-slider/docs/guides/faststore/atoms-slider%23usage)\n\n[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23import-the-component)[Import Styles into your FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23import-styles-into-your-faststore-project)\n\n[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23examples)\n\n[Slider with custom step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23slider-with-custom-step)[Accessible Slider with aria-value-text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23accessible-slider-with-aria-value-text)[Slider with custom value labels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23slider-with-custom-value-labels)\n\n[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23design-tokens)\n\n[Design tokens: Thumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23design-tokens-thumb)[Design tokens: Absolute values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23design-tokens-absolute-values)[Design tokens: Value label](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23design-tokens-value-label)\n\n[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23data-attributes)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23props)\n\n[Range](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23range)[RangeLabel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%23rangelabel)\n\n[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-slider/docs/guides/faststore/atoms-slider%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_0ce17899
|
[
{
"role": "system",
"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 result 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-result/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-result/docs/api-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-result/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-result/docs/storefront-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-result/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-result/docs/troubleshooting)\n\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-result/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-result/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/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-result/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-result/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-result/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-result/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-result/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-result/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-result/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-result/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/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-result/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-result/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/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-result/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-result/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-result/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-result/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-result/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-result/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-result/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-result/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/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-result/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-result/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-result/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/guides/basic-components)\n\nSearch Result\n\nOfficial extension\n\nVersion: 3.143.0\n\nLatest version: 3.143.0\n\n[](#contributors-)\n\nThe Search Result app handles the results returned by the [VTEX Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/search-overview) and displays them to users.\n\nThe app exports all store blocks expected on a search results page, such as the filters and the product gallery.\n\n\n\n## Configuration\n\nTo configure the VTEX Search Result, follow the instructions below.\n\n### Adding the Search Result app to your theme's dependencies\n\nIn your theme's `manifest.json`, add the Search Result app as a dependency:\n\n```json\n\"dependencies\": {\n \"vtex.search-result\": \"3.x\"\n}\n\n```\n\nNow, you can use all the blocks exported by the `search-result` app. See the complete list below:\n\n#### `search-result` blocks\n\n| Block name | Description |\n| -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| search-result-layout | Builds the search result page using its three children blocks: search-result-layout desktop, search-result-layout.mobile, and search-not-found-layout. Use it in the store.search template, as it uses context from the VTEX Search API. |\n| search-result-layout.customQuery | Use this block instead of search-result-layout when the search result is declared in a template that doesn't fetch Search context, such as Home. It accepts a querySchema prop that executes search custom queries. It also supports three children blocks: search-result-layout.desktop, search-result-layout.mobile, and search-not-found-layout. |\n| search-result-layout.desktop | Builds the search result page structure for desktop mode. |\n| search-result-layout.mobile | Builds the search result page structure for mobile mode. If search-result-layout.mobile isn't provided, search-result-layout.desktop is used. |\n| search-layout-switcher | Enables mobile users to switch between layout modes. |\n| search-not-found-layout | Builds the entire search results page structure for scenarios where no result was found. It renders when users search for a term that doesn't return a product. |\n| gallery | Displays the gallery with all the products found in the search. |\n| gallery-layout-switcher | Allows users to switch between available gallery layouts. Learn more in the guide [Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts). |\n| gallery-layout-option | Defines how each layout option renders for users. Learn more in the guide [Building a search results page with multiple layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts). |\n| not-found | Contains text and a description for a page not found in the search. Declare it as a child of search-not-found-layout. |\n| search-content | Decides, behind the scenes, which block to display: either the gallery block (if products are found) or the not-found (if selected filters lead to an empty search results page). This means both gallery and not-found must be declared search-content children. |\n| store.not-found#search | When configured, it displays a 404 error message when the server can’t return what the browser's request is, or isn’t configured to handle that request. |\n| search-products-count-per-page | Displays the total number of products on the search results page. |\n| search-products-progress-bar | Displays a progress bar of products on the search results page. |\n| order-by.v2 | Allows users to choose the product order on the search results page. |\n| filter-navigator.v3 | Allows users to apply different filters to the search. On mobile, it renders a button that, when clicked, displays all available filters in a sidebar. |\n| total-products.v2 | Displays the total number of products found for that search. |\n| search-title.v2 | Displays a title for the performed search. |\n| search-fetch-more | Displays the **Show more** button. This button doesn't render when the user is on the last page. |\n| search-fetch-previous | Displays the **Show previous** button. This button doesn't render when the user is on the first page. |\n| sidebar-close-button | Displays an X button on the filter sidebar on mobile. |\n\n## Adding the Search Result to page templates\n\nSearch Result app data usually displays on search pages (`store.search`), but you can add it to any other page.\n\nWhen adding to the search page, use the `search-result-layout`, which fetches data from the template's current search context. To add the app to another page, use the [search-result-layout.customQuery](#search-result-blocks) block.\n\nOn the desired store page, add the `search-result-layout` block or the `search-result-layout.customQuery` to the correct template blocks list. Check both codes below as examples.\n\nOn search pages:\n\n```json\n\"store.search\": {\n \"blocks\": [\"search-result-layout\"]\n}\n\n```\n\nOn other pages:\n\n```diff\n\"store.home\": {\n \"blocks\": [\n \"carousel#home\",\n \"shelf#home\",\n + \"search-result-layout.customQuery#home\"\n ]\n}\n\n```\n\n### Defining how the search query data should be fetched\n\nBefore declaring the blocks into the search results layout, define how the search results will be fetched.\n\nYou should define these results through a custom query on the homepage. On the search template, use the already provided context.\n\nIf you use `search-result-layout`, the blocks define the fetched data from the `context`. If you use `search-result-layout.customQuery`, send the props through the `querySchema` to configure the custom query.\n\nUsing `search-result-layout`:\n\n```json\n{\n \"store.search\": {\n \"blocks\": [\"search-result-layout\"],\n \"props\": {\n \"context\": {\n \"skusFilter\": \"FIRST_AVAILABLE\",\n \"simulationBehavior\": \"default\"\n }\n }\n }\n}\n\n```\n\nUsing `search-result-layout.customQuery`:\n\n```json\n{\n \"store.home\": {\n \"blocks\": [\n \"carousel#home\",\n \"shelf#home\",\n \"search-result-layout.customQuery#home\"\n ]\n },\n \"search-result-layout.customQuery#home\": {\n \"props\": {\n \"querySchema\": {\n \"skusFilter\": \"FIRST_AVAILABLE\",\n \"simulationBehavior\": \"default\"\n }\n }\n }\n}\n\n```\n\nCheck all props to configure your search data in the table below.\n\n### The `context` and `querySchema` props\n\n| Prop name | Type | Description | Default value |\n| ---------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------ |\n| queryField | string | Query string of the search URL that defines the results to fetch in the custom query. Example: Blue. This prop only works if mapField is also declared. | undefined |\n| mapField | string | Search URL's map parameter to define which results to fetch in the custom query. Example: specificationFilter\\_100. This prop only works if the queryField prop is also declared. | undefined |\n| maxItemsPerPage | number | Maximum number of items per search page. The maximum value of this prop is 50. If a higher number is added, the query will fail. | 10 |\n| orderByField | enum | Determines the order products follow when displayed. Possible values are named after the sorting type: OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, OrderByNameDESC, or OrderByTopSaleDESC. ASC and DESC stand for ascending order and descending order, respectively, based on the position of each value's corresponding code in the [ASCII table](https://read.calvincode.net/reader?url=http://www.asciitable.com/). OrderByTopSaleDESC considers the number of units sold of the product in the past 90 days, taking into account only ecommerce orders (no physical store orders) from order-placed events (Example: Without checking if the payment was approved). If the store has an app, it's possible to consider events from the app — provided they're implemented on the store's side, as they aren't enabled by default. If the shopper has an ad-blocking extension or a browser restriction that disables sending events, their navigation won't be counted.If not set to any of the mentioned values, the fallback behavior is sorting by [relevance settings](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/1qlObWIib6KqgrfX1FCOXS). OrderByScoreDESC is **not** a valid value for this prop. | \"\" |\n| hideUnavailableItems | boolean | Determines whether the search result 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| facetsBehavior | string | Defines the filters' behavior. When set to Dynamic, results are restricted according to the filters the user selected. If set to Static, all filters continue to display to the user, even if there are no results. | Static |\n| skusFilter | enum | Refines the SKUs returned for each product in the query. Fewer returned SKUs result in a more performant shelf query. Available value: FIRST\\_AVAILABLE (returns only the first available SKU), ALL\\_AVAILABLE (returns all available SKUs), and ALL (returns all product SKUs). | ALL\\_AVAILABLE |\n| simulationBehavior | enum | Defines whether the search data will be up-to-date (default) or fetched using the cache (skip). Use the last option only if you prefer faster queries over the most up-to-date prices or inventory. | default |\n| installmentCriteria | enum | Defines which price to display when different installments are available. Possible values: MAX\\_WITHOUT\\_INTEREST (displays the maximum installment option with no interest attached) or ´MAX\\_WITH\\_INTEREST\\` (displays the maximum installment option, whether it has interest attached or not). | \"MAX\\_WITHOUT\\_INTEREST\" |\n| excludedPaymentSystems | string | List of payment systems not to consider when displaying installment options to users. This prop works only if installmentCriteria is also declared. Otherwise, all available payment systems display regardless. | undefined |\n| includedPaymentSystems | string | List of payment systems to consider when displaying installment options to users. This prop works only if installmentCriteria is also declared. Otherwise, all available payment systems display regardless. | undefined |\n\n> Pagination doesn't display results after page 50\\. You can configure it to display more products per page by increasing the number of products on each page using the `maxItemsPerPage` prop.\n\n> When the `simulationBehavior` prop is set as `skip`, it defines that the search data should only be fetched using the store's cache. This may impact the content displayed on store pages, as cache storage changes based on user interaction on each page.\n\nYou must define the query for the following search pages:\n\n* Brand\n* Department\n* Category\n* Subcategory\n\nThis allows you to define custom behaviors for your store's search pages. For example:\n\n```json\n{\n \"store.search\": {\n \"blocks\": [\"search-result-layout\"],\n \"props\": {\n \"context\": {\n \"skusFilter\": \"FIRST_AVAILABLE\",\n \"simulationBehavior\": \"default\"\n }\n }\n },\n \"store.search#category\": {\n \"blocks\": [\"search-result-layout\"],\n \"props\": {\n \"context\": {\n \"skusFilter\": \"FIRST_AVAILABLE\",\n \"simulationBehavior\": \"default\"\n }\n }\n },\n \"store.search#brand\": {\n \"blocks\": [\"search-result-layout\"],\n \"props\": {\n \"context\": {\n \"skusFilter\": \"FIRST_AVAILABLE\",\n \"simulationBehavior\": \"default\"\n }\n }\n },\n \"store.search#department\": {\n \"blocks\": [\"search-result-layout\"],\n \"props\": {\n \"context\": {\n \"skusFilter\": \"FIRST_AVAILABLE\",\n \"simulationBehavior\": \"default\"\n }\n }\n },\n \"store.search#subcategory\": {\n \"blocks\": [\"search-result-layout\"],\n \"props\": {\n \"context\": {\n \"skusFilter\": \"FIRST_AVAILABLE\",\n \"simulationBehavior\": \"default\"\n }\n }\n }\n}\n\n```\n\n### Defining your search results page's layout and behavior\n\nNow you can structure the `search-result-layout` or the `search-result-layout.customQuery` blocks. Both require the `search-result-layout.desktop` as a child. You can also provide props to other children, such as `search-result-layout.mobile` and `search-not-found-layout`.\n\nDepending on your store's scenario, structure the `search-result-layout` or the `search-result-layout.customQuery` by declaring their children and then configuring them using the [Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-flex-layout) blocks and their props. For example:\n\n```json\n{\n \"search-result-layout\": {\n \"blocks\": [\n \"search-result-layout.desktop\",\n \"search-result-layout.mobile\",\n \"search-not-found-layout\"\n ]\n },\n \"search-result-layout.desktop\": {\n \"children\": [\n \"flex-layout.row#searchbread\",\n \"flex-layout.row#searchtitle\",\n \"flex-layout.row#result\"\n ],\n \"props\": {\n \"preventRouteChange\": true\n }\n }\n}\n\n```\n\n#### The `search-result-layout.desktop`, `search-result-layout.mobile`, and `search-not-found-layout` props\n\n| Prop name | Type | Description | Default value |\n| ----------------------- | ------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| hiddenFacets | object | Indicates which filters should be hidden. The possible values are in [this table](#the-hiddenfacets-object). | undefined |\n| showFacetQuantity | boolean | Determines whether the resulting amount in each filter should appear beside its name on the filter-navigator.v3 block (true) or not (false). | false |\n| showFacetTitle | boolean | Determines whether the facet title should appear on the selected filters section on the filter-navigator.v3 block (true) or not (false). | false |\n| blockClass | string | Unique block ID for [CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23using-the-blockclass-property). | undefined |\n| trackingId | string | ID for Google Analytics to track store metrics based on the Search Result block. | Search result |\n| mobileLayout | object | Controls how the search results page displays to users using the mobile layout. Possible values are in [this table](#the-mobilelayout-object). | undefined |\n| defaultGalleryLayout | string | Determines the default name of the gallery layout on the search results page. This prop is required when the gallery block explicitly defines several layouts. This prop's value must match the layout name defined in the name prop from layouts object. | undefined |\n| thresholdForFacetSearch | number | Specifies the minimum number of facets that must be displayed for the search bar to appear. If you declare 0, the search bar always displays. | undefined |\n| preventRouteChange | boolean | Keeps page customizations even when the user applies new filters. This prop only changes the URL's query string rather than the entire URL, preventing a full page reload when filters are applied. | false |\n| showShippingFacet | boolean | Determines whether Shipping filters should display (true) or not (false). | false |\n\n#### The `mobileLayout` object\n\n| Prop name | Type | Description | Default value |\n| --------- | ---- | ------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| mode1 | enum | Defines the default layout for the mobile search results page. Possible values: normal, small, or inline. | normal |\n| mode2 | enum | Defines which layout sets for the mobile search results page when users click the layout selector button. Possible values are also normal, small, or inline. | small |\n\n#### The `hiddenFacets` object\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| brands | boolean | Determines whether Brand filters should be hidden (true) or not (false). | false |\n| categories | boolean | Determines whether Category filters should be hidden (true) or not (false). | false |\n| priceRange | boolean | Determines whether Price filters should be hidden (true) or not (false). | false |\n| specificationFilters | object | Indicates which specification filters should be hidden. Possible values are in [this table](#the-specificationfilters-object). | undefined |\n\n#### The `specificationFilters` object\n\n| Prop name | Type | Description | Default value |\n| ------------- | ------- | ---------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| hideAll | boolean | Determines whether specification filters should be hidden (true) or not (false). | false |\n| hiddenFilters | object | Object array of specification filters that should be hidden. Possible values are in [this table](#the-hiddenfilters-object). | undefined |\n\n#### The `hiddenFilters` object\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------------------------------------------------- | ------------- |\n| name | string | Defines the name of the specification filter that you want to hide. | undefined |\n\n### Using the Flex Layout to build your search results page\n\nYou can build your search results page with the [Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-flex-layout) app and the other blocks exported by the Search Results app, such as the `gallery`.\n\nBelow are the available blocks to build your store's search results page and their existing props.\n\n#### The `gallery` block\n\nThe `gallery` block defines how fetched items display on the store's search results page.\n\nWhen declared with no props, it expects the [product-summary.shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary) as a child and consequently the block structure inherited from it.\n\nHowever, you can use the `layouts` prop to provide several layouts for the page, allowing your store to arrange items that best fit your users' needs.\n\nIn a scenario where multiple layouts are provided, your store users will be able to shift between them according to their needs using the `gallery-layout-switcher` block, described in [the table below](#the-gallery-layout-switcher-props). The `gallery` will then render the component provided by the currently selected layout.\n\nLearn more in [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).\n\n##### The `gallery-layout-switcher` props\n\n| Prop name | Type | Description | Default value |\n| --------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |\n| layouts | object | Arranges and displays items on the search results page. If no value is provided, the gallery block must receive a product-summary-shelf block as a child. Check [this table](#the-layouts-object) for props of this block. | undefined |\n| undefined | block | Defines which blocks should reder per layout. The prop name is not undefined, you must include the value passed on the component prop. This prop's value must match the block name you choose to render in that specific layout. | undefined |\n| customSummaryInterval | number | Defines the item interval at which the **Gallery** should render a custom product-summary block. For example, declaring 5 renders a custom block at every four items rendered, as shown [on this image](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/1207017/101687291-0cff1780-3a49-11eb-9c00-678b70001c8a.jpg). This prop doesn't support layouts yet. | undefined |\n| CustomSummary | block | Defines a block to render according to the interval defined by the customSummaryInterval prop. | undefined |\n| preferredSKU | PreferredSKUEnum | Controls which SKU will initially be selected in the product summary. | \"FIRST\\_AVAILABLE\" |\n\nFor `PreferredSKUEnum`:\n\n| Name | Value | Description |\n| --------------- | ---------------- | -------------------------------------------------------------- |\n| First Available | FIRST\\_AVAILABLE | First available SKU in stock found or first SKU without stock. |\n| Last Available | LAST\\_AVAILABLE | Last available SKU in stock found or last SKU without stock. |\n| Cheapest | PRICE\\_ASC | Cheapest SKU in stock found or first SKU without stock. |\n| Most Expensive | PRICE\\_DESC | Most expensive SKU in stock found or first SKU without stock. |\n\n> To select which SKU should take preference over this prop, you can create a product specification (field) and, for each product, assign the value of the desired SKU to be initially selected. If the specification doesn't exist or the value is empty, it will use the `preferredSKU` prop as a fallback. Learn more in [Recipes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-implementation).\n\n##### The `layouts` object\n\n| Prop name | Type | Description | Default value |\n| ----------- | --------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| name | string | Specifies the layout name. This value must be unique. For example, not equal to other layout names declared in the gallery block. | undefined |\n| component | string | Names the undefined prop from the gallery block, which declares the block to render in this layout. This prop's value can be anything as long as it's PascalCased, meaning the first letter of each word in its name is capitalized. **Caution**: For this to work, the chosen value must be named after the gallery block's undefined prop. _Don’t use the component prop's value to directly pass the desired block name itself_. See the example below to understand the underlying logic behind this prop. | undefined |\n| itemsPerRow | number / object | Specifies the number of items to display in each row of this layout. This prop works with [responsive values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.responsive-values/), so it also accepts an object with different numbers for desktop, tablet, or phone screen sizes (_see the table below_). | undefined |\n\n##### The `itemsPerRow` object\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | -------------------------------------------- | ------------- |\n| desktop | number | Number of slides to show on desktop devices. | undefined |\n| tablet | number | Number of slides to show on tablet devices. | undefined |\n| phone | number | Number of slides to show on phone devices. | undefined |\n\n##### Example of a `gallery` block\n\n```json\n{\n \"gallery\": {\n \"props\": {\n \"layouts\": [\n {\n \"name\": \"whole\",\n \"component\": \"OneOrTwoLineSummary\",\n \"itemsPerRow\": 1\n },\n {\n \"name\": \"two\",\n \"component\": \"OneOrTwoLineSummary\",\n \"itemsPerRow\": 2\n },\n {\n \"name\": \"many\",\n \"component\": \"ManyByLineSummary\",\n \"itemsPerRow\": {\n \"desktop\": 5,\n \"mobile\": 1\n }\n }\n ],\n \"OneOrTwoLineSummary\": \"product-summary.shelf\",\n \"ManyByLineSummary\": \"product-summary.shelf\"\n }\n }\n}\n\n```\n\n#### The `gallery-layout-switcher` block\n\nThe `gallery-layout-switcher` block is a logical block that allows users to switch between the available `gallery` layouts.\n\nIt receives no props and expects [the gallery-layout-option block](#the-gallery-layout-option-block) as a child. For the accessibility features to work correctly, define the options in the same order as the layouts.\n\n#### The `gallery-layout-option` block\n\nThis block defines how each layout option renders for users.\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| name | string | Specifies the name of the layout option. This prop's value must match the one passed to the [name prop](#the-layouts-object). | undefined |\n\n##### Example of the `gallery-layout-switcher` and the `gallery-layout-option` blocks\n\n```jsonc\n{\n \"gallery-layout-switcher\": {\n \"children\": [\n //It follows the same whole -> two -> many order\n \"gallery-layout-option#whole\",\n \"gallery-layout-option#two\",\n \"gallery-layout-option#many\"\n ]\n },\n \"gallery-layout-option#whole\": {\n \"props\": {\n \"name\": \"whole\"\n },\n \"children\": [\"icon-single-grid\", \"rich-text#option-whole\"]\n },\n \"gallery-layout-option#two\": {\n \"props\": {\n \"name\": \"two\"\n },\n \"children\": [\"icon-inline-grid\", \"rich-text#option-two\"]\n },\n \"gallery-layout-option#many\": {\n \"props\": {\n \"name\": \"many\"\n },\n \"children\": [\"icon-menu\", \"rich-text#option-many\"]\n }\n}\n\n```\n\n#### `filter-navigator.v3` block\n\nThis block renders a filter selector for the fetched results.\n\n| Prop name | Type | Description | Default value |\n| ------------------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| categoryFiltersMode | enum | Determines whether the category filters use the href attribute with category page URLs (href) or not (default). By default, the filters use HTML divs with role=\"link\". Setting this prop's value to href creates a link, which can improve the SEO ranking of your category pages. | default |\n| layout | enum | Determines whether the **Filter Navigator** layout is responsive (responsive) or not (desktop). You can use desktop when the **Filter Navigator** is configured to display in a [drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-drawer). | responsive |\n| maxItemsDepartment | number | Specifies the maximum number of departments to display before the **See more** button triggers. | 8 |\n| maxItemsCategory | number | Specifies the maximum number of category items to display before the **See more** button triggers. | 8 |\n| initiallyCollapsed | boolean | Makes the search filters start collapsed (true) or open (false). | false |\n| openFiltersMode | enum | Defines how many filters can open simultaneously on the **Filter Navigator** component. Possible values are many (more than one filter can open simultaneously) and one (only one filter can open). If one is declared, all filters collapse before user interaction, regardless of the initiallyCollapsed prop's value. | many |\n| filtersTitleHtmlTag | string | Specifies the HTML tag for the filter's title. | h5 |\n| scrollToTop | enum | Scrolls the page to the top (auto or smooth) or not (none) when selecting a facet. | none |\n| truncateFilters | boolean | Determines whether a filter selector with more than 10 filter options shortens the list and displays a **See more** button (true) or not (false). | false |\n| closeOnOutsideClick | boolean | Determines whether the **Filter Navigator** component closes when users click outside of it (true) or not (false). This prop only works if the openFiltersMode prop is set to one. | false |\n| appliedFiltersOverview | enum | Determines whether an overview of the applied filters displays (show) or not (hide). | hide |\n| totalProductsOnMobile | enum | Determines whether the **Filter Navigator** displays the total number of products on mobile devices (show) or not (hide). | hide |\n| fullWidthOnMobile | boolean | Determines whether the filter-navigator.v3 renders on mobile using the full screen width (true) or not (false). | false |\n| navigationTypeOnMobile | enum | Defines how mobile users should navigate on the filter selector component. Possible values are page (only one list of options can be seen at a time) or collapsible (all lists of options can be seen simultaneously). | page |\n| updateOnFilterSelectionOnMobile | boolean | Determines whether search results on mobile update based on the filter selection (true) or not (false). This prop only works if the preventRouteChange prop is declared as true. | false |\n| drawerDirectionMobile | Enum | Determines whether search filters on mobile open to the left (drawerLeft) or to the right (drawerRight). | drawerLeft |\n| showClearByFilter | boolean | Determines whether a clear button (which erases all selected filter options) displays alongside the filter name (true) or not (false). | false |\n| showClearAllFiltersOnDesktop | boolean | Determines whether a clear button displays (true) or not (false). This button resets all selected filters. | false |\n| priceRangeLayout | enum | Determines whether a text field for entering the desired price range displays (inputAndSlider) or not (slider). | slider |\n| facetOrdering | array | Applies custom sorting rules for filters. The default behavior sorts items by quantity, in descending order. | undefined |\n| showQuantityBadgeOnMobile | boolean | Displays a badge for mobile users indicating how many active filters there are. | false |\n\n* **`facetOrdering` object:**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| key | string | Specifies the facet key to sort. Possible values are category-1, category-2, category-3 (for department, category, and subcategory), brand, or a product specification name. | undefined |\n| orderBy | enum | Specifies the field from facets to use when sorting entries. Possible values are name and quantity. | undefined |\n| order | enum | Determines whether the filter should sort by ascending (ASC) or descending (DESC) order. | ASC |\n\nFor example:\n\n```jsonc\n{\n \"filter-navigator.v3\": {\n \"props\": {\n \"facetOrdering\": [\n {\n \"key\": \"brand\",\n \"orderBy\": \"name\",\n \"order\": \"ASC\"\n }\n ]\n }\n }\n}\n\n```\n\n> The `facetOrdering` prop conflicts with the `enableFiltersFetchOptimization` flag on `vtex.store`, as it returns only the top filter values ordered by count. To achieve the desired outcome with `facetOrdering`, set `enableFiltersFetchOptimization` as `false` in your `vtex.store` Admin settings.\n\n#### The `order-by` block\n\nThe `order-by` block renders a dropdown button with [sorting options](#the-sorting-options-for-the-order-by-block) to display the fetched results. See the block props in the table below.\n\n##### The `order-by` props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| specificationOptions | \\[object\\] | Indicates which sorting options by specification will be displayed. This only works for stores using vtex.search-resolver@1.x | undefined |\n| hiddenOptions | \\[string\\] | Indicates which sorting options will be hidden. Example: \\[\"OrderByNameASC\", \"OrderByNameDESC\"\\] | undefined |\n| showOrderTitle | boolean | Determines whether the selected order value (example: Relevance) displays (true) or not (false). | true |\n\n* **`specificationOptions` Object:** \n| Prop name | Type | Description | Default value | \n| --------- | ------ | -------------------------------------------------------------------------------------------------------------------------------------- | ------------- | \n| value | string | Value sent for sorting in the API. It must be in the format {specification key}:{asc/desc}. Example: \"size:desc\" or \"priceByUnit:asc\". | undefined | \n| label | string | Label that displays in the sorting options. Example: \"Price by unit, ascending\" | undefined |\n\n##### Sorting options for the `order-by` block\n\n| Sorting option | Value |\n| ------------------------ | ------------------------- |\n| Relevance | \"\" |\n| Top Sales Descending | \"OrderByTopSaleDESC\" |\n| Release Date Descending | \"OrderByReleaseDateDESC\" |\n| Best Discount Descending | \"OrderByBestDiscountDESC\" |\n| Price Descending | \"OrderByPriceDESC\" |\n| Price Ascending | \"OrderByPriceASC\" |\n| Name Ascending | \"OrderByNameASC\" |\n| Name Descending | \"OrderByNameDESC\" |\n| Collection | \"OrderByCollection\" |\n\n#### The `search-fetch-more` block\n\nThe `search-fetch-more` block renders a `Show more` button that loads the following search results page. See the block props in the table below.\n\n> This block doesn't render if there is no next page.\n\n##### The `search-fetch-more` prop\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| htmlElementForButton | enum | Specifies which HTML element displays for the Show more button component. Possible values: a (displays a <a> element with href and rel attributes) or button (displays a <button> element without href and rel attributes). | button |\n\n#### The `search-fetch-previous` block\n\nThe `search-fetch-previous` block renders a `Show previous` button that loads the previous search results page. See the block props in the table below.\n\n> This block doesn't render if there is no previous page.\n\n##### The `search-fetch-previous` prop\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| htmlElementForButton | enum | Specifies which HTML element displays for Show previous button component. Possible values: a (displays a <a> element with href and rel attributes) or button (displays a <button> element without href and rel attributes). | button |\n\n#### The `search-products-count-per-page` block\n\nThe `search-products-count-per-page` block shows the product count per search page. When declared, this block doesn't need any props.\n\n#### The `search-products-progress-bar` block\n\nThe `search-products-progress-bar` block shows a progress bar of search results. When declared, this block doesn't need any props.\n\n#### The `sidebar-close-button` block\n\nThe `sidebar-close-button` block is the `Close` button rendered on the top right of the mobile filter sidebar.\n\n##### The `sidebar-close-button` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | ------------------------ | ------------- |\n| size | number | Size of the button icon. | 30 |\n| type | string | Type of the button icon. | line |\n\n## Customization\n\nTo apply CSS customization in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-search-results-page-with-multiple-layouts).\n\n| CSS handles |\n| ------------------------------------ |\n| accordionFilter |\n| accordionFilterContainer |\n| accordionFilterContent |\n| accordionFilterItemActive |\n| accordionFilterItemBox |\n| accordionFilterItemHidden |\n| accordionFilterItemIcon |\n| accordionFilterItemOptions |\n| accordionFilterItemTitle |\n| accordionFilterItem |\n| accordionFilterOpen |\n| accordionSelectedFilters |\n| border |\n| breadcrumb |\n| buttonShowMore |\n| categoriesContainer |\n| categoryGroup |\n| categoryParent |\n| clearAllFilters |\n| container |\n| dropdownMobile |\n| filter |\n| filterAccordionBreadcrumbs |\n| filterBreadcrumbsContent |\n| filterBreadcrumbsText |\n| filterBreadcrumbsItem |\n| filterBreadcrumbsItemName |\n| filterAccordionItemBox--{facetValue} |\n| filterApplyButtonWrapper |\n| filterAvailable |\n| filterIsOpen |\n| filterButtonsBox |\n| filterClearButtonWrapper |\n| filterContainer--{facetType} |\n| filterContainer--b |\n| filterContainer--c |\n| filterContainer--priceRange |\n| filterContainer--{selectedFilters} |\n| filterContainer--{title} |\n| filterContainer |\n| filterIcon |\n| filterItem--{facetValue} |\n| filterItem--selected |\n| filterItem |\n| filterMessage |\n| filterPopup |\n| filterPopupArrowIcon |\n| filterPopupButton |\n| filterPopupContent |\n| filterPopupContentContainer |\n| filterPopupContentContainerOpen |\n| filterPopupFooter |\n| filterPopupOpen |\n| filterPopupTitle |\n| filterSelected |\n| filterSelectedFilters |\n| filterTotalProducts |\n| filtersWrapper |\n| filtersWrapperMobile |\n| filterTemplateOverflow |\n| filterTitle |\n| filterTitleSpan |\n| footerButton |\n| galleryItem |\n| galleryItem--custom |\n| galleryItem--{displayMode} |\n| galleryTitle |\n| gallery |\n| galleryLayoutSwitcher |\n| galleryLayoutOptionButton |\n| layoutSwitcher |\n| loadingOverlay |\n| loadingSpinnerInnerContainer |\n| loadingSpinnerOuterContainer |\n| orderByButton |\n| orderByDropdown |\n| orderByOptionItem |\n| orderByOptionItem--selected |\n| orderByOptionsContainer |\n| orderByText |\n| orderBy |\n| productCount |\n| progressBarContainer |\n| progressBar |\n| progressBarFiller |\n| resultGallery |\n| searchNotFoundInfo |\n| searchNotFoundOops |\n| searchNotFoundTerm |\n| searchNotFoundTextListLine |\n| searchNotFoundWhatDoIDo |\n| searchNotFoundWhatToDoDotsContainer |\n| searchNotFoundWhatToDoDots |\n| searchNotFound |\n| searchResultContainer |\n| seeMoreButton |\n| selectedFilterItem |\n| showingProductsContainer |\n| showingProductsCount |\n| showingProducts |\n| switch |\n| totalProductsMessage |\n| totalProducts |\n\n[DidYouMean« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search/didyoumean)[Store ImageNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.store-image)\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.search-result/docs/apps/vtex.search-result%23configuration)\n\n[Adding the Search Result app to your theme's dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search-result%23adding-the-search-result-app-to-your-themes-dependencies)\n\n[Adding the Search Result to page templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search-result%23adding-the-search-result-to-page-templates)\n\n[Defining how the search query data should be fetched](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search-result%23defining-how-the-search-query-data-should-be-fetched)[The context and querySchema props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search-result%23the-context-and-queryschema-props)[Defining your search results page's layout and behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search-result%23defining-your-search-results-pages-layout-and-behavior)[Using the Flex Layout to build your search results page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search-result%23using-the-flex-layout-to-build-your-search-results-page)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result/docs/apps/vtex.search-result%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_02f95fde
|
[
{
"role": "system",
"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 shelf 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.shelf/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/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.shelf/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.shelf/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/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.shelf/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.shelf/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.shelf/docs/vtex-io-apps)\n\nShelf\n\nOfficial extension\n\nVersion: 1.49.0\n\nLatest version: 1.49.0\n\n> With the goal of displaying a flexible product list, the `shelf` and `shelf.relatedProducts` blocks are deprecated and now configured using the [Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist), the [Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary), and the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout) blocks. To learn how to configure it, please refer to [Building a Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-building-a-shelf).\n\nThe Shelf app displays a list of products on your store pages, helping you build your shop window and work on your visual merchandising.\n\n\n\n## Configuration\n\n1. Add the `shelf` app to your theme dependencies in the `manifest.json` file:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.shelf\": \"1.x\", \n\n3\n\n } \n\n`\n\nNow, you can use all the blocks exported by the `shelf` app. See the full list below:\n\n| Block name | Description |\n| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| shelf |  Renders a list of products in the store home page. |\n| shelf.relatedProducts |  Renders a list of related products in the product details page. |\n\n1. Declare the `shelf.relatedProduct` in the product template (`store.product`) using its props. For example:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"breadcrumb\", \n\n5\n\n \"flex-layout.row#main\", \n\n6\n\n \"shelf.relatedProducts\" \n\n7\n\n ] \n\n8\n\n } \n\n9\n\n} \n\n`\n\n> Warning\n> \n> Note that for hiding unavailable/out-of-stock items, there are 2 different props: `hideUnavailableItems` and `hideOutOfStockItems`. They do the same thing, but each is used by a different component: `Shelf` and `RelatedProducts`, respectively.\n\n### Shelf\n\n| Prop name | Type | Description | Default value |\n| ------------------------ | ----------------- | --------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| category | String | The category ID | |\n| collection | String | The collection ID | |\n| orderBy | Enum | OrderByTopSaleDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, OrderByNameDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC | |\n| hideUnavailableItems | Boolean | Whether out of stock items should be hidden (true) or not (false) | false |\n| paginationDotsVisibility | Enum | visible, hidden, mobileOnly, desktopOnly | |\n| productList | ProductListSchema | Product list schema. See ProductListSchema | \\- |\n| trackingId | String | Name to show in the Google Analytics. If nothing is passed it will use the name of the block instead | |\n| maxItems | Number | Max items | |\n\n### RelatedProducts\n\n| Prop name | Type | Description | Default value |\n| ------------------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| recommendation | enum | Type of recommendations that will be displayed on the shelf. Possible values: similars, suggestions, and accessories (these depend on the product information given in the Admin Catalog); and view, buy, and viewandBought (these are automatically generated according to the activity of the store). | similars |\n| groupBy | enum | Defines if you are ot nog going to group your recommendations by: PRODUCT (only display individual products and not SKUs, limited by 12 products) or NONE (if you want to display all registered SKUs, limited by 50 products). | PRODUCT |\n| hideOutOfStockItems | boolean | Whether out of stock items should be hidden: (true) or (false). | false |\n| productList | ProductListSchema | Product list schema. See ProductListSchema. | \\- |\n\n`ProductListSchema`:\n\n| Prop name | Type | Description | Default value |\n| --------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| maxItems | number | Maximum number of items to be displayed on the related product shelf. | 10 |\n| scroll | enum | Slide transition scroll type. Possible values: BY\\_PAGE, and ONE\\_BY\\_ONE. | BY\\_PAGE |\n| arrows | boolean | Whether the arrows should be displayed on the shelf (true) or not (false). | true |\n| showTitle | boolean | Whether a title should be displayed on the product-related shelf (true) or not (false). | true |\n| titleText | string | Related product shelf title. | null |\n| gap | enum | Space between items being displayed. Possible values are: ph0, ph3,ph5, and ph7. | ph3 |\n| minItemsPerPage | number | Minimum number of items per shelf slides. This prop defines how many items will be displayed on the related product shelf, even in the smallest screen size. Its value can be a float, which means that you can choose a multiple of 0.5 to indicate that you want to show a _peek_ of the next slide on the shelf. | 1 |\n| itemsPerPage | number | Maximum number of items per shelf slides. This prop defines how many items will be displayed on the related product shelf, even in the largest screen size. Its value can be a float, which means that you can choose a multiple of 0.5 to indicate that you want to show a _peek_ of the next slide on the shelf. | 5 |\n| summary | object | Schema declaring the desired related product shelf items. This prop object must contain the [product-summary.shelf block props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary%23configuration). | undefined |\n| ' infinite | boolean | Determines whether the list should be infinite (true) or not (false). When this prop is set as false, the slider will have an explicit end for users. | true |\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| relatedProducts |\n\n> The CSS Handles list above refers to the `shelf.relatedProducts` block. Since the `shelf` block is deprecated, your shelf customization must be done using the CSS Handles available for the [Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarylist), the [Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary), and the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-slider-layout) blocks.\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.shelf/docs/apps/vtex.shelf%23configuration)\n\n[Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/apps/vtex.shelf%23shelf)[RelatedProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/apps/vtex.shelf%23relatedproducts)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf/docs/apps/vtex.shelf%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_1a47418c
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration price update in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-guide)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update)\n\nHow to keep prices updated\n\nLearn how to keep integrated products updated with price and inventory level information. Before you start, check out what’s included in the product update flow:\n\n| Included | Not Included |\n| ---------------------------------------------------------------- | --------------------------------------------------------------------- |\n| Prices defined in the VTEX main account | Prices defined in third party sellers or franchise accounts |\n| Prices updated directly to the marketplace integration | |\n| Inventory levels defined in the main account | Inventory levels defined in third party sellers or franchise accounts |\n| Inventory levels updated directly to the marketplace integration | |\n\n## How to configure the affiliate endpoint\n\nTo use this flow, the connector should provide an endpoint according to the standard:\n\n`https://{endpointDoAfiliado}/api/notification/`\n\nThis endpoint should be configured in the VTEX affiliate registration page. Check out our [Configuring an Affiliate](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-affiliates--tutorials%5F187) article.\n\n## VTEX Notification\n\nWhenever the seller updates a product or SKU in VTEX, a notification will be sent through the url configured in the section above. The table below presents the fields sent in this notification’s payload. The connector should use this data to implement the new product registration flow, described in the scenarios that will follow.\n\n### Fields sent in the notification\n\n| Name | Description |\n| --------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| idSKU | SKU ID in VTEX |\n| productId | Product ID in VTEX |\n| an | Seller’s account name in VTEX, shown in the store’s VTEX Admin url. |\n| idAffiliate | Affiliate ID generated automatically in the configuration. |\n| DateModified | Date when the item was updated |\n| isActive | Identifies whether the product is active or not. In case it is “false”, it means the product was deactivated in VTEX and should be blocked in the marketplace. We recommend that the inventory level is zeroed in the marketplace, and the product is blocked. In case the marketplace doesn’t allow it to be deactivated, the product should be excluded, along with any existing correspondences in the connector. |\n| StockModified | Identifies that the inventory level has been altered. Connectors should send an Fulfillment Simulation request to collect updated information. |\n| PriceModified | Identifies that the price has been altered. Connectors should send an Fulfillment Simulation request to collect updated information. |\n| HasStockKeepingUnitModified | Identifies that the product/SKU registration data has changed, like name, description, weight, etc |\n| HasStockKeepingUnitRemovedFromAffiliate | Identifies that the product is no longer associated with the trade policy. In case the marketplace doesn’t allow it to be deactivated, the product should be excluded, along with any existing correspondences in the connector. |\n\nThe price update flow begins when the connector receives a VTEX Catalog notification, indicating that changes have been made to the SKU or product. Besides the notification mechanism, we recommend using an independent inventory update mechanism, so stocks are always updated. Diagram 1 illustrates the information flow used to keep prices of seller’s SKUs updated in the marketplace integration.\n\n\n\nDiagram 2 illustrates how the price update occurs in the integration \n\n\n\nFollow the steps below to maintain prices updated in the marketplace integration: \n1. Connector validates the VTEX <> Marketplace authentication. In case it has expired, perform the update routine defined in the marketplace’s documentation. Otherwise, connectors should log the error AND put the VTEX notification in a contingency queue.\n2. After receiving the VTEX notification, connectors should: a. Check which store the product belongs to, through the “an” parameter. b. If the `HasStockKeepingUnitModified` is defined as true, the product should be registered or updated in the marketplace. c. Collect details from every SKU using the `/api/catalog_system/pvt/sku/stockkeepingunitbyid/{skuId}?sc={PoliticaComercial}`. d. Validate if the product is active through the [Get Product by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-product) endpoint, through the `isActive` property. e. Validate if the product is associated with the trade policy used in the marketplace integration through the `salesChannel` property. f. Identify whether the SKU conforms to the marketplace’s product registration rules. g. Validate if the product’s category is mapped in the marketplace. \nIn case it is not mapped, the marketplace should put the SKU in the approvement’s queue, until the [mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-mapper%23post-/api/mkp-category-mapper/categories/marketplace/-id-) is complete. h. Use [Fulfillment Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation) (without postalCode) to check if price is configured in the selected trade policy. \n * To collect the product’s price, use the `price` attribute. \n * To collect the sales price configured for that trade policy, use the attribute `salesprice`.\n3. Register operation’s [Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs%23log-messages). Check out [Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs%23content-of-the-messages) for this step.\n\nIf all validations pass, the product or SKU is sent to the marketplace and the operation is logged according to information described in the [Logs made available for users](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs%23log-messages) section.\n\nIf the IDs between VTEX and the marketplace differ, the connector should store both values.\n\n## Recommendations\n\nTo avoid processing gaps due to the big volume of information of the initial load of products, we recommend:\n\n* Using an async messaging architecture, using individual queues by context and store.\n* Creating mechanisms that respect the marketplace API limit rates. We suggest the standard use of the _Circuit Breaker_ integration.\n* In case any of the steps listed above presents failures in communication, we suggest using the contingency mechanism of _deadLetters_.\n* Being TotalReader: whenever possible, in the data transformation process, using standard values accepted by the marketplace, in case the information is not filled or sent by VTEX.\n* In case the marketplace’s processing is in lots - meaning that the connector assembles a group of SKUs, guaranteeing the the limit of records per lot is respected, according to marketplace riles, and sending them to the marketplace at once - it is fundamental to control the lot’s processing, to avoid sending SKU updates without making sure that the product exists in the marketplace.\n* Keeping a states table to know which SKUs have not been integrated with success, attempt date and the response received. This allows the system to use the contingency flow effectively, avoiding infinite loops, and avoiding reaching the request limit.\n\n> Make sure to check out our Recommendations for performing the steps above successfully. Be mindful to make all validations at once, and before the SKU’s publication in the marketplace’s catalog. In case there’s an error detected, the connector presents the seller a list of actions to correct. This way we can avoid the correct - publish - correct cycle.\n\nIf products do not apply to steps a, b and c, an error log must be filed, and the connector should collect the next items on the list obtained by step 2.\n\n## API Reference\n\nUse the endpoints described below to get SKU, price and inventory details. It is important to note that when consuming this API, the connector must have a valid VTEX App Key and App Token. You can also [download our Postman collection](https://read.calvincode.net/reader?url=https://www.getpostman.com/collections/95a809929905a50e2b7b) to access the API. The diagram illustrates the endpoints used in the integration:\n\n\n\n> All parameters in the endpoints below must be declared in the request. In case one of the parameters does not have a value, you must still send it as `null`.[Get list of SKUs associated with a sales channel](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/get%5Fapi-catalog-system-pvt-sku-stockkeepingunitidsbysaleschannel)\n\n[Get details of an SKU associated with a sales channel ](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku)\n\n[Check if product is active](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/productandtradepolicy)\n\n[Simulate price and inventory levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/fulfillment-simulation)\n\n## What VTEX needs to validate the integration flow\n\nTo consider the integration validated by VTEX, the connector should:\n\n1. Follow the step by step of the catalog integration flow.\n2. Check if flows comply with the scenarios described.\n3. Validate log messages contained in the table of Log’s [Content of the messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-logs%23content-of-the-messages).\n4. Perform the performance test to validate response time, and SKU processing time from a set of 5000 SKUs.\n5. Create tutorials for the final user (including text, videos and diagrams), including a step by step guide explaining how the connector created works. The documentation should be published in the production environment with easy access and navigation.\n6. Create a table that shows which data is mandatory and which is recommended when registering products or SKUs, and to improve the offer’s positioning in the marketplace’s storefront.\n7. Create a table with known error logs and actions that the user can do to solve the problem.\n\n> Tables should follow the format below. They will be implemented in the integration according to the connector’s documentation.\n\n### Template table for field mapping\n\n| VTEX field | How to fill it in VTEX | VTEX API | Marketplace field | Transformation | Mandatory | BuyBox |\n| ---------- | ---------------------- | --------------------------------- | ----------------- | ------------------------------------------ | --------- | ------ |\n| Name | Catalog page | /api/catalog/pvt/stockkeepingunit | ShortName | Sent to the marketplace only 50 characters | Yes | Yes |\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-price-update.md)\n\n[Product and Category Mappings« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update//docs/guides/external-marketplace-integration-catalog-mapping)[How to keep stock updatedNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update//docs/guides/external-marketplace-integration-stock-update)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[How to configure the affiliate endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23how-to-configure-the-affiliate-endpoint)\n\n[VTEX Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23vtex-notification)\n\n[Fields sent in the notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23fields-sent-in-the-notification)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23recommendations)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23api-reference)\n\n[What VTEX needs to validate the integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23what-vtex-needs-to-validate-the-integration-flow)\n\n[Template table for field mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23template-table-for-field-mapping)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-price-update.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[How to configure the affiliate endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23how-to-configure-the-affiliate-endpoint)\n\n[VTEX Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23vtex-notification)\n\n[Fields sent in the notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23fields-sent-in-the-notification)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23recommendations)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23api-reference)\n\n[What VTEX needs to validate the integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23what-vtex-needs-to-validate-the-integration-flow)\n\n[Template table for field mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-price-update/docs/guides/external-marketplace-integration-price-update%23template-table-for-field-mapping)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_5768fe8e
|
[
{
"role": "system",
"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 iubenda 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.iubenda/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/api-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.iubenda/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.iubenda/docs/storefront-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.iubenda/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.iubenda/docs/troubleshooting)\n\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.iubenda/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/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.iubenda/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/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.iubenda/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.iubenda/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/guides/pixel-apps)\n\nIubenda\n\nOfficial extension\n\nVersion: 0.3.2\n\nLatest version: 0.3.2\n\n[](#contributors-)\n\nThis is a Iubenda first party integration app. The [solution](https://read.calvincode.net/reader?url=https://www.iubenda.com/en/?utm%5Fsource=adwords%26utm%5Fmedium=ppc%26utm%5Fcampaign=aw%5Fbrand%5Fglobal%5Fexact%26utm%5Fterm=iubenda%26utm%5Fcontent=336331123145%26gclid=EAIaIQobChMI38Tz0Jqg6QIVlwyRCh3KoQtkEAAYASAAEgKtK%5FD%5FBwE) is integrated with the IAB TCF and US Privacy Framework and it is responsible for managing consent preferences for the ePrivacy, GDPR, and CCPAntegrated.\n\n\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/installing-an-app/) the `vtex.iubenda` app;\n2. In your VTEX account's admin, open the **App** section and select the Iubenda App box;\n3. Add the Site ID and the Cookie Policy ID in the respective fields;\n4. Save your changes.\n\n\n\n:information\\_source: _The Site ID and the Cookie Policy ID are provided by Iubenda_.\n\n### Recommended Iubenda configuration\n\n\n\nIubenda also provides a store component to let visitors update their advertising tracking preferences even after closing the cookie banner. Use the [Iubenda Components app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/iubenda-components) for that.\n\n[Idea CRM« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.ideacrm)[JivoChatNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.jivochat)\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.iubenda/docs/apps/vtex.iubenda%23configuration)\n\n[Recommended Iubenda configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.iubenda/docs/apps/vtex.iubenda%23recommended-iubenda-configuration)\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_46c55e2b
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides custom auto capture feature in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/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/custom-auto-capture-feature/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/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/custom-auto-capture-feature/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/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/custom-auto-capture-feature/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/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/custom-auto-capture-feature/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/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/custom-auto-capture-feature/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/payments-integration-guide)\n\n[Custom Auto Capture Feature](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/custom-auto-capture-feature)\n\nCustom Auto Capture Feature\n\nMerchants need flexibility when receiving their payments according to the characteristics and restrictions of their business.\n\nThe VTEX platform allows payment providers to implement a feature that gives merchants the possibility to set a custom delay interval for automatic payment capture.\n\n> If you notice that the fields indicated in this article are not available to your connector, please submit a [request](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/opening-tickets-to-vtex-support--16yOEqpO32UQYygSmMSSAM) to VTEX to update the connector.\n\n## Setting up Custom Auto Capture\n\nTo manage which auto-capture options are available in the connector, the payment provider has access to two fields:\n\n1. **usesAutoSettleOptions**: provides options of capture for merchants. This field must be set to \"true\" in the provider’s connector to allow merchants to access the **Payment capture** field in the VTEX Admin.\n\nThe **Payment capture** field is composed of the following options:\n\n* **Use behavior recommended by the payment processor**: Capture is not automatic; it is scheduled according to the period specified by the acquirer. The acquirer indicates whether the payment has been authorized and can determine or recommend a number of days for the capture upon payment authorization. (This is the platform's default behavior).\n* **Automatic capture immediately after payment authorization**: Capture is automatically performed right after payment authorization, even if the transaction includes an anti-fraud analysis.\n* **Automatic capture immediately after anti-fraud analysis**: Capture is automatically performed right after payment authorization and anti-fraud analysis. If you select this behavior and do not have anti-fraud analysis, the system will perform the payment capture as in _Automatic Capture Immediately After Payment Authorization_.\n* **Disabled**: Capture takes place only when the order is invoiced. If you select this behavior, pay attention to the invoicing time, as invoicing can exceed the capture time agreed with the payment provider and lead to the cancellation of the transaction.\n* **Scheduled: Schedules the automatic capture**: By selecting this option, the field **Scheduled time frame in hours for automatic capture** will be displayed, and it must be completed with the period in which the automatic capture will take place. This period must be in accordance with the limits allowed by the payment provider.\n\n> Enable the `usesAutoSettleOptions` will override any other behavior available for the `earlySecurityCapture` field.\n\n1. **autoSettleDelay**: provides a customized capture option for merchants based on hourly intervals. The \"minimum\" and \"maximum\" interval values must be defined by the provider in their manifest.\n\n\n\nWhen the `usesAutoSettleOptions` field is enabled in the provider’s connector (set to `true`) and the `autoSettleDelay` field is set in the provider's manifest, the **“Scheduled: Schedules The Automatic Capture”** option will be available in the **Payment capture** field when configuring a gateway on the VTEX Admin.\n\nAfter selecting this option, a new field **“Scheduled time frame in hours for automatic capture”** will be displayed. This field is used by the merchant to set the capture time.\n\n\n\n> The merchant can set the capture time only within the range set by the payment provider within their manifest. Its value must be set by the merchant in whole hours (decimals are not allowed).\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/custom-auto-capture-feature.md)\n\n[Layout Development Guide for payment methods in Smart Checkout VTEX« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature//docs/guides/layout-development-guide-for-payment-methods-in-smart-checkout-vtex)[Pix: Instant Payments in BrazilNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature//docs/guides/payments-integration-pix-instant-payments-in-brazil)\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[Setting up Custom Auto Capture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/custom-auto-capture-feature%23setting-up-custom-auto-capture)\n\nWas this helpful?\n\n 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/custom-auto-capture-feature.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Setting up Custom Auto Capture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/custom-auto-capture-feature/docs/guides/custom-auto-capture-feature%23setting-up-custom-auto-capture)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_083c023f
|
[
{
"role": "system",
"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 condition layout 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.condition-layout/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/layout-apps)\n\n[Condition Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout)\n\n[Disclosure Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.disclosure-layout)\n\n[Flex Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.flex-layout)\n\n[Modal Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.modal-layout)\n\n[Overlay Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.overlay-layout)\n\n[Responsive Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.responsive-layout)\n\n[Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.slider-layout)\n\n[Stack Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.stack-layout)\n\n[Sticky Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.sticky-layout)\n\n[Tab Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.tab-layout)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/vtex-io-apps)\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/layout-apps)\n\nCondition Layout\n\nOfficial extension\n\nVersion: 2.8.2\n\nLatest version: 2.8.2\n\n[](#contributors-)\n\nThe Condition Layout app renders a component in your store when predefined conditions are met.\n\n\n\n## Configuration\n\n### Step 1 - Adding the Condition Layout app to your theme dependencies\n\nIn the `manifest.json` file of your theme, add the Condition Layout app as a dependency:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.condition-layout\": \"2.x\" \n\n3\n\n } \n\n`\n\nYou can now use all blocks exported by the `condition-layout` app. See the full list below:\n\n| Block name | Description |\n| ------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| condition-layout.product | Defines the condition logic in the product context and the children blocks that will be rendered when the predefined conditions are met. |\n| condition-layout.binding | Defines the condition logic in the current binding and the children blocks that will be rendered when the predefined conditions are met. |\n| condition-layout.category | Defines the condition logic on the current category or department page and the children blocks that will be rendered when the predefined conditions are met. |\n| condition-layout.telemarketing | Defines the condition logic in the user role (telemarketing) and the children blocks that will be rendered when the predefined conditions are met. |\n\n### Step 2 - Adding the `condition-layout.product` block to your theme templates\n\nIn the product theme template, add the `condition-layout.product` block as a child. For example:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.product\"] \n\n4\n\n }, \n\n`\n\nOr the `condition-layout.binding` block. For example:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.binding\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\nOr the `condition-layout.category` block. For example:\n\n`1\n\n{ \n\n2\n\n \"store.search#my-category-page\": { \n\n3\n\n \"children\": [\"condition-layout.category\"] \n\n4\n\n } \n\n5\n\n} \n\n`\n\n> Never use `condition-layout` directly. Always use it with a context variant, such as `condition-layout.product`.\n\n### Step 3 - Defining the desired conditions\n\nNow it is time to configure the `condition-layout.product` block!\n\n**Use the block props to define your layout condition**. You can also declare blocks of your choice as children of `condition-layout.product`. These children blocks will be rendered if the condition is met.\n\nFor example:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.product#cond1\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.product#cond1\": { \n\n6\n\n+ \"props\": { \n\n7\n\n+ \"conditions\": [ \n\n8\n\n+ { \n\n9\n\n+ \"subject\": \"productId\", \n\n10\n\n+ \"arguments\": { \n\n11\n\n+ \"id\": \"12\" \n\n12\n\n+ } \n\n13\n\n+ } \n\n14\n\n+ ] \n\n15\n\n+ \"Then\": \"flex-layout.row#custom-pdp-layout-12\", \n\n16\n\n+ \"Else\": \"flex-layout.row#default\" \n\n17\n\n+ } \n\n18\n\n+ } \n\n`\n\nOr for `condition-layout.binding`:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.binding#cond42\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.binding#cond42\": { \n\n6\n\n+ \"props\": { \n\n7\n\n+ \"conditions\": [ \n\n8\n\n+ { \n\n9\n\n+ \"subject\": \"bindingId\", \n\n10\n\n+ \"arguments\": { \n\n11\n\n+ \"id\": \"13fb71d0-binding-code-here-87h9c28h9013\" \n\n12\n\n+ } \n\n13\n\n+ } \n\n14\n\n+ ] \n\n15\n\n+ \"Then\": \"flex-layout.row#just-for-this-binding\", \n\n16\n\n+ \"Else\": \"flex-layout.row#for-other-bindings\" \n\n17\n\n+ } \n\n18\n\n+ } \n\n`\n\nOr for `condition-layout.category`:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.category#cond42\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.category#cond42\": { \n\n6\n\n+ \"props\": { \n\n7\n\n+ \"conditions\": [ \n\n8\n\n+ { \n\n9\n\n+ \"subject\": \"department\", \n\n10\n\n+ \"arguments\": { \n\n11\n\n+ \"ids\": [\"1\", \"42\"] \n\n12\n\n+ } \n\n13\n\n+ } \n\n14\n\n+ { \n\n15\n\n+ \"subject\": \"category\", \n\n16\n\n+ \"arguments\": { \n\n17\n\n+ \"ids\": [\"301\", \"304\"] \n\n18\n\n+ } \n\n19\n\n+ } \n\n20\n\n+ ] \n\n21\n\n+ \"matchType\": \"any\", \n\n22\n\n+ \"Then\": \"flex-layout.row#just-for-this-category-or-department\", \n\n23\n\n+ \"Else\": \"flex-layout.row#for-other-category-or-department\" \n\n24\n\n+ } \n\n25\n\n+ } \n\n`\n\nOr for `condition-layout.telemarketing`:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.telemarketing#show-block\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.telemarketing#show-block\": { \n\n6\n\n+ \"props\": { \n\n7\n\n+ \"conditions\": [ \n\n8\n\n+ { \n\n9\n\n+ \"subject\": \"impersonable\", \n\n10\n\n+ \"arguments\": { \n\n11\n\n+ \"value\": true \n\n12\n\n+ } \n\n13\n\n+ } \n\n14\n\n+ ] \n\n15\n\n+ \"Then\": \"flex-layout.row#just-for-telemarketers\", \n\n16\n\n+ \"Else\": \"flex-layout.row#for-other-user-roles\" \n\n17\n\n+ } \n\n18\n\n+ } \n\n`\n\n> In the example above, whenever users interact with a product whose ID is equal to 12, the `flex-layout.row#custom-pdp-layout-12` block is rendered. If users interact with a product whose ID is not equal to 12, the rendered block is `flex-layout.row#default`.\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| conditions | object | List of desired conditions. | undefined |\n| matchType | enum | Layout rendering criteria. Possible values are: all (all conditions must be met to render the layout), any (at least one of the conditions must be met to render the layout), or none (no conditions must be met to render the layout). | all |\n| Then | block | Name of the block to be rendered if the conditions are met. If no value is defined, the blocks declared as children of condition-layout.product will be rendered instead. | undefined |\n| Else | block | Name of the block to be rendered if the conditions are not met. | undefined |\n\n* **`conditions` object:**\n\n| Prop name | Type | Description | Default value |\n| --------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| subject | string | Defines, based on the product context where the block is declared, which information is needed from the UI to validate the value chosen in the object prop. See below the possible values for this prop. | undefined |\n| arguments | object | Defines the condition parameters. Note that the value of this prop varies depending on the value set for the subject prop. See below the table with the possible values for the subject prop and their expected arguments. | undefined |\n| toBe | boolean | Determines whether the data fetched in the subject prop must meet the predefined conditions to render the new layout (true) or not (false). | true |\n\nPossible values for `subject` prop of the `condition-layout.product` block:\n\n| Subject | Description | Arguments |\n| ------------------------ | ------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------- |\n| productId | Product IDs currently displayed on the UI. | { id: string } |\n| categoryId | Category IDs currently displayed on the UI. | { id: string } |\n| brandId | Brand IDs currently displayed on the UI. | { id: string } |\n| selectedItemId | ID of the item currently selected by the user. | { id: string } |\n| productClusters | List of product clusters currently displayed on the UI. | { id: string } |\n| categoryTree | List of categories currently displayed on the UI. **Note:** Only available on the Product Detail Page. | { id: string } |\n| specificationProperties | List of product specifications currently displayed on the UI. | { name: string, value: string }. Note: value is an optional prop. If omitted, only the specification name (name) will be checked. |\n| areAllVariationsSelected | Determines whether all product variations currently available on the UI were selected by the user (true) or not (false). | No arguments are expected. |\n| isProductAvailable | Determines whether the product is available (true) or not (false). | No arguments are expected. |\n| hasMoreSellersThan | Determines whether the number of sellers for a product is greater than the argument passed. | { quantity: number } |\n| hasBestPrice | Whether the product is being given a discount on its list price. | { value: boolean } or no arguments. |\n| sellerId | Whether any of the sellers of the product are included in the list of IDs passed. | { ids: string\\[\\] } |\n\nPossible values for the `subject` prop of the `condition-layout.binding` block:\n\n| Subject | Description | Arguments |\n| --------- | -------------------------------- | -------------- |\n| bindingId | ID of the desired store binding. | { id: string } |\n\nPossible values for the `subject` prop of the `condition-layout.category` block:\n\n| Subject | Description | Arguments |\n| ---------- | --------------------------------------------- | ------------------- |\n| category | Category IDs currently displayed on the UI. | { ids: string\\[\\] } |\n| department | Department IDs currently displayed on the UI. | { ids: string\\[\\] } |\n\nPossible values for the `subject` prop of the `condition-layout.telemarketing` block:\n\n| Subject | Description | Arguments |\n| ------------ | ----------------------------------- | ------------------ |\n| impersonable | Value of the impersonation setting. | { value: boolean } |\n\n## App behavior\n\nThe `condition-layout.product` block mainly uses the `matchType` and `conditions` props to respectively set the criteria and the conditions that blocks must meet to be rendered.\n\nThe `conditions` prop does not rely on any automatic grammar to define the desired conditions. Instead, it relies on its two props, namely `subject` and `arguments`, which together define which condition must be met by using an underlying data validation method (with specific arguments) based on the UI behavior.\n\nLastly, the `matchType` prop decides the necessary number of valid conditions for the layout rendering.\n\n## Customization\n\nThe Condition Layout merely establishes a logic to render other blocks. Therefore, the app does not have its own CSS handles for customization.\n\nInstead, you should use the handles of the child blocks.\n\n[Layout Apps« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/guides/layout-apps)[Disclosure LayoutNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.disclosure-layout)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)[V1 DOCVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout@2.8.2/v1-DOC)[MIGRATION GUIDEVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout%23configuration)\n\n[Step 1 - Adding the Condition Layout app to your theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout%23step-1-adding-the-condition-layout-app-to-your-theme-dependencies)[Step 2 - Adding the condition-layout.product block to your theme templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout%23step-2-adding-the-condition-layoutproduct-block-to-your-theme-templates)[Step 3 - Defining the desired conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout%23step-3-defining-the-desired-conditions)\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout%23app-behavior)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout/docs/apps/vtex.condition-layout%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d73c96f5
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex product summary productsummarybuybutton in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/updates/release-notes)\n\nProduct Summary Buy Button\n\nProduct Summary Buy Button is the block exported by the [Product Summary app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary) responsible for rendering a Buy Button in the [Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummaryshelf) block.\n\n\n\n> **The Product Summary Buy Button only effectively adds products to the Minicart if the store still uses the [Minicart v1](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/minicart/blob/383d7bbd3295f06d1b5854a0add561a872e1515c/docs/README.md)**. If the store uses the [Minicart v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/), please configure the [Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-add-to-cart-button/) in the `product-summary.shelf` block instead.\n\n## Configuration\n\n1. Import the `vtex.product-summary` app to your theme's dependencies in the `manifest.json`:\n\n`1\n\n dependencies: { \n\n2\n\n \"vtex.product-summary\": \"2.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-summary-buy-button` block as a children of the `product-summary.shelf` block:\n\n`1\n\n { \n\n2\n\n \"product-summary.shelf\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"product-summary-image\", \n\n5\n\n \"product-summary-name\", \n\n6\n\n \"product-rating-inline\", \n\n7\n\n \"product-summary-space\", \n\n8\n\n \"product-summary-price\", \n\n9\n\n+ \"product-summary-buy-button\" \n\n10\n\n ] \n\n11\n\n }, \n\n12\n\n } \n\n`\n\n1. Then, declare the `product-summary-buy-button` and configure its behavior using the props stated below.\n\n`1\n\n{ \n\n2\n\n \"product-summary-buy-button\": { \n\n3\n\n \"props\": { \n\n4\n\n \"isOneClickBuy\": false \n\n5\n\n } \n\n6\n\n } \n\n7\n\n} \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------- |\n| isOneClickBuy | boolean | Whether the user should be redirected to Checkout after clicking on the Buy Button (true) or not (false). | false |\n| buyButtonText | string | Custom text that overwrites the default Buy Button text. | undefined |\n| displayBuyButton | enum | Sets the Buy Button display mode. Possivle values are: displayButtonAlways (it will always be displayed), displayButtonHover (only displayed on hover), or displayButtonNone (it will be hidden for users). | displayButtonAlways |\n| customToastURL | string | Defines a redirect link to the Toast displayed when an item is added to your cart. | /checkout/#/cart |\n| buyButtonBehavior | enum | Sets the Buy Button behavior when it is clicked on. Possible values are: alwaysGoToProduct (redirect users to the product page), default (redirect users to the minicart), or alwaysAddToTheCart (add the selected SKU to the minicart). When choosing this last option, be careful: use it only if there are SKU Selectors for each product variation. This way, users can properly select their desired SKU. | default |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------------ |\n| buyButtonContainer |\n| buyButton |\n| isHidden |\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-product-summary-productsummarybuybutton.md)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/guides/vtex-product-summary-productsummarybuybutton%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/guides/vtex-product-summary-productsummarybuybutton%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/guides/vtex-product-summary-productsummarybuybutton%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-product-summary-productsummarybuybutton.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/guides/vtex-product-summary-productsummarybuybutton%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/guides/vtex-product-summary-productsummarybuybutton%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-summary-productsummarybuybutton/docs/guides/vtex-product-summary-productsummarybuybutton%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_e96f35ed
|
[
{
"role": "system",
"content": "You are a VTEX 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 running native ab testing in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-running-native-ab-testing/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-running-native-ab-testing/docs/api-reference)\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-running-native-ab-testing/docs/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-running-native-ab-testing/docs/storefront-development)\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-running-native-ab-testing/docs/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-running-native-ab-testing/docs/troubleshooting)\n\n[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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/docs/guides/ab-tests)\n\n[Running A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing)\n\n[A/B testing Legacy and IO store versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/docs/guides/ab-tests)\n\n[Running A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing)\n\n[A/B testing Legacy and IO store versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/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-running-native-ab-testing/docs/app-development)\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/ab-tests)\n\n[Running A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing)\n\nRunning A/B tests\n\nIn this guide, you will learn how to manage an A/B test, covering steps from running the test to providing the results.\n\nA/B testing involves comparing traffic between two store workspaces and helps you determine which performs better regarding user engagement and conversions. To run an A/B test, you can use the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference) or the [A/B Tester](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester) app.\n\n> A/B tests have a maximum duration of 30 days from their start date. After this period, tests may end automatically without notice.\n\n## Before you begin\n\nMake sure you have [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) installed on your machine.\n\n## Running A/B tests via Admin\n\nThe A/B Tester app allows you to run A/B tests via the Admin. To use the app, follow these steps:\n\n1. Open the terminal and log in to the desired account. \n`1 \nvtex login {accountName} \n` \n> Replace the values between curly brackets based on your account name.\n2. Install the A/B Tester app in the `master` workspace by running: \n`1 \nvtex use master \n2 \nvtex install vtex.ab-tester \n`\n3. Type `y` to confirm that you want to install the app in the `master` workspace.\n4. Install the **A/B Tester app** in the `master` workspace by running the following: \n`1 \nvtex install vtexarg.abtester \n`\n5. Type `y` to confirm the installation.\n6. Now, in the VTEX Admin, go to **Extensions Hub > Installed Apps > AB Tester**.\n7. See the [A/B Tester Admin app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtexarg-abtester%23usage) to create A/B tests, compare and conclude tests.\n\n## Running A/B tests via VTEX IO CLI\n\n### Step 1 - Enabling A/B testing\n\n1. Open the terminal and log in to the desired account. _Remember to replace the values between curly brackets based on your account name._ \n`1 \nvtex login {accountName} \n` \n> Replace the values between curly brackets based on your account name.\n2. [Create and switch to a Production workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-production-workspace) by running the following command: \n`1 \nvtex use {workspaceName} --production \n`\n3. Perform the changes you want to test in the production workspace you are using, such as installing or editing an app. \n> If your store uses the [Checkout UI Custom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-checkout-ui-custom-v0) app, you must first publish its configurations on your new production workspace. Otherwise, you might experience undesired consequences, such as losing the Checkout custom JavaScript code and styles.\n4. Switch to the `master` workspace. \n`1 \nvtex use master \n`\n5. Install the VTEX A/B tester app in the `master` workspace to enable A/B testing on your store website by running: \n`1 \nvtex install vtex.ab-tester \n` \n> You can run `vtex ls` to ensure you have successfully installed `vtex.ab-tester` in the `master` workspace.\n6. Run the following command in the `master` workspace. \n`1 \nvtex workspace abtest start \n` \n\n7. Select the production workspace you want to use for comparison with the `master` and agree to proceed.\n\n### Step 2 - Configuring the traffic and time\n\nBy agreeing to proceed with the test, you need to answer the following two questions:\n\n1. `What's the proportion of traffic initially directed to the master workspace?`\n\nYou must answer this question with any whole number between 0 and 10000\\. For example, if you answer `9000`, you will set 90% of the traffic to the `master` workspace.\n\n> To promote the changes from your production workspace in the safest way possible, we strongly recommend leaving 90% of traffic dedicated to the `master` and the other 10% to the production workspace being tested.\n\n1. `What's the amount of time respecting the restriction?`\n\nThis is the time (in hours) when the traffic proportion stated in the previous question remains constant. After this period, the A/B testing system automatically balances the traffic proportions, sending more traffic to the best-performing workspace. There are two possible answers to this question:\n\n| Option | Description |\n| ------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Answer 0 to automatically proceed with the A/B test.** | In this case, VTEX IO will automatically split your website traffic between workspaces, routing 50% of your store traffic to the master and the other 50% to the production workspace being tested.Following that, the platform will automatically balance traffic every three minutes based on the conversion rates. This means that traffic will be gradually routed from the workspace with the lowest conversion rate to the workspace with the highest conversion rate.**The test doesn't conclude independently.** **Evaluate the test results daily.** |\n| **Answer with the number of hours you want to keep constant the proportion of traffic previously specified.** | During peak operational periods, it's critical for the test to extract as much data as possible. At the same time, the test shouldn't overextend and end up harming users navigating the workspace with the poorest performance. |\n\nYou can run many A/B tests simultaneously by comparing two or more workspaces to the `master` individually. However, if you set up the traffic manually, the A/B test will distribute the traffic evenly among all production workspaces being A/B tested. For example, suppose you started an A/B test between workspace A and `master`, routing 90% of traffic to the former and 10% to the latter. If you run a new A/B test between workspace B and the `master`, each production workspace, A and B, will only receive 5% of the store traffic.\n\n> When a user session begins, their assigned workspace is determined by a cookie that lasts for 24 hours. During this period, the user will remain in the same workspace, regardless of traffic redistribution. After 24 hours, when a new session starts, the user may be randomly assigned to either workspace, which could be the same as before or a different one.\n\n### Step 3 - Interpreting the test results\n\nAny time during the A/B test, you can monitor the live results by executing the following command:\n\n`1\n\nvtex workspace abtest status \n\n`\n\n\n\nYou can update the workspaces used in the A/B test if necessary. However, fewer changes to these workspaces will lead to more accurate results.\n\nBefore concluding your A/B test, it's essential to understand the comparative and final results of the two workspaces. The following presents the metrics available for both results:\n\n#### Comparative results\n\n| Metric | Description |\n| ------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Conversion** | Conversion rate percentage displayed by each workspace during the test. |\n| **Expected Loss** | Anticipated percentage of conversion loss for the store if the lower conversion rate workspace is selected as the winner (based on **Conversion** results). |\n| **N. of Sessions** | Total number of sessions for each workspace since the beginning of the test. |\n| **N. of Sessions (last 24hrs)** | Number of sessions for each workspace during the test in the past 24 hours. |\n| **Revenue** | Total revenue placed by users navigating the store version associated with each workspace since the beginning of the test (expressed in the store's native currency). |\n| **Revenue (last 24 hs)** | Total revenue placed by users navigating the store version associated with each workspace in the past 24 hours during the test (expressed in the store's native currency). |\n\n#### Final results\n\n| **Metric** | **Description** |\n| ------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| **Start Date** | Date and time for the test to start. |\n| **Running Time** | Test duration. |\n| **Probability B beats A** | Probability, in percentage points, that the production workspace is better for your store than the current master workspace. This calculation is based on session and completed sales counts. If this metric is greater than 10%, the production workspace can become the winner. |\n| **Winner** | Workspace you selected as the winner. |\n\n> The main results of the A/B test are aimed at scenarios where the platform automatically directs store traffic. Although A/B testing can and should be used even in cases where traffic is directed manually, the numbers behind each result reflect an automatic segmentation depending on each workspace experience.\n\n#### Validating the winner workspace\n\nThe best way to validate your A/B test workspace winner is to set a maximum conversion loss value based on the size of your store operation.\n\nFor example, when starting your test, you can set a maximum conversion loss of `0,0001%`. Then, when either workspace achieves an `Expect Loss` result greater than `0,0001%`, you should end the test and declare a winner.\n\n### Step 4 - Finishing the A/B test\n\nIf your test has already reached the time frame you have manually set, or if you've already detected a winner during [Step 3](#step-3---interpreting-the-test-results), run the following command in `master` to conclude the test:\n\n`1\n\nvtex workspace abtest finish \n\n`\n\n> If you've manually set a predefined time frame to run your A/B test, monitor it throughout the entire period. Although the platform automatically redistributes traffic according to how each workspace behaves after the set time frame, overseeing the test is fundamental to its success.\n\nThis command displays a list of all workspaces tested by the `vtex.ab-tester` app in the `master` environment. Choose the workspace that you intend to finish. For example:\n\n\n\n> Remember to save any relevant data using the `vtex workspace abtest finish` command before it ends automatically in 30 days – A/B test data can't be retrieved otherwise. You can access data from ongoing tests with the `vtex workspace abtest status` command.\n\nAfter concluding the A/B test, follow the next step to promote the workspace to `master`.\n\n### Step 5 - Promoting the production workspace to master\n\nIn [Step 4](#step-4---finishing-the-ab-test), you only ended the test on the selected workspace. Now, you need to promote it to `master` by following the steps below.\n\n1. Change to the production workspace to be promoted. \n> You must be logged in to your VTEX account. \n`1 \nvtex use {workspaceName} \n` \n> Replace the values between curly brackets based on your workspace name.\n2. Promote the workspace being used. \n`1 \nvtex workspace promote \n`\n\nNow, all changes made in production are available in the master workspace.\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/ab-tests/vtex-io-documentation-running-native-ab-testing.md)\n\n[A/B tests« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing//docs/guides/ab-tests)[A/B testing Legacy and IO store versionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing//docs/guides/vtex-io-documentation-performing-ab-testing-between-legacy-and-io)\n\nSee also\n\n[AB TesterVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtexarg-abtester)\n\nContributors\n\n2\n\n[](https://github.com/barbara-celi)\n\n[](https://github.com/carolinamenezes)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23before-you-begin)\n\n[Running A/B tests via Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23running-ab-tests-via-admin)\n\n[Running A/B tests via VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23running-ab-tests-via-vtex-io-cli)\n\n[Step 1 - Enabling A/B testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-1-enabling-ab-testing)[Step 2 - Configuring the traffic and time](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-2-configuring-the-traffic-and-time)[Step 3 - Interpreting the test results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-3-interpreting-the-test-results)[Step 4 - Finishing the A/B test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-4-finishing-the-ab-test)[Step 5 - Promoting the production workspace to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-5-promoting-the-production-workspace-to-master)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/ab-tests/vtex-io-documentation-running-native-ab-testing.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-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23before-you-begin)\n\n[Running A/B tests via Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23running-ab-tests-via-admin)\n\n[Running A/B tests via VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23running-ab-tests-via-vtex-io-cli)\n\n[Step 1 - Enabling A/B testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-1-enabling-ab-testing)[Step 2 - Configuring the traffic and time](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-2-configuring-the-traffic-and-time)[Step 3 - Interpreting the test results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-3-interpreting-the-test-results)[Step 4 - Finishing the A/B test](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-4-finishing-the-ab-test)[Step 5 - Promoting the production workspace to master](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-native-ab-testing/docs/guides/vtex-io-documentation-running-native-ab-testing%23step-5-promoting-the-production-workspace-to-master)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0d4d2d97
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides deprecated how to collect orders from sales channels in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/updates/release-notes)\n\n\\[Deprecated\\] How to collect orders from sales channels\n\n> We have released a new method for integrating orders from external marketplaces, as a part of our Marketplace Protocol. If you used this previous method for integrating orders, you can still find their documentation in [Order Logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/deprecated-order-logs) and [How to collect orders from sales channels](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/deprecated-how-to-collect-orders-from-sales-channels). These previous methods, however, will not be maintained. If you are integrating orders for the first time, we recommend you use the instructions in our [New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-collect-orders) guide.\n\nOrders in an integration fit into two different categories:\n\n**Paid orders:** the marketplace only makes orders available for the integration once they are paid by the customer.\n\n\n\n**Orders to be paid:** the marketplace makes orders that have not been paid by the customer available for the integration.\n\n\n\nRight after the payment confirmation by the marketplace, the flow goes as the image below describes it: \n\n\n\n## How orders reach the connector\n\nA marketplace order can reach the connector by either a:\n\n1. **Notification sent by the marketplace:** when the marketplace informs the connector about the existence of an order, and the connector, after receiving the notification, goes to the marketplace to get order details.\n\n\n\n1. **Polling request made by the connector:** when the connector checks the marketplace from time to time, to collect new orders. \n\n\n## Integrating orders\n\nFollow the steps below, to integrate orders from external marketplaces:\n\n1. Collect order details from the endpoint provided by the marketplace.\n2. Create a request on the [Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders) endpoint.\n3. [Simulate fulfillment](#fulfillment-simulation), to check if the SKU is available in VTEX.\n4. For each SKU retrieved, the connector must call the [Get SKU and Context endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/catalog-api-get-sku-context) and: \na. Validate if the SKU is active through the `isActive` property. \nb. Validate if the SKU is associated to the sales channel used in the integration through the `salesChannel` property.\n5. In case step 4 retrieves all SKUs that compose the order with their respective inventory levels and prices, the connector should insert the order through the [Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/order-placement) endpoint.\n* In the `marketplaceServicesEndpoint` field, the endpoint will be used by VTEX to inform the connector of the changes in order status, inserting tracking code and invoice. For more information check out [Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-invoice-tracking).\n1. In case step 5 returns success and creates the order within the VTEX platform, authorize the dispatch by the seller through the [Authorize dispatch for fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders/-orderId-/fulfill) endpoint.\n2. Check the [Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-recommendations) page to follow integration best practices.\n3. Check out the [Order logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs) page to create appropriate error messages.\n\nIf all validations pass, the order is sent to VTEX and the operation is logged according to information described in the [Order logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-order-logs).\n\nAfter VTEX OMS returns `success`, if the IDs between VTEX and the marketplace differ, the connector should store the mapping of the order (VTEX ID and Marketplace ID). This information will be used for [order status update operations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-update-order-status%23api-reference-update-order-status).\n\n> Be mindful to make all validations at once. In case there's an error detected, the connector presents the seller a list of actions to correct. This way we can avoid the correct - publish - correct cycle. If orders do not apply to the steps above, an [error log](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs) must be filed.\n\n## API Reference\n\nUse the endpoints described below to perform this step. It is important to note that when consuming this API, the connector must have a valid VTEX App Key and App Token. The diagram illustrates the endpoints used in the integration:\n\n\n\n> All parameters in the endpoints below must be declared in the request. In case one of the parameters does not have a value, you must still send it as `null`.\n\n### Fulfillment simulation\n\nUse the curl example below to perform the fulfillment Simulation.\n\n`1\n\ncurl --location --request POST 'https://{{accountName}}.vtexcommercestable.com.br/api/checkout/pub/orderForms/simulation?affiliateId={{affiliateId}}={{salesChannelId}}' \\ \n\n2\n\n--header 'Accept: application/vnd.vtex.checkout.debug.v1+json' \\ \n\n3\n\n--header 'Content-Type: application/json' \\ \n\n4\n\n--data-raw '{ \n\n5\n\n \"items\": [ \n\n6\n\n { \n\n7\n\n \"id\": \"13\", \n\n8\n\n \"quantity\": 1, \n\n9\n\n \"seller\": \"1\" \n\n10\n\n } \n\n11\n\n ], \n\n12\n\n \"marketingData\": null, \n\n13\n\n \"postalCode\": \"04321-100\", \n\n14\n\n \"country\": \"BRA\", \n\n15\n\n \"selectedSla\": null, \n\n16\n\n \"clientProfileData\": null, \n\n17\n\n \"geoCoordinates\": [], \n\n18\n\n \"isCheckedIn\": false, \n\n19\n\n \"storeId\": null \n\n20\n\n}' \n\n`\n\n### Shopping cart simulation\n\nUse the request example below to perform the Shopping Cart Simulation. Check out our [Shopping cart Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/cartsimulation) API Reference to know more details.\n\n`1\n\n{ \n\n2\n\n\"items\":[ \n\n3\n\n{...} \n\n4\n\n] \n\n5\n\n\"ratesAndBenefitsData\":{ \n\n6\n\n\"rateAndBenefitsIdentifiers\":[] \n\n7\n\n\"teaser\":[] \n\n8\n\n} \n\n9\n\n\"paymentData\":{ \n\n10\n\n\"installmentOptions\":[...] \n\n11\n\n\"paymentSystems\":[...] \n\n12\n\n\"payments\":[] \n\n13\n\n\"giftCards\":[] \n\n14\n\n\"giftCardMessages\":[] \n\n15\n\n\"availableAccounts\":[] \n\n16\n\n\"availableTokens\":[] \n\n17\n\n} \n\n18\n\n\"selectableGifts\":[] \n\n19\n\n\"marketingData\":NULL \n\n20\n\n\"postalCode\":NULL \n\n21\n\n\"country\":\"BRA\" \n\n22\n\n\"logisticsInfo\":[ \n\n23\n\n{...} \n\n24\n\n] \n\n25\n\n\"messages\":[] \n\n26\n\n\"purchaseConditions\":{ \n\n27\n\n\"itemPurchaseConditions\":[...] \n\n28\n\n} \n\n29\n\n\"pickupPoints\":[] \n\n30\n\n\"subscriptionData\":NULL \n\n31\n\n\"totals\":[ \n\n32\n\n{...} \n\n33\n\n] \n\n34\n\n\"itemMetadata\":NULL \n\n35\n\n} \n\n`\n\n### Place fulfillment order\n\nUse the request example below to place fulfillment order. Check out our [Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders) API Reference to know more details.\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"items\": [ \n\n4\n\n { \n\n5\n\n \"id\": \"1\", \n\n6\n\n \"price\": 900, \n\n7\n\n \"quantity\": 1, \n\n8\n\n \"seller\": \"1\" \n\n9\n\n } \n\n10\n\n ], \n\n11\n\n \"isCreatedAsync\": true, \n\n12\n\n \"marketplaceOrderGroup\" : \"794901324\", \n\n13\n\n \"marketplaceOrderId\": \"2630580124\", \n\n14\n\n \"marketplacePaymentValue\": 1100, \n\n15\n\n \"marketplacePaymentReferenceValue\": 1100, \n\n16\n\n \"marketplaceServicesEndpoint\": \"http://skyhubintegration.vtexinternal.com/api/skyhubintegration/commercialcondition?an=grocery1\", \n\n17\n\n \"clientProfileData\": { \n\n18\n\n \"CorporateDocument\": null, //Cnpj \n\n19\n\n \"CorporateName\": null, //nome da empresa \n\n20\n\n \"CorporatePhone\": null, // ddd+telefone \n\n21\n\n \"Document\": \"14310315771\", //cpf \n\n22\n\n \"DocumentType\": null, //se pessoa fisica, colocar CPF, senão CNPJ \n\n23\n\n \"Email\": \"conta@dominio.com.br\", \n\n24\n\n \"FirstName\": \"Nome\", \n\n25\n\n \"IsCorporate\": false, //caso pessoa juridica o valor deve ser true \n\n26\n\n \"LastName\": \"Sobrenome\", \n\n27\n\n \"Phone\": \"41998718616\", \n\n28\n\n \"StateInscription\": null, //inscrição estadual \n\n29\n\n \"TradeName\": null, \n\n30\n\n \"UserProfileId\": null //utilizado somente com pedidos VTEX \n\n31\n\n }, \n\n32\n\n \"shippingData\": { \n\n33\n\n \"address\": { \n\n34\n\n \"addressId\": \"Casa\", \n\n35\n\n \"addressType\": \"Residencial\", \n\n36\n\n \"receiverName\": \"Marcelo\", \n\n37\n\n \"city\": \"Curitiba\", \n\n38\n\n \"complement\": null, \n\n39\n\n \"country\": \"BRA\", \n\n40\n\n \"geoCoordinates\": [], \n\n41\n\n \"neighborhood\": \"Novo Mundo\", \n\n42\n\n \"number\": \"4000\", \n\n43\n\n \"postalCode\": \"81020230\", \n\n44\n\n \"reference\": null, \n\n45\n\n \"state\": \"PR\", \n\n46\n\n \"street\": \"Rua Eduardo Carlos Pereira\" \n\n47\n\n }, \n\n48\n\n \"logisticsInfo\": [ \n\n49\n\n { \n\n50\n\n \"itemIndex\": 0, \n\n51\n\n \"price\": 200, \n\n52\n\n \"selectedDeliveryChannel\":\"delivery\", \n\n53\n\n \"selectedSla\": null, \n\n54\n\n \"lockTTL\": \"1d\", //tempo para reserva do estoque do pedido \n\n55\n\n \"shippingEstimate\":\"1d\" //tempo de entrega do pedido \n\n56\n\n } \n\n57\n\n ], \n\n58\n\n \"selectedAddresses\":[ \n\n59\n\n { \n\n60\n\n \"addressType\": \"Residencial\", \n\n61\n\n \"receiverName\": \"Henrique Vianna\", \n\n62\n\n \"addressId\": \"2\", \n\n63\n\n \"postalCode\": \"81020-235\", \n\n64\n\n \"city\": \"Curitiba\", \n\n65\n\n \"state\": \"PR\", \n\n66\n\n \"country\": \"BRA\", \n\n67\n\n \"street\": \"Rua Eduardo Carlos Pereira\", \n\n68\n\n \"number\": \"4125\", \n\n69\n\n \"neighborhood\": \"Portão\", \n\n70\n\n \"complement\": \"\", \n\n71\n\n \"reference\": null, \n\n72\n\n \"geoCoordinates\": [ \n\n73\n\n -49.2892059, \n\n74\n\n -25.4826319 \n\n75\n\n ] \n\n76\n\n }], \n\n77\n\n \"isFob\": false //se entrega feita pelo lojista coloque false, senão true \n\n78\n\n }, \n\n79\n\n \"customData\": { \n\n80\n\n \"customApps\": [{ \n\n81\n\n \"fields\": { \n\n82\n\n \"orderIdMarketplace\": \"2630580148\", \n\n83\n\n \"paymentIdMarketplace\": \"8191598627\" \n\n84\n\n }, \n\n85\n\n \"id\": \"marketplace-integration\", \n\n86\n\n \"major\": 1 \n\n87\n\n }] \n\n88\n\n }, \n\n89\n\n \"openTextField\": { \n\n90\n\n \"value\": \"{\\\"Phones\\\":[\\\"21998718616\\\"]}\" \n\n91\n\n } \n\n92\n\n } \n\n93\n\n] \n\n`\n\n### Authorize dispatch\n\nUse the request example below to authorize dispatch. Check out our [Authorize Dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/fulfillment/pvt/orders/-orderId-/fulfill)API Reference to know more details.\n\n`1\n\n[ \n\n2\n\n { \n\n3\n\n \"marketplaceOrderId\": \"956\" \n\n4\n\n } \n\n5\n\n] \n\n`\n\n## Scenario 1: orders with price divergence in items between marketplace and VTEX\n\nWhen to perform: after attempting to integrate an order in VTEX platform, the process returns an error `FMT007` \\- signaling price divergence.\n\nConnectors should:\n\n1. In case the call is successful (200 OK), signaling the creation of prive divergence rule, the order should be queued in VTEX.\n2. In case the call returns a bad request (400), signaling that the order could not be inserted for infringing price divergence rules, file an error log, following the error code x.\n3. In case the call returns an unauthorized request (500), signaling that the price divergence rule failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.\n\n## Scenario 2: inventory level divergence\n\nWhen to perform: after attempting to integrate an order in VTEX platform, the process returns an error `ORDER027` \\- signaling inventory error.\n\nConnectors should:\n\n1. Generate an error log, according to the item x.\n2. Validate if the order status in the marketplace was altered to `canceled`. If so, generate the error log message x, and remove the order from the retry queue.\n3. If the order was not canceled, submit the order to be reprocessed.\n4. In case the call is successful (200 OK), signaling the creation of the order, connectors should log the operation according to x.\n5. In case the call returns a bad request (400), signaling that the order could not be inserted for infringing stock rules, file an error log, following the error code x.\n6. In case the call returns an server error (500), signaling that the order creation failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.\n\n## Scenario 3: SLA errors - no carriers to deliver the order\n\nWhen to perform: after attempting to integrate an order in VTEX platform, the process returns an error `ORDER027` \\- signaling that there are no carriers to attend that order.\n\nConnectors should:\n\n1. Generate an error log, according to the item x.\n2. Validate if the order status in the marketplace was altered to `canceled`. If so, generate the error log message x, and remove the order from the retry queue.\n3. If the order was not canceled, submit the order to be reprocessed.\n4. In case the call is successful (200 OK), signaling the creation of the order, connectors should log the operation according to x.\n5. In case the call returns a bad request (400), signaling that the order could not be inserted for infringing carriers’ rules, file an[ error log](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs), following the error code x.\n6. In case the call returns a server error (500), signaling that the order creation failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.\n\n## Scenario 4: SLA errors - no pickup points to attend the order\n\nWhen to perform: after attempting to integrate an order in VTEX platform, the process returns an error `ORDER027` \\- signaling that there are no pickup points for the end customer to retrieve their order.\n\nConnectors should:\n\n1. Generate an error log, according to the item x.\n2. Validate if the order status in the marketplace was altered to `canceled`. If so, generate the error log message x, and remove the order from the retry queue.\n3. If the order was not canceled, submit the order to be reprocessed.\n4. In case the call is successful (200 OK), signaling the creation of the order, connectors should log the operation according to x.\n5. In case the call returns a bad request (400), signaling that the order could not be inserted for infringing pickup points’ rules, file an [error log](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs), following the error code x.\n6. In case the call returns an unauthorized request (500), signaling that the order creation failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.\n\n## Scenario 5: order is canceled by the marketplace\n\nWhen to perform: when the order is canceled by the marketplace.\n\nConnectors should:\n\n1. Verify if the order exists in the VTEX platform, by either: a. Checking the order ID relation between VTEX and the marketplace in their environment. b. Checking if the order exists through the [Get Order](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/getorder) endpoint.\n2. Validate the order status.\n3. If the order exists in VTEX, call 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.\n4. If the order exists in VTEX, and the order status is `invoiced`, call the [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.\n5. In case the call is successful (200 OK), signaling the cancelling of the order, connectors should log the operation according to x.\n6. In case the call returns a bad request (400), signaling that the order could not be canceled, file an [error log](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs), following the error code x.\n7. In case the call returns an unauthorized request (500), signaling that the order cancelling failed due to error in system communication, the order should be queued on the connector’s flow to perform a retry.\n\n> Make sure that all steps are logged as either success or failure, to offer the operation’s full traceability. Check out the [Order logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/external-marketplace-integration-order-logs) page to learn more.\n\nContributors\n\n4\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/deprecated-how-to-collect-orders-from-sales-channels.md)\n\nContributors\n\n4\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[How orders reach the connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23how-orders-reach-the-connector)\n\n[Integrating orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23integrating-orders)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23api-reference)\n\n[Fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23fulfillment-simulation)[Shopping cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23shopping-cart-simulation)[Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23place-fulfillment-order)[Authorize dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23authorize-dispatch)\n\n[Scenario 1: orders with price divergence in items between marketplace and VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-1-orders-with-price-divergence-in-items-between-marketplace-and-vtex)\n\n[Scenario 2: inventory level divergence](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-2-inventory-level-divergence)\n\n[Scenario 3: SLA errors - no carriers to deliver the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-3-sla-errors-no-carriers-to-deliver-the-order)\n\n[Scenario 4: SLA errors - no pickup points to attend the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-4-sla-errors-no-pickup-points-to-attend-the-order)\n\n[Scenario 5: order is canceled by the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-5-order-is-canceled-by-the-marketplace)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/deprecated-how-to-collect-orders-from-sales-channels.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[How orders reach the connector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23how-orders-reach-the-connector)\n\n[Integrating orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23integrating-orders)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23api-reference)\n\n[Fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23fulfillment-simulation)[Shopping cart simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23shopping-cart-simulation)[Place fulfillment order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23place-fulfillment-order)[Authorize dispatch](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23authorize-dispatch)\n\n[Scenario 1: orders with price divergence in items between marketplace and VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-1-orders-with-price-divergence-in-items-between-marketplace-and-vtex)\n\n[Scenario 2: inventory level divergence](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-2-inventory-level-divergence)\n\n[Scenario 3: SLA errors - no carriers to deliver the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-3-sla-errors-no-carriers-to-deliver-the-order)\n\n[Scenario 4: SLA errors - no pickup points to attend the order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-4-sla-errors-no-pickup-points-to-attend-the-order)\n\n[Scenario 5: order is canceled by the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/deprecated-how-to-collect-orders-from-sales-channels/docs/guides/deprecated-how-to-collect-orders-from-sales-channels%23scenario-5-order-is-canceled-by-the-marketplace)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b5cb2dcd
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides actions orders in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/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/actions-orders/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/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/actions-orders/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/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/actions-orders/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/actions-orders/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/actions-orders/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/actions-orders/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/actions-orders/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/actions-orders/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/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/actions-orders/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/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/actions-orders/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/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/actions-orders/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/actions-orders/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/actions-orders/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/actions-orders/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/actions-orders/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/actions-orders/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides)\n\nOrders\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders/docs/guides/actions-orders)\n\nActions in orders\n\n> Check the new [Orders onboarding guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/orders-overview). We created this guide to improve the onboarding experience for developers at VTEX. It assembles all documentation on our Developer Portal about Orders and is organized by focusing on the developer's journey.\n\nThis section contains articles about actions that can be performed in orders.\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.md)\n\n[Cancel order« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders//docs/guides/order-canceling-improvements)[Fetching marketplace information with the Orders APINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/actions-orders//docs/guides/get-marketplace-data-orders-api)\n\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Orders/actions-orders.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_02be9b60
|
[
{
"role": "system",
"content": "You are a VTEX 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 vtex marketplace setup in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/api-reference)\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-vtex-marketplace-setup/docs/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-vtex-marketplace-setup/docs/storefront-development)\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-vtex-marketplace-setup/docs/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-vtex-marketplace-setup/docs/troubleshooting)\n\n[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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\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-vtex-marketplace-setup/docs/guides/data-protection-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-vtex-marketplace-setup/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/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-vtex-marketplace-setup/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\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-vtex-marketplace-setup/docs/guides/data-protection-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-vtex-marketplace-setup/docs/guides)\n\nIntegration Guides\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-guide)\n\n[Store setup for VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup)\n\nStore setup for VTEX Marketplace\n\nFor a VTEX store to act as a marketplace and sell products from external sellers, it has to do the following for each external seller:\n\n* [Register the seller in the marketplace Admin](#register-the-seller-in-the-marketplace-admin)\n* [Activate the seller for a trade policy](#activate-the-seller-for-a-trade-policy)\n* [Set up API authentication credentials](#set-up-api-authentication-credentials)\n\nThis article explains what must be done to complete each of these configuration steps.\n\n---\n\n## Register the seller in the marketplace Admin\n\nAn external seller can only integrate into a VTEX store if it is registered there. The responsibility for creating this seller registration lies with the marketplace.\n\nYou can call the [Configure Seller Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23post-/seller-register/pvt/sellers) to add the external seller through API.\n\nThe article [Configuring a seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-the-seller--tutorials%5F392) shows the path to create the seller in the Admin and explains the form fields.\n\n> The **Fulfillment Endpoint** field should be filled in with the endpoint that will be implemented for the seller to receive the Fulfillment Simulation requests from the marketplace. This implementation is explained in the next section of this guide.\n\n\n\n> The `seller ID`, created during this step, will be essential for the integration. Most of the API requests explained in the next section of this guide will use it to identify the seller.\n\n## Activate the seller for a trade policy\n\nTrade policies are used in VTEX to group catalog, pricing, promotions, inventory, shipping, and payment settings for different sales channels. In a VTEX marketplace, each trade policy may apply to a different set of sellers. So, after creating a new seller, the marketplace needs to activate this seller for the trade policies that make sense for the business.\n\nTo do this, in the marketplace management panel's main menu, click on the option **Trade Policies**, then choose the trade policy you want to edit by clicking on the button **Alter** next to it. Next, select the sellers you want to activate. In the example of the image below, the trade policy \"Marketplace\" is only enabled for the seller \"Store 1\".\n\n\n\nCheck out the Help Center documentation to get the complete explanation on how to [enable the seller for a trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-the-seller--tutorials%5F392%23editing-the-trade-policy).\n\n## Set up API authentication credentials\n\nEvery private API request to the VTEX system requires authentication through a pair of appKey and appToken. So you will need to create these credentials before you can start building the integration.\n\nRead the [Authentication guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication%23section-creating-the-appkey-and-apptoken) to learn how to create and use the appKey and appToken.\n\nOnce the authentication credentials are created, keep the appKey / appToken pair stored in a safe place until you can securely share it with the external seller.\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-seller-integration-guide/external-seller-integration-vtex-marketplace-setup.md)\n\n[Marketplace / Seller architecture« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup//docs/guides/external-seller-integration-architecture)[External seller processing paymentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup//docs/guides/external-seller-processing-payments)\n\nContributors\n\n3\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Register the seller in the marketplace Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23register-the-seller-in-the-marketplace-admin)\n\n[Activate the seller for a trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23activate-the-seller-for-a-trade-policy)\n\n[Set up API authentication credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23set-up-api-authentication-credentials)\n\nWas this helpful?\n\n 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-vtex-marketplace-setup.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Register the seller in the marketplace Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23register-the-seller-in-the-marketplace-admin)\n\n[Activate the seller for a trade policy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23activate-the-seller-for-a-trade-policy)\n\n[Set up API authentication credentials](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-vtex-marketplace-setup/docs/guides/external-seller-integration-vtex-marketplace-setup%23set-up-api-authentication-credentials)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_96b061f0
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore analytics implementing custom newsletter analytics events in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-overview)\n\n[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-send-analytics-event)\n\n[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-use-analytics-event)\n\n[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-sending-custom-events)\n\n[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-extending-and-customizing-native-types)\n\n[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-overview)\n\n[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-send-analytics-event)\n\n[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-use-analytics-event)\n\n[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-sending-custom-events)\n\n[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-extending-and-customizing-native-types)\n\n[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)\n\n[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/cart-overview)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/search-overview)\n\n[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/session-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/sdk-overview)\n\n[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-overview)\n\nUse case: Implementing custom newsletter analytics events\n\nThis guide walks you through the process of implementing custom analytics events in FastStore projects. The example in this guide explains how to track user subscriptions by implementing two custom analytics events for a custom newsletter section:\n\n* `Submit newsletter`: Triggered when a user clicks `Subscribe`.\n* `Submit newsletter success`: Triggered upon successful subscription.\n\n\n\n> For a complete implementation example, check the [playground.store](https://read.calvincode.net/reader?url=https://github.com/vtex-sites/playground.store/tree/main/src/components/sections/CustomNewsletter) repository, which provides more in-depth details.\n\n## Before you begin\n\nTo follow this guide, you should be familiar with the following topics:\n\n* [FastStore Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview)\n* [Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-sending-custom-events)\n* [Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section)\n\n## Instructions\n\n### Creating a custom newsletter section\n\nCreate a new section to receive the two new custom events:\n\n1. Open your store repository. If you don't have it, create a folder named `components` in the `src` directory.\n2. In `components`, create the `sections` folder.\n3. In the `sections` folder, create the `CustomNewsletter.tsx` file and add the following code. Below is an explanation of the code.\n\n#### `NewsletterProps`\n\nDefines the customizable properties of the newsletter.\n\n* `title`: Heading of the newsletter.\n* `description`: Subtitle or description text.\n* `emailInputLabel`: Label for the email input field.\n* `subscribeButtonLabel`: Text for the submit button.\n* `toastSubscribe`: Success pop-up settings.\n* `toastSubscribeError`: Error pop-up settings.\n* `privacyPolicy`: Legal disclaimer text.\n* `card`: Defines whether the newsletter should display in a card-style container.\n* `colorVariant`: Styling theme (example: \"primary\", \"secondary\").\n\n#### `onSubmit` function\n\nHandles the newsletter subscription process.\n\n* `event.preventDefault()`: Prevents default form submission. \n * [sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event): Tracks the submission attempt. \n * The `onSubmit` function calls the `subscribeUser()` with email and name. \n * If successful: \n * Shows a success toast (`pushToast`). \n * Resets the form (`formRef.current?.reset()`). \n * If the call fails, it shows an error toast. \n * `pushToast`: Displays temporary success/error messages. \n * [sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-send-analytics-event): Tracks user interactions. \n * `Submit Newsletter` event: Tracks the form submission attempt when the user clicks the `Subscribe` button. \n * `Submit newsletter success` event: Tracks if the subscription was successful. \n * [useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-use-analytics-event) hook: Tracks and handles custom analytics events.\n\n### Creating the section `index` file\n\nTo make the Newsletter section available in the project, create a file named `index.tsx` in the components folder and add the following:\n\n### Styling the new section\n\nTo add styles to this new section, create a `section.module.scss` file and add the following:\n\n### Updating the CMS folder\n\n1. In the root directory of your storefront project, create a folder named `cms` if it doesn't exist.\n2. In `cms`, create the `faststore` folder.\n3. In the `cms/faststore` folder, create the `sections.json` file.\n4. In the `sections.json` file, add the new section you want to display in Headless CMS. The schema below defines how Headless CMS renders a section:\n\nCustomNewsletter.tsx\n\n`` 1\n\nimport type { \n\n2\n\n ToastProps, \n\n3\n\n NewsletterAddendumProps as UINewsletterAddendumProps, \n\n4\n\n NewsletterHeaderProps as UINewsletterHeaderProps, \n\n5\n\n NewsletterProps as UINewsletterProps, \n\n6\n\n} from \"@faststore/ui\"; \n\n7\n\nimport { useUI } from \"@faststore/ui\"; \n\n8\n\nimport styles from \"./section.module.scss\"; \n\n9\n\n \n10\n\nimport { \n\n11\n\n Button, \n\n12\n\n Icon, \n\n13\n\n InputField, \n\n14\n\n Newsletter, \n\n15\n\n NewsletterAddendum, \n\n16\n\n NewsletterContent, \n\n17\n\n NewsletterForm, \n\n18\n\n NewsletterHeader, \n\n19\n\n} from \"@faststore/ui\"; \n\n20\n\n \n21\n\nimport { Section } from \"@faststore/core\"; \n\n22\n\nimport { useNewsletter_unstable as useNewsletter } from \"@faststore/core/experimental\"; \n\n23\n\nimport { type FormEvent, useRef } from \"react\"; \n\n24\n\nimport { sendAnalyticsEvent, useAnalyticsEvent } from \"@faststore/sdk\"; \n\n25\n\n \n26\n\ninterface ArbitraryEvent { \n\n27\n\n name: string; \n\n28\n\n params: string; \n\n29\n\n} \n\n30\n\n \n31\n\ntype SubscribeMessage = { \n\n32\n\n icon: string; \n\n33\n\n title: string; \n\n34\n\n message: string; \n\n35\n\n}; \n\n36\n\n \n37\n\nexport interface NewsletterProps { \n\n38\n\n title: UINewsletterHeaderProps[\"title\"]; \n\n39\n\n card?: UINewsletterProps[\"card\"]; \n\n40\n\n colorVariant?: UINewsletterProps[\"colorVariant\"]; \n\n41\n\n description?: UINewsletterHeaderProps[\"description\"]; \n\n42\n\n privacyPolicy?: UINewsletterAddendumProps[\"addendum\"]; \n\n43\n\n emailInputLabel?: string; \n\n44\n\n displayNameInput?: boolean; \n\n45\n\n icon: { \n\n46\n\n alt: string; \n\n47\n\n icon: string; \n\n48\n\n }; \n\n49\n\n nameInputLabel?: string; \n\n50\n\n subscribeButtonLabel?: string; \n\n51\n\n subscribeButtonLoadingLabel?: string; \n\n52\n\n toastSubscribe?: SubscribeMessage; \n\n53\n\n toastSubscribeError?: SubscribeMessage; \n\n54\n\n} \n\n55\n\n \n56\n\nexport const AnalyticsHandler = () => { \n\n57\n\n useAnalyticsEvent((event: ArbitraryEvent) => { \n\n58\n\n console.log(\"Received event\", event); \n\n59\n\n }); \n\n60\n\n \n61\n\n /* ... */ \n\n62\n\n \n63\n\n return null; \n\n64\n\n}; \n\n65\n\n \n66\n\nfunction CustomNewsletter({ \n\n67\n\n icon: { icon, alt: iconAlt }, \n\n68\n\n title, \n\n69\n\n description, \n\n70\n\n privacyPolicy, \n\n71\n\n emailInputLabel, \n\n72\n\n displayNameInput, \n\n73\n\n nameInputLabel, \n\n74\n\n subscribeButtonLabel, \n\n75\n\n subscribeButtonLoadingLabel, \n\n76\n\n card, \n\n77\n\n toastSubscribe, \n\n78\n\n toastSubscribeError, \n\n79\n\n colorVariant, \n\n80\n\n ...otherProps \n\n81\n\n}: NewsletterProps) { \n\n82\n\n const { pushToast } = useUI(); \n\n83\n\n const { subscribeUser, loading } = useNewsletter(); \n\n84\n\n \n85\n\n const formRef = useRef<HTMLFormElement>(null); \n\n86\n\n const nameInputRef = useRef<HTMLInputElement>(null); \n\n87\n\n const emailInputRef = useRef<HTMLInputElement>(null); \n\n88\n\n \n89\n\n const onSubmit = async (event: FormEvent) => { \n\n90\n\n event.preventDefault(); \n\n91\n\n \n92\n\n try { \n\n93\n\n // send event start \n\n94\n\n sendAnalyticsEvent<ArbitraryEvent>({ \n\n95\n\n name: \"Submit Newsletter\", \n\n96\n\n params: \"test\", \n\n97\n\n }); \n\n98\n\n \n99\n\n const data = await subscribeUser({ \n\n100\n\n data: { \n\n101\n\n name: nameInputRef.current?.value ?? \"\", \n\n102\n\n email: emailInputRef.current?.value ?? \"\", \n\n103\n\n }, \n\n104\n\n }); \n\n105\n\n \n106\n\n if (data?.subscribeToNewsletter?.id) { \n\n107\n\n // send event start \n\n108\n\n sendAnalyticsEvent<ArbitraryEvent>({ \n\n109\n\n name: \"Submit newsletter success\", \n\n110\n\n params: \"test\", \n\n111\n\n }); \n\n112\n\n \n113\n\n pushToast({ \n\n114\n\n ...toastSubscribe, \n\n115\n\n status: \"INFO\", \n\n116\n\n icon: ( \n\n117\n\n <Icon width={30} height={30} name={toastSubscribe?.icon ?? \"\"} /> \n\n118\n\n ), \n\n119\n\n } as ToastProps); \n\n120\n\n \n121\n\n formRef?.current?.reset(); \n\n122\n\n } \n\n123\n\n } catch (error) { \n\n124\n\n pushToast({ \n\n125\n\n ...toastSubscribeError, \n\n126\n\n status: \"ERROR\", \n\n127\n\n icon: ( \n\n128\n\n <Icon width={30} height={30} name={toastSubscribeError?.icon ?? \"\"} /> \n\n129\n\n ), \n\n130\n\n } as ToastProps); \n\n131\n\n } \n\n132\n\n }; \n\n133\n\n \n134\n\n return ( \n\n135\n\n <Section className={`${styles.section} section-newsletter layout__section`}> \n\n136\n\n <AnalyticsHandler /> \n\n137\n\n <Newsletter card={card ?? false} colorVariant={colorVariant}> \n\n138\n\n <NewsletterForm ref={formRef} onSubmit={onSubmit}> \n\n139\n\n <NewsletterHeader \n\n140\n\n title={title} \n\n141\n\n description={description} \n\n142\n\n icon={ \n\n143\n\n <Icon width={32} height={32} name={icon} aria-label={iconAlt} /> \n\n144\n\n } \n\n145\n\n /> \n\n146\n\n \n147\n\n <NewsletterContent> \n\n148\n\n {displayNameInput && ( \n\n149\n\n <InputField \n\n150\n\n id=\"newsletter-name\" \n\n151\n\n required \n\n152\n\n label={nameInputLabel ?? \"Name\"} \n\n153\n\n inputRef={nameInputRef} \n\n154\n\n /> \n\n155\n\n )} \n\n156\n\n <InputField \n\n157\n\n id=\"newsletter-email\" \n\n158\n\n type=\"email\" \n\n159\n\n required \n\n160\n\n label={emailInputLabel ?? \"Email\"} \n\n161\n\n inputRef={emailInputRef} \n\n162\n\n /> \n\n163\n\n <NewsletterAddendum addendum={privacyPolicy} /> \n\n164\n\n <Button variant=\"secondary\" inverse type=\"submit\"> \n\n165\n\n {loading ? subscribeButtonLoadingLabel : subscribeButtonLabel} \n\n166\n\n </Button> \n\n167\n\n </NewsletterContent> \n\n168\n\n </NewsletterForm> \n\n169\n\n </Newsletter> \n\n170\n\n </Section> \n\n171\n\n ); \n\n172\n\n} \n\n173\n\n \n174\n\nexport default CustomNewsletter; \n\n ``\n\n### Syncing the new section with Headless CMS\n\n1. In the terminal, log in to your VTEX account by running `vtex login {accountName}`. \n> Replace `{accountName}` with the name of your account. For example, `vtex login store`.\n2. Run `yarn cms-sync` to sync the new section you created with CMS.\n3. Go to the VTEX Admin and navigate to **Storefront > Headless CMS**.\n4. Click the **Home** Content Type.\n5. In the Sections tab, click `+`, search for the new **Custom Newsletter** section, and add it to your page. \n\n6. Delete the **Newsletter** default section.\n7. Click `Save`.\n8. Click `Preview` to preview the new section before publishing it to the live store.\n\n## Results\n\n1. After opening the preview browser tab, open the browser's **Developer Tools** and go to the **Console** tab.\n2. Go to the newsletter section on the store page and complete **Your Name** and **Your Email** fields.\n3. Click `Subscribe`. You will notice in the **Console** tab that the two custom events were successfully triggered. \n\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/implementing-custom-newsletter-analytics-events.mdx)\n\n[Extending and customizing native types« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-extending-and-customizing-native-types)[CartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/cart-overview)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23instructions)\n\n[Creating a custom newsletter section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23creating-a-custom-newsletter-section)[Creating the section index file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23creating-the-section-index-file)[Styling the new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23styling-the-new-section)[Updating the CMS folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23updating-the-cms-folder)[Syncing the new section with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23syncing-the-new-section-with-headless-cms)\n\n[Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23results)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/implementing-custom-newsletter-analytics-events.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/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23instructions)\n\n[Creating a custom newsletter section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23creating-a-custom-newsletter-section)[Creating the section index file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23creating-the-section-index-file)[Styling the new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23styling-the-new-section)[Updating the CMS folder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23updating-the-cms-folder)[Syncing the new section with Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23syncing-the-new-section-with-headless-cms)\n\n[Results](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events%23results)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_e3353dd6
|
[
{
"role": "system",
"content": "You are a VTEX 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 pay processing information for payment providers and anti fraud in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/api-reference)\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-pay-processing-information-for-payment-providers-and-anti-fraud/docs/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-pay-processing-information-for-payment-providers-and-anti-fraud/docs/storefront-development)\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-pay-processing-information-for-payment-providers-and-anti-fraud/docs/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-pay-processing-information-for-payment-providers-and-anti-fraud/docs/troubleshooting)\n\n[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-pay-processing-information-for-payment-providers-and-anti-fraud/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/external-marketplace-integration-guide)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-framework)\n\n[Purchase Flows](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-purchase-flows)\n\n[Payment App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-app)\n\n[Payment Methods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-methods)\n\n[Payment Provider Homologation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-payment-provider-homologation)\n\n[Antifraud Provider Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-pci-dss-compliance)\n\n[Secure Proxy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/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/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides)\n\nIntegration Guides\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/payments-integration-guide)\n\n[Google Pay: processing information for payment providers and anti-fraud](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud)\n\nFAQ - Google Pay: processing information for payment providers and anti-fraud\n\nHere are some answers to questions you may have about transactions with Google Pay:\n\n## What are the differences between the payload used for a standard credit card payment and the one used for Google Pay [DPAN](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/dpan-and-fpan-understanding-security-in-the-online-tokenized-payment-flow--3RM7RvhKZ057wja5xVEOqb)?\n\nBesides the original fields for a credit or debit card payment transaction, the Google Pay DPAN transaction has three additional fields:\n\n* `cryptogram`: 3DS cryptogram information (previously called `3DS_criptogram`).\n* `eci`: Electronic Commerce Indicator (previously called `ECI_Indicador`). This field is sent only for Visa transactions and indicates the result of the authentication attempt made by the 3DS system.\n* `paymentOrigin` (optional): Identifies the type of card used for payment. To enable this field in Google Pay (DPAN) transactions or FPAN transactions and receive the information in the [Create payment endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol%23post-/payments) payload, open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/support).\n\nIn the VTEX Admin, go to **Orders > Transactions** to check if a transaction has been made with Google Pay.\n\n\n\n> The `paymentOrigin`, `panType`, and `cryptogram` fields aren't sent in standard credit or debit card transactions (without using a digital wallet).\n\n## What are the possible values for the `paymentOrigin` field in the payload?\n\nThe `paymentOrigin` field is always sent with the \"Google Pay\" value. Payment transactions using other payment methods don't have the `paymentOrigin` field in the payload.\n\n## Is the Card Verification Value (CVV) sent in Google Pay transactions?\n\nNo. The card CVV is sent in certain FPAN-type transactions. DPAN payment transactions do not require the card CVV number.\n\n> Transactions processed in subscription or recurring operations do not use the card CVV as well.\n\n## How can I simulate a DPAN test transaction?\n\nTo run a DPAN test transaction, follow these steps:\n\n1. Add a new card in the Google Pay digital wallet app or via redirection from the bank app (Android).\n2. Open the Chrome browser using the same Android device you used to add the card.\n3. Simulate buying a product, and on the checkout screen, select the option to pay using Google Pay. \n> Make sure to select the card that displays the actual card image, as it defines the transaction will use DPAN. If you select the card displaying the flag image, the transaction will use the FPAN method.\n4. Complete the payment and check the DPAN transaction data in your system.\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/jadsonluan)\n\nWas this helpful?\n\nYes\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/google-pay-processing-information-for-payment-providers-and-anti-fraud.md)\n\n[PSE Payment Method« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud//docs/guides/pse-payment-method)[Search ProtocolNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud//docs/guides/search-integration-guide)\n\nContributors\n\n2\n\n[](https://github.com/ricardoaerobr)\n\n[](https://github.com/jadsonluan)\n\nON THIS PAGE\n\n[What are the differences between the payload used for a standard credit card payment and the one used for Google Pay DPAN?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23what-are-the-differences-between-the-payload-used-for-a-standard-credit-card-payment-and-the-one-used-for-google-pay-dpan)\n\n[What are the possible values for the paymentOrigin field in the payload?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23what-are-the-possible-values-for-the-paymentorigin-field-in-the-payload)\n\n[Is the Card Verification Value (CVV) sent in Google Pay transactions?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23is-the-card-verification-value-cvv-sent-in-google-pay-transactions)\n\n[How can I simulate a DPAN test transaction?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23how-can-i-simulate-a-dpan-test-transaction)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/payments-integration-guide/google-pay-processing-information-for-payment-providers-and-anti-fraud.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[What are the differences between the payload used for a standard credit card payment and the one used for Google Pay DPAN?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23what-are-the-differences-between-the-payload-used-for-a-standard-credit-card-payment-and-the-one-used-for-google-pay-dpan)\n\n[What are the possible values for the paymentOrigin field in the payload?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23what-are-the-possible-values-for-the-paymentorigin-field-in-the-payload)\n\n[Is the Card Verification Value (CVV) sent in Google Pay transactions?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23is-the-card-verification-value-cvv-sent-in-google-pay-transactions)\n\n[How can I simulate a DPAN test transaction?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud/docs/guides/google-pay-processing-information-for-payment-providers-and-anti-fraud%23how-can-i-simulate-a-dpan-test-transaction)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_cf84cfcf
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides getting started list of rest apis in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/authentication)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started-list-of-rest-apis)\n\n[Making your first request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/making-your-first-request)\n\n[Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/authentication)\n\n[Response status codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-response-codes)\n\nError handling and best practices\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides)\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/api-usage)\n\n[List of REST APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis/docs/guides/getting-started-list-of-rest-apis)\n\nList of REST APIs\n\nSee how to use our APIs to integrate third-party solutions with a single platform for all experiences.\n\n| Name | Description |\n| --------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| [Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/antifraud-provider-protocol) | Defines the requirements to integrate an anti-fraud service into VTEX. |\n| [Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/legacy-cms-portal-api) | Manages Legacy CMS Portal via API. |\n| [Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal) | Creates, edits, and retrieves products and their variations, brands, and categories in the Seller Portal. |\n| [Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api) | Allows performing operations on your store sales channels, categories, brands, products, SKUs, and specifications. |\n| [Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api) | Allows access and operations on data from items in a shopping cart. |\n| [Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/customer-credit-api) | Enables credit payments on your store and controls invoices and credit limits. |\n| [GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-api) | Retrieves and updates gift cards from our native gift card system. |\n| [GiftCard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-provider-protocol) | Defines the requirements to become a gift card provider on VTEX. |\n| [GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/giftcard-hub-api) | Interacts with all gift card providers in a store from a single place. |\n| [Headless CMS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/headless-cms-api) | Structures a no-code management system for storefront content. |\n| [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api) | Helps customers in their buying journey through search results. |\n| [Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-events-api-headless) | Collects search events to improve your search results, such as page interactions and conversion, in a headless implementation. |\n| [License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/license-manager-api%23overview) | Manages users, roles, hosts, AppKeys, and AppTokens from a VTEX store. |\n| [Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/logistics-api) | Manages all store logistics data by allowing access to warehouses, docks, pickup points, carriers, and shipping rates. Gets or updates the inventory of each SKU. |\n| [Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis) | Enables marketplaces and sellers hosted on VTEX to perform operations related to collaboration. |\n| [Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol) | Connects external sellers to a VTEX marketplace and external marketplaces to VTEX sellers. |\n| [Master Data API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2) | Manages and retrieves all data entities, applications, and records from the Master Data database. |\n| [Master Data API v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2) | Manages and retrieves all data entities, applications, and records from the Master Data database. |\n| [Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/message-center-api) | Manages settings for VTEX mail servers. |\n| [Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api) | Receives, processes, and manages all orders through our APIs. |\n| [Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payment-provider-protocol) | Defines the requirements to integrate a payment processing API with VTEX. |\n| [Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api) | Retrieves payment data and processes your transactions. |\n| [Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/policies-system-api) | Creates promotion alarms when selling products with undesired prices and promotions. |\n| [Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-api) | Creates, reads, and edits prices for each SKU, sales channel or price table. |\n| [Pricing Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pricing-hub) | Connects with external pricing systems using Pricing Hub. |\n| [Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/promotions-and-taxes-api) | Manages and retrieves all promotions, coupons, and tax rules from a VTEX store. |\n| [Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/reviews-and-ratings-api) | Allows customers to submit product reviews and ratings. |\n| [SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/sku-bindings-api) | Links shared SKUs between sellers and marketplaces. |\n| [Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/search-api) | Searches and sorts products in the catalog using full-text, category, and brand search terms. Retrieves product information to create custom searches and product shelves. |\n| [Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/session-manager-api) | Tracks relevant information about the customer's current browsing session and integrates with several VTEX systems using a single call. |\n| [Subscriptions API v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/subscriptions-api-v3) | Manages store subscription rules to maximize revenue and reduce bounce and churn rates. |\n| [VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-shipping-network-api) | Sets up your app to integrate with VTEX Shipping Network. |\n| [VTEX Tracking API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking) | Manages all delivery solutions powered by a VTEX Tracking service. |\n| [VTEX Do API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-do-api) | Manages and retrieves notes or tasks from VTEX Do. |\n| [VTEX ID API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/vtex-id-api) | Manages tokens from a given app key and app token pair. |\n\nContributors\n\n5\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/jumeyermattosarruda)\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Getting-Started/getting-started/getting-started-list-of-rest-apis.md)\n\n[API usage« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis//docs/guides/api-usage)[Making your first requestNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-list-of-rest-apis//docs/guides/making-your-first-request)\n\nContributors\n\n5\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/GeorgeLimaDev)\n\n[](https://github.com/jumeyermattosarruda)\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/Getting-Started/getting-started/getting-started-list-of-rest-apis.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_df16af5d
|
[
{
"role": "system",
"content": "You are a VTEX 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 searchbar in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-searchbar/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-searchbar/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/vtex-io-apps)\n\nSearch Bar\n\n[vtex.store-components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components)\n\nVersion: 3.178.5\n\nLatest version: 3.178.5\n\nThe `search-bar` component shows a search bar with autocomplete options and displays the matching products as well. This component can be imported and used by any VTEX App.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `search-bar` block into the [header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-header) component. For example:\n\n`1\n\n \"header.full\": { \n\n2\n\n \"blocks\": [ \n\n3\n\n \"login\", \n\n4\n\n \"minicart\", \n\n5\n\n \"logo\", \n\n6\n\n+ \"search-bar\", \n\n7\n\n \"menu-link\", \n\n8\n\n \"telemarketing\", \n\n9\n\n \"category-menu\" \n\n10\n\n ] \n\n11\n\n }, \n\n`\n\n1. Then, declare the `search-bar` block using the props stated in the [Props](#props) table. For example:\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| ----------------------------- | ------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| attemptPageTypeSearch | Boolean | If true when clicked on result link of brand, department or category will link to the corresponding brand, department or category page. When false will always go to a full text search page. | false |\n| autocompleteAlignment | [HorizontalAlignment](#horizontalalignment) | Autocomplete Horizontal alignment. Possible values are: left, center, right. | left |\n| autocompleteFullWidth | Boolean | If true, the autocomplete will fill the whole window horizontally. | false |\n| autoFocus | Boolean | Define if the search input should autofocus or not | \\- |\n| blurOnSubmit | Boolean | Define if input should blur on submit. | false |\n| classes | CustomCSSClasses | Overrides default CSS handles. To better understand how this prop works, check [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| containerMode | enum | Defines how the autocomplete component should be displayed. Possible values are: overlay (suggestions overlapping other components) and container (displays the suggestion within a container). | overlay |\n| compactMode | Boolean | Define when to use the compact version of the component | \\- |\n| customSearchPageUrl | string | Template for a custom url. It can have a substring ${term} used as placeholder to interpolate the searched term. (e.g. /search?query=${term}) | \\- |\n| disableBlurAndTouchEndHandler | Boolean | The autocomplete can have touchable/clickable components. Interacting with those components may trigger blur and touch events that will close the autocomplete. When set to true, this prop will disable those handlers. | false |\n| displayMode | [DisplayMode](#displaymode) | Define the component display mode, such as which buttons should be visible. | clear-button |\n| emptyPlaceholder | String! | Shows a placeholder when the ResultList hasn't results to displayed | \\- |\n| hasIconLeft | Boolean | Define if the search icon is on left or right position | \\- |\n| iconClasses | String |  Custom classes for the search icon. Use the CSS handle searchBarIcon. | \\- |\n| inputType | enum | Defines the value for the type HTML attribute (from the <input> field). Possible values are: search and text. We strongly recommend you to use search as it fixes some iOS issues. The text value is only kept as default for backwards compatibility. | text |\n| maxWidth | Number \\| String | Max width of the search bar | \\- |\n| minSearchTermLength | Number | If defined, it will block searches where the term length is lesser than minSearchTermLength. | \\- |\n| openAutocompleteOnFocus | Boolean | Defines if autocomplete should be open on input focus or not. | false |\n| placeholder | String! | Placeholder to be used on the input | \\- |\n| submitOnIconClick | Boolean |  Defines if search icon should submit on click. Use the displayMode prop instead. | false |\n\n#### `DisplayMode`\n\n| Enum name | Enum value | Empty state | Filled state |\n| ------------------------ | -------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| clear-button | 'clear-button' |  |  |\n| search-and-clear-buttons | 'search-and-clear-buttons' |  |  |\n| search-button | 'search-button' |  |  |\n\n## Using SearchBar with Intelligent Search\n\nTo improve the search experience usign the SearchBar component, such as the autocomplete option, you must use the component within [Search app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) responsible for handling the [Intelligent Search (IS)](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-intelligent-search?%5Fga=2.220970832.979717665.1650285782-1001456323.1619912759) solution in IO stores.\n\nThe IS communicates with the `autocomplete-result-list.v2` block exported by the Search app, and the block displays previous search results based on current and previous searches.\n\nFollow the [Search documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search) to add the Search app to your store.\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ------------------------------- |\n| compactMode |\n| externalSearchButtonWrapper |\n| paddingInput |\n| searchBarContainer |\n| searchBarInnerContainer--opened |\n| searchBarInnerContainer--filled |\n| searchBarIcon |\n| searchBarIcon--clear |\n| searchBarIcon--external-search |\n| searchBarIcon--prefix |\n| searchBarIcon--search |\n| suffixWrapper |\n\nSee also\n\n[Vtex.store ComponentsVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/apps/vtex.store-components)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/apps/vtex.store-components/SearchBar%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/apps/vtex.store-components/SearchBar%23props)\n\n[Using SearchBar with Intelligent Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/apps/vtex.store-components/SearchBar%23using-searchbar-with-intelligent-search)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar/docs/apps/vtex.store-components/SearchBar%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_548c62f6
|
[
{
"role": "system",
"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 cookie script 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.cookie-script/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/api-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.cookie-script/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.cookie-script/docs/storefront-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.cookie-script/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.cookie-script/docs/troubleshooting)\n\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.cookie-script/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/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.cookie-script/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/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.cookie-script/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.cookie-script/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/guides/pixel-apps)\n\nCookie Script\n\nOfficial extension\n\nVersion: 0.1.10\n\nLatest version: 0.1.10\n\n[](#contributors-)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://cookie-script.com/) app brings the [solution](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-cookie-script/p) to make your website cookies comply with GDPR and CCPA.\n\n\n\nLearn how to install and configure the app on the following sections.\n\n## Installing Cookie Script app\n\nIt is possible to install the Cookie Script in your store either by using [App Store](https://read.calvincode.net/reader?url=https://apps.vtex.com/vtex-cookie-script/p) or 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### Using VTEX App Store\n\n1. Access the **Apps** section in your account's admin page and look for the Cookie Script box;\n2. Then, click on the **Install** button;\n3. You'll see a warning message about needing to enter the necessary configurations. Scroll down and type in your **Cookie Script ID**.\n4. Click on **Save**.\n\n### Using VTEX IO Toolbelt\n\n1. In your terminal, [install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/installing-an-app/) the `vtex.cookie-script@0.x` app.\n2. To confirm that the app has now been installed, run in your terminal `vtex ls` and check the installed apps' list.\n3. Access the **Apps** section in your account's admin page and look for the Cookie Script box. Once you find it, click on it.\n4. Fill in the **Cookie Script ID** field.\n5. Click on **Save**.\n\nAfter installing the app, you must create an account in [Cookie Script](https://read.calvincode.net/reader?url=https://cookie-script.com/create-an-account.html) to make the app work on your store. Follow the steps on the [Cookie Script Configuration](#cookie-script-configuration) section to create an account and configure the app.\n\n## Cookie Script Configuration\n\nOnce you have installed the app, you need to create an account in [Cookie Script](https://read.calvincode.net/reader?url=https://cookie-script.com/create-an-account.html) to be able to configure the app.\n\n> _You must follow the steps described in this section to guarantee the cookies will work. Otherwise, they will break the purchases flow from your store._\n\n1. Go to the [Cookie Script](https://read.calvincode.net/reader?url=https://cookie-script.com/create-an-account.html) page and create your account.\n2. After creating your account, go to the **Dashboard** tab and click on `Add website`.\n\n\n\n1. Once you have added your website, go to the **Cookie scanner** tab and run a scan.\n2. After the scan is complete, go to **Cookies** tab and make sure the following cookies are categorized as **Stricly Necessary**: `ASPXAUTH`, `checkout.vtex.com`, `CookieConsent`, `device`, `vtex_segment`, `vtex_session`, `VtexFingerPrint`, `VtexRCMacIdv7`, `VtexRCRequestCounter`, `VtexRCSessionIdv7` and `VtexWorkspace`.\n\n[Cookiebot« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cookiebot)[CyberSource FingerprintNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cybersource-fingerprint)\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[Installing Cookie Script app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cookie-script%23installing-cookie-script-app)\n\n[Using VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cookie-script%23using-vtex-app-store)[Using VTEX IO Toolbelt](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cookie-script%23using-vtex-io-toolbelt)\n\n[Cookie Script Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookie-script/docs/apps/vtex.cookie-script%23cookie-script-configuration)\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_fc13e8eb
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore api extensions 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/api-extensions-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/api-extensions-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/api-extensions-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/api-extensions-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/api-extensions-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/api-extensions-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/api-extensions-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/api-extensions-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/api-extensions-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-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/api-extensions-overview/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-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/api-extensions-overview/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-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/api-extensions-overview/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-overview/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-overview/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-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/api-extensions-overview/docs/guides/faststore/api-extensions-overview)\n\n[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-extending-api-schema)\n\n[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-extending-queries-using-fragments)\n\n[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-consuming-api-extensions)\n\n[Best practices for using API extensions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-best-practices)\n\n[API extensions - Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-use-cases-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-overview/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-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/api-extensions-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/api-extensions-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/api-extensions-overview/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore)\n\nAPI Extensions\n\nThis track will teach you how to extend the FastStore API schema by adding new data to the existing [queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries).\n\nWhile the [FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview) provides a [GraphQL schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries) that caters to common use cases, some stores may require access to additional and more specific data. If you need to retrieve data not natively provided by the FastStore API, you can achieve this by extending the FastStore API schema and incorporating new data into the existing [queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-queries).\n\n> Please be aware that introducing additional API endpoints to your storefront can potentially affect site performance, as already covered in the [Main concepts](#main-concepts) section.\n\n## Main concepts\n\nGraphQL Optimizations & types\n\nGraphQL optimizations are seamlessly executed, requiring no direct intervention from end developers. They are essential for optimizing your GraphQL server and TypeScript types and provide benefits such as:\n\n* Build-time generated mappings of declared queries.\n* Improved efficiency and security.\n* Enforcement of predefined operations.\n\nThey are automatically triggered every time you start a development server (`yarn dev`) or build the store (`yarn build`). Resolver changes are automatically and instantly visible without the need for manual optimization generation. Without these optimizations, any changes to the GraphQL schema, such as adding or removing fields from a query or changing a GraphQL type, won't be reflected in the store.\n\nExtendable queries\n\nExtendable queries in FastStore's GraphQL API are predefined GraphQL queries that serve as a foundation for retrieving data from the API. These queries allow you to add or change fields within the query to tailor the data retrieval process to the store-specific needs.\n\n### Fetch only the data you need\n\nGraphQL allows you to customize your query to get precisely the data you need, which reduces the data returned from the requests. Double-check your queries to make sure they are not over-fetching.\n\nThis also means that you must be mindful of the data added to your query with [GraphQL fragments](https://read.calvincode.net/reader?url=https://graphql.org/learn/queries/%23fragments) returned. Use them only when they do not include unnecessary data.\n\n### Optimize FastStore API integration with VTEX APIs\n\nWhen integrating FastStore with VTEX APIs, always use your store's domain for API calls instead of `vtexcommercestable` environment directly. Direct calls for this environment can impact performance and scalability.\n\nFor example, when using the [Get list of products for a query instead](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api%23get-/product%5Fsearch/-facets-?endpoint=get-/product%5Fsearch/-facets-) endpoint, instead of calling `https://mystore.vtexcommercestable.com.br/api/io/_v/api/intelligent-search/product_search/{facets}`, use your store's domain like `https://www.mystore.com/api/io/_v/api/intelligent-search/product_search/{facets}`.\n\n### Do not send direct requests to external APIs\n\nDo not make direct requests to external APIs to avoid compromising website performance and `504` timeout errors. Instead, use the FastStore [API extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-api-schema) to access other data not available in the native FastStore API schema.\n\nIf you need data that is not available on the native FastStore GraphQL schema, check the [root object](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects). The [GraphQL root object](https://read.calvincode.net/reader?url=https://graphql.org/learn/execution/%23root-fields-resolvers) represents the top-level object returned to a query. You can see the data that is available in the root object by adding logs.\n\n### Avoid custom API Routes\n\nWe do not recommend using Next.js [API Routes](https://read.calvincode.net/reader?url=https://nextjs.org/docs/api-routes/introduction) other than the ones already built-in in FastStore.\n\nIf you do use this type of function, you must always check which ones are actually running and remove the ones that are not.\n\n[Extending VTEX API schemasExtend VTEX and third-party APIs to customize how data is managed and processed in your store.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview)[Extending queries using fragmentsExtend GraphQL queries using fragments in FastStore API Extension to add custom fields to predefined queries.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments)[Consuming FastStore API extension with custom componentsConsume FastStore API extension data with custom components.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-consuming-api-extensions)[TroubleshootingCheck for common errors that can happen while using API extensions.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-troubleshooting)\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/api-extensions/overview.mdx)\n\n[Experimental exports - Hooks and Components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/developing-and-overriding-components-experimental-exports-hooks-and-components)[Extending API schemasNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-extending-api-schema)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Main concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23main-concepts)\n\n[Fetch only the data you need](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23fetch-only-the-data-you-need)[Optimize FastStore API integration with VTEX APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23optimize-faststore-api-integration-with-vtex-apis)[Do not send direct requests to external APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23do-not-send-direct-requests-to-external-apis)[Avoid custom API Routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23avoid-custom-api-routes)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/api-extensions/overview.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Main concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23main-concepts)\n\n[Fetch only the data you need](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23fetch-only-the-data-you-need)[Optimize FastStore API integration with VTEX APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23optimize-faststore-api-integration-with-vtex-apis)[Do not send direct requests to external APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23do-not-send-direct-requests-to-external-apis)[Avoid custom API Routes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview/docs/guides/faststore/api-extensions-overview%23avoid-custom-api-routes)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_bfc003f8
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides external marketplace integration delivery validation in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/erp-integration-guide)\n\n[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/customer-credit-integration-guide)\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-guide)\n\n[Marketplace / Seller architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-architecture)\n\n[Store setup for VTEX Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-vtex-seller-setup)\n\n[Creating an integration app from a Template](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-app-template)\n\n[Catalog Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-catalog)\n\n[Catalog logs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-logs)\n\n[Get product list for an initial load](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-product-load)\n\n[How to get a new product to offer in the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-new-products)\n\n[How to get product updates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-product-updates)\n\n[Product and Category Mappings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-catalog-mapping)\n\n[How to keep prices updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-price-update)\n\n[How to keep stock updated](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-stock-update)\n\n[Order Integration overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-orders)\n\n[Recommendations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-recommendations)\n\n[New Order Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-collect-orders)\n\n[Update Order Status](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-update-order-status)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-delivery-validation)\n\n[Sending invoice and tracking code to the marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-invoice-tracking)\n\n[How to update a canceled order’s status in VTEX](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-canceled-orders)\n\n[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-seller-integration-guide)\n\n[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/gift-card-integration-guide)\n\n[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/headless-commerce)\n\n[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/login-integration-guide)\n\n[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/punchout)\n\n[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/sent-offers-integration-guide-connectors)\n\n[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/payments-integration-guide)\n\n[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/search-integration-guide)\n\n[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/session-manager)\n\n[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/tax-service-integration-guide)\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/pricing-hub)\n\n[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/recaptcha)\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/master-data)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides)\n\nIntegration Guides\n\n[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-guide)\n\n[How to validate if items are available for delivery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation/docs/guides/external-marketplace-integration-delivery-validation)\n\nHow to validate if items are available for delivery\n\nTo make sure all items in an order are available for delivery on the VTEX platform, the connector must validate them. Follow the steps below to make the validation:\n\n1. Connector collects order information at the marketplace.\n2. Connector sends a [Fulfillment simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-protocol-external-marketplace-orders%23post-/api/checkout/pub/orderForms/simulation) request to collect updated information about items to check their availability on stock.\n3. Connector notifies VTEX about stock in Marketplace through the `StockBalance` property, so that the stock availability is constantly updated.\n4. After receiving the VTEX notification, connectors should validate the following:\n* If the SKU is active, through the `isActive` property, .\n* If the SKU is associated with the trade policy used in the marketplace integration through the `salesChannel` property.\n* If there is a freight option configured to deliver the order in the Shipping strategy, through the object `logistics`.\n* If there SKU available in stock through the `StockBalance` property.\n\nAll the fields mentioned above must be available for the validation of an item’s delivery. In case any of them are unavailable, the item will not be validated.\n\n> In case the SKU is not included in the Shopping cart simulation's response, connectors must reduce stock to zero to avoid orders created for nonexistent SKUs.\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-delivery-validation.md)\n\n[Update Order Status« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation//docs/guides/external-marketplace-update-order-status)[Sending invoice and tracking code to the marketplaceNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-delivery-validation//docs/guides/external-marketplace-integration-invoice-tracking)\n\nContributors\n\n2\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/brunoamui)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/external-marketplace-integration-guide/external-marketplace-integration-delivery-validation.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_a59647dd
|
[
{
"role": "system",
"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 api API and how to use it."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/intelligent-search-api/)\n\nAutocomplete\n\nProduct List Page\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/updates/release-notes)\n\nAPI Reference\n\nFilter By\n\nPost\n\nGet\n\nPut\n\nDelete\n\nPatch\n\n[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/antifraud-provider-protocol/)\n\n---\n\n[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/audience-api/)\n\n---\n\n[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/buyer-organizations/)\n\n---\n\n[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/budgets-api/)\n\n---\n\n[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/legacy-cms-portal-api/)\n\n---\n\n[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/card-token-vault-api/)\n\n---\n\n[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/catalog-api-seller-portal/)\n\n---\n\n[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/catalog-api/)\n\n---\n\n[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/checkout-api/)\n\n---\n\n[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/customer-credit-api/)\n\n---\n\n[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/delivery-promise-notification-api/)\n\n---\n\n[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/giftcard-api/)\n\n---\n\n[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/giftcard-provider-protocol/)\n\n---\n\n[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/giftcard-hub-api/)\n\n---\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/headless-cms-api/)\n\n---\n\n[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/intelligent-search-api/)\n\nAutocomplete\n\nProduct List Page\n\n---\n\n[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/intelligent-search-events-api-headless/)\n\n---\n\n[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/license-manager-api/)\n\n---\n\n[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/logistics-api/)\n\n---\n\n[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/marketplace-apis/)\n\n---\n\n[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/marketplace-protocol/)\n\n---\n\n[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/master-data-api-v2/)\n\n---\n\n[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/masterdata-api/)\n\n---\n\n[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/message-center-api/)\n\n---\n\n[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/mtls-api/)\n\n---\n\n[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/operational-capacity-api/)\n\n---\n\n[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/orders-api/)\n\n---\n\n[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/organization-units-api/)\n\n---\n\n[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/payment-provider-protocol/)\n\n---\n\n[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/payments-gateway-api/)\n\n---\n\n[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pick-and-pack-api/)\n\n---\n\n[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pick-and-pack-protocol-api/)\n\n---\n\n[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pick-and-pack-order-changes-api/)\n\n---\n\n[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/policies-system-api/)\n\n---\n\n[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pricing-api/)\n\n---\n\n[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/pricing-hub/)\n\n---\n\n[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/promotions-and-taxes-api/)\n\n---\n\n[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/promotions-and-taxes-api-v2/)\n\n---\n\n[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/punchout-api/)\n\n---\n\n[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/reviews-and-ratings-api/)\n\n---\n\n[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/recommendations-bff-api/)\n\n---\n\n[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/sku-bindings-api/)\n\n---\n\n[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/search-api/)\n\n---\n\n[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/session-manager-api/)\n\n---\n\n[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/ssl-certificates-api/)\n\n---\n\n[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/storefront-permissions-api/)\n\n---\n\n[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/subscriptions-api-v3/)\n\n---\n\n[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/vtex-ads-api/)\n\n---\n\n[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/vtex-shipping-network-api/)\n\n---\n\n[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/tracking/)\n\n---\n\n[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/vtex-do-api/)\n\n---\n\n[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/vtex-id-api/)\n\n---\n\n[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/profile-system/)\n\n---\n\n[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/orders-api-pii-version/)\n\n---\n\n[GeGet CMS page« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/headless-cms-api%23get-/%5Fv/cms/api/-projectId-/-content-type-/-document-id-)[GeGet list of the 10 most searched termsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api/docs/api-reference/intelligent-search-api%23get-/top%5Fsearches)\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_4910fe59
|
[
{
"role": "system",
"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 condition layout 2.8.2 MIGRATION GUIDE 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.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/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.condition-layout@2.8.2/MIGRATION-GUIDE/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.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/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.condition-layout@2.8.2/MIGRATION-GUIDE/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.condition-layout@2.8.2/MIGRATION-GUIDE/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.condition-layout@2.8.2/MIGRATION-GUIDE/docs/vtex-io-apps)\n\nMigration guide\n\n[vtex.condition-layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout)\n\nVersion: 2.8.2\n\nLatest version: 2.8.2\n\nIf you're currently using the Condition Layout in its **`1.x.x`** version, the following guide aims to help you to perform a **version upgrade**, migrating your store theme to the latest version of the app (**`2.x.x`**).\n\nIf you’re using the former version, you can still find its documentation [here](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/condition-layout/tree/master/docs/v1-DOC.md). Do not forget to also access the [**Condition Layout current documentation**](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/condition-layout/tree/master/docs/README.md) for its `2.x.x` version.\n\n:information\\_source: _Although support for the former version is still granted, we strongly recommend you to update your store theme with the app's newest version in order to keep up with the components' evolution._\n\n## Overview\n\nThe rewriting of this app aimed to provide a clearer logic when setting the conditions to build the new desired layout.\n\nThe changes included in the app upgrade are, namely:\n\n* [Block structure](#block-structure)\n* [Prop's syntax](#props-syntax)\n* [Negative conditions](#negative-conditions)\n\n### Block structure\n\nIn the `1.x.x` version, the `condition-layout` app exports three different types of blocks for your store theme:\n\n* `condition-layout.product` \\- Wraps the desired `condition.product` blocks.\n* `condition.product` \\- Defines the desired conditions to be met.\n* `condition.else` \\- Defines in its child blocks a component to be rendered in case no condition is met.\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.product\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.product\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"condition.product#custom-pdp-12\", \n\n8\n\n \"condition.product#custom-pdp-20\", \n\n9\n\n \"condition.else\" \n\n10\n\n ] \n\n11\n\n }, \n\n12\n\n \"condition.product#custom-pdp-12\": { \n\n13\n\n \"props\": { \n\n14\n\n \"conditions\": [ \n\n15\n\n { \n\n16\n\n \"subject\": \"productId\", \n\n17\n\n \"verb\": \"is\", \n\n18\n\n \"object\": \"12\" \n\n19\n\n } \n\n20\n\n ] \n\n21\n\n }, \n\n22\n\n \"children\": [\"flex-layout.row#custom-pdp-layout-12\"] \n\n23\n\n }, \n\n24\n\n \"condition.product#custom-pdp-20\": { \n\n25\n\n \"props\": { \n\n26\n\n \"conditions\": [ \n\n27\n\n { \n\n28\n\n \"subject\": \"productId\", \n\n29\n\n \"verb\": \"is\", \n\n30\n\n \"object\": \"20\" \n\n31\n\n } \n\n32\n\n ] \n\n33\n\n }, \n\n34\n\n \"children\": [\"flex-layout.row#custom-pdp-layout-20\"] \n\n35\n\n }, \n\n36\n\n \n37\n\n \"condition.else\": { \n\n38\n\n \"children\": [\"flex-layout.row#default\"] \n\n39\n\n } \n\n40\n\n} \n\n`\n\nThe block configuration is simplified in the `2.x.x` version: now, all three blocks were merged into a single one called `condition-layout.product`.\n\nThe same structure above can now be rewritten using the new block's props:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [\"condition-layout.product#custom-pdp-12\"] \n\n4\n\n }, \n\n5\n\n \"condition-layout.product#custom-pdp-12\": { \n\n6\n\n \"props\": { \n\n7\n\n \"conditions\": [ \n\n8\n\n { \n\n9\n\n \"subject\": \"productId\", \n\n10\n\n \"arguments\": { \"id\": \"12\" } \n\n11\n\n } \n\n12\n\n ], \n\n13\n\n \"Then\": \"flex-layout.row#custom-pdp-layout-12\", \n\n14\n\n \"Else\": \"condition-layout.product#custom-pdp-20\" \n\n15\n\n } \n\n16\n\n }, \n\n17\n\n \"condition-layout.product#custom-pdp-20\": { \n\n18\n\n \"props\": { \n\n19\n\n \"conditions\": [ \n\n20\n\n { \n\n21\n\n \"subject\": \"productId\", \n\n22\n\n \"arguments\": { \"id\": \"20\" } \n\n23\n\n } \n\n24\n\n ] \n\n25\n\n }, \n\n26\n\n \"Then\": \"flex-layout.row#custom-pdp-layout-20\", \n\n27\n\n \"Else\": \"flex-layout.row#default\" \n\n28\n\n } \n\n29\n\n} \n\n`\n\n### Prop's syntax\n\nIn **`1.x.x`**, a simple logic for creating conditions was provided, where you could mix the `subject`, `verb`, and `object` props to set conditions in an idiomatic way.\n\nSince it provided a very effortless and easy syntax to set conditions, these last ones were, in turn, very limited as well. For example, it was not possible to check for a specification property name _and_ value at the sime time.\n\n`` 1\n\n{ \n\n2\n\n \"condition.product\": { \n\n3\n\n \"props\": { \n\n4\n\n \"conditions\": [ \n\n5\n\n // checks if the product has the \n\n6\n\n // specification named `Material` \n\n7\n\n { \n\n8\n\n \"subject\": \"specificationProperties\", \n\n9\n\n \"verb\": \"contains\", \n\n10\n\n \"object\": \"Material\" \n\n11\n\n } \n\n12\n\n ] \n\n13\n\n }, \n\n14\n\n \"children\": [\"...\"] \n\n15\n\n } \n\n16\n\n} \n\n ``\n\nIn **`2.x.x`**, the aforementioned syntax was replaced with a pair of `subject` and `arguments` props.\n\nIn practice, a `subject` is linked to an internal method that receives the `arguments`. Make sure to check [which arguments each subject can receive in the Condition Layout documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/readme.md).\n\nThe above condition can be rewritten in the app's newest version as:\n\n`` 1\n\n{ \n\n2\n\n \"condition.product\": { \n\n3\n\n \"props\": { \n\n4\n\n \"conditions\": [ \n\n5\n\n // checks if the product has the \n\n6\n\n // specification named `Material` \n\n7\n\n { \n\n8\n\n \"subject\": \"specificationProperties\", \n\n9\n\n \"arguments\": { \n\n10\n\n \"name\": \"Material\" \n\n11\n\n // Optional: could also check for its value \n\n12\n\n // \"value\": \"Leather\" \n\n13\n\n } \n\n14\n\n } \n\n15\n\n ], \n\n16\n\n \"Then\": \"...\" \n\n17\n\n } \n\n18\n\n } \n\n19\n\n} \n\n ``\n\n### Negative conditions\n\nPreviously (`1.x.x`), negative conditions were built using the `is-not` and `does-not-contain` values from the `verb` prop, as shown below:\n\n`1\n\n{ \n\n2\n\n \"condition.product\": { \n\n3\n\n \"props\": { \n\n4\n\n \"conditions\": [ \n\n5\n\n { \n\n6\n\n \"subject\": \"specificationProperties\", \n\n7\n\n \"verb\": \"does-not-contain\", \n\n8\n\n \"object\": \"Material\" \n\n9\n\n } \n\n10\n\n ] \n\n11\n\n }, \n\n12\n\n \"children\": [\"...\"] \n\n13\n\n } \n\n14\n\n} \n\n`\n\nIn the latest version (`2.x.x`), the `verb` prop has given way to the `toBe` prop, which assigns in its value (`true` or `false`) the expected value of the condition.\n\nThe above condition can be rewritten as:\n\n`1\n\n{ \n\n2\n\n \"condition.product\": { \n\n3\n\n \"props\": { \n\n4\n\n \"conditions\": [ \n\n5\n\n { \n\n6\n\n \"subject\": \"specificationProperties\", \n\n7\n\n \"arguments\": { \n\n8\n\n \"name\": \"Material\" \n\n9\n\n }, \n\n10\n\n \"toBe\": false \n\n11\n\n } \n\n12\n\n ], \n\n13\n\n \"Then\": \"...\" \n\n14\n\n } \n\n15\n\n } \n\n16\n\n} \n\n`\n\nSee also\n\n[Vtex.condition LayoutVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/apps/vtex.condition-layout)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE%23overview)\n\n[Block structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE%23block-structure)[Prop's syntax](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE%23props-syntax)[Negative conditions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE/docs/apps/vtex.condition-layout@2.8.2/MIGRATION-GUIDE%23negative-conditions)\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_4a6b48e4
|
[
{
"role": "system",
"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 sku list app? Provide documentation and configuration details."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/b2b-components)\n\n[Order Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.order-configuration)\n\n[Quickorder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.quickorder)\n\n[SKU List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.sku-list)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/b2b-components)\n\n[Order Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.order-configuration)\n\n[Quickorder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.quickorder)\n\n[SKU List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.sku-list)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/vtex-io-apps)\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/guides/b2b-components)\n\nSKU List\n\nOfficial extension\n\nVersion: 1.3.0\n\nLatest version: 1.3.0\n\n[](#contributors-)\n\nThe SKU List app is an essential B2B feature responsible for rendering a SKU list in the product details page.\n\n\n\n## Configuration\n\n1. Add the `vtex.sku-list` app to your theme's dependencies in the `manifest.json`, for example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.sku-list\": \"1.x\" \n\n3\n\n } \n\n`\n\nNow, you are able to use all blocks exported by the `sku-list` app. Check out the full list below:\n\n| Block name | Description |\n| --------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| sku-list | Top level block in which you will declare as children the SKU List layout blocks according to devices (sku-content.desktop and the sku-content.mobile blocks). |\n| sku-content.desktop | Defines the SKU List layout for desktop devices. |\n| sku-content.mobile | Defines the SKU List layout for mobile devices. |\n| sku-name | Renders the SKU name. |\n| sku-image | Renders the SKU image. |\n| sku-seller | Renders the SKU sellers (if it has any). It uses the seller-name, seller-inventory and seller-price blocks as children in order to display seller data. |\n| seller-name | Renders the SKU seller name. |\n| seller-inventory | Renders the SKU inventory per seller. |\n| seller-price | Renders the SKU price per seller. |\n| sku-price | Renders the SKU price. |\n| sku-inventory | Renders the SKU inventory. |\n| sku-quantity-selector | Renders a quantity selector. |\n| item-quantity | Renders the SKU inventory. |\n| sku-buy-button | Renders a Buy Button to add a given SKU to the minicart. |\n| item-buy-button | Renders a Buy Button to add a given Product to the minicart. |\n| sku-specifications | Renders the SKU specifications. |\n| sku-highlights | Renders a highlight disclaimer for a specific SKU. |\n\n1. In the product template (`store.product`), use the following block structure in order to rebuild the Product Details Page now including the `sku-list` blocks:\n\n`1\n\n{ \n\n2\n\n \"store.product\": { \n\n3\n\n \"children\": [ \n\n4\n\n \"flex-layout.row#product-breadcrumb\", \n\n5\n\n- \"flex-layout.row#product-main\", \n\n6\n\n+ \"flex-layout.row#images-and-items\", \n\n7\n\n+ \"flex-layout.row#buy-button\", \n\n8\n\n \"flex-layout.row#description\", \n\n9\n\n \"shelf.relatedProducts\", \n\n10\n\n \"product-reviews\", \n\n11\n\n \"product-questions-and-answers\" \n\n12\n\n ] \n\n13\n\n }, \n\n14\n\n+ \"flex-layout.row#images-and-items\": { \n\n15\n\n+ \"children\": [ \n\n16\n\n+ \"product-images\", \n\n17\n\n+ \"flex-layout.col#sku-list\" \n\n18\n\n+ ], \n\n19\n\n+ \"props\": { \n\n20\n\n+ \"preventHorizontalStretch\": false \n\n21\n\n+ } \n\n22\n\n+ }, \n\n23\n\n+ \"flex-layout.col#sku-list\": { \n\n24\n\n+ \"children\": [ \n\n25\n\n+ \"flex-layout.row#sku-list-header\", \n\n26\n\n+ \"sku-list\" \n\n27\n\n+ ], \n\n28\n\n+ \"props\": { \n\n29\n\n+ \"preventVerticalStretch\": true, \n\n30\n\n+ \"width\": \"60%\", \n\n31\n\n+ \"blockClass\": \"skuList\" \n\n32\n\n+ } \n\n33\n\n+ }, \n\n34\n\n+ \"flex-layout.row#sku-list-header\": { \n\n35\n\n+ \"props\": { \n\n36\n\n+ \"preventHorizontalStretch\": false, \n\n37\n\n+ \"blockClass\": \"skuListHeader\" \n\n38\n\n+ }, \n\n39\n\n+ \"children\": [ \n\n40\n\n+ \"rich-text#certificates\", \n\n41\n\n+ \"rich-text#expiry-date\", \n\n42\n\n+ \"rich-text#inventory\", \n\n43\n\n+ \"rich-text#price\", \n\n44\n\n+ \"rich-text#quantity-selector\" \n\n45\n\n+ ] \n\n46\n\n+ }, \n\n47\n\n+ \"rich-text#certificates\": { \n\n48\n\n+ \"props\": { \n\n49\n\n+ \"text\": \"**Has Certificates?**\", \n\n50\n\n+ \"blockClass\": \"skuList\", \n\n51\n\n+ \"width\": \"20%\" \n\n52\n\n+ } \n\n53\n\n+ }, \n\n54\n\n+ \"rich-text#expiry-date\": { \n\n55\n\n+ \"props\": { \n\n56\n\n+ \"text\": \"**Expires at**\", \n\n57\n\n+ \"blockClass\": \"skuList\", \n\n58\n\n+ \"width\": \"20%\" \n\n59\n\n+ } \n\n60\n\n+ }, \n\n61\n\n+ \"rich-text#inventory\": { \n\n62\n\n+ \"props\": { \n\n63\n\n+ \"text\": \"**Stock**\", \n\n64\n\n+ \"blockClass\": \"skuList\", \n\n65\n\n+ \"width\": \"20%\" \n\n66\n\n+ } \n\n67\n\n+ }, \n\n68\n\n+ \"rich-text#price\": { \n\n69\n\n+ \"props\": { \n\n70\n\n+ \"text\": \"**Price**\", \n\n71\n\n+ \"blockClass\": \"skuList\", \n\n72\n\n+ \"width\": \"20%\" \n\n73\n\n+ } \n\n74\n\n+ }, \n\n75\n\n+ \"rich-text#quantity-selector\": { \n\n76\n\n+ \"props\": { \n\n77\n\n+ \"text\": \"**Quantity**\", \n\n78\n\n+ \"blockClass\": \"skuList\", \n\n79\n\n+ \"width\": \"20%\" \n\n80\n\n+ } \n\n81\n\n+ }, \n\n82\n\n+ \"sku-list\": { \n\n83\n\n+ \"blocks\": [ \n\n84\n\n+ \"sku-content.desktop\", \n\n85\n\n+ \"sku-content.mobile\" \n\n86\n\n+ ] \n\n87\n\n+ }, \n\n88\n\n+ \"sku-content.desktop\": { \n\n89\n\n+ \"children\": [ \n\n90\n\n+ \"flex-layout.row#item-main-desktop\" \n\n91\n\n+ ] \n\n92\n\n+ }, \n\n93\n\n+ \"flex-layout.row#item-main-desktop\": { \n\n94\n\n+ \"props\": { \n\n95\n\n+ \"preventHorizontalStretch\": false \n\n96\n\n+ }, \n\n97\n\n+ \"children\": [ \n\n98\n\n+ \"flex-layout.col#sku-highlight-certificates\", \n\n99\n\n+ \"flex-layout.col#sku-highlight-expiry-date\", \n\n100\n\n+ \"flex-layout.col#sku-inventory\", \n\n101\n\n+ \"flex-layout.col#sku-price\", \n\n102\n\n+ \"flex-layout.col#sku-quantity-selector\" \n\n103\n\n+ ] \n\n104\n\n+ }, \n\n105\n\n+ \"flex-layout.col#sku-highlight-certificates\": { \n\n106\n\n+ \"props\": { \n\n107\n\n+ \"width\": \"20%\" \n\n108\n\n+ }, \n\n109\n\n+ \"children\": [ \n\n110\n\n+ \"sku-highlights#certificates\" \n\n111\n\n+ ] \n\n112\n\n+ }, \n\n113\n\n+ \"sku-highlights#certificates\": { \n\n114\n\n+ \"props\": { \n\n115\n\n+ \"conditional\": { \n\n116\n\n+ \"highlight\": \"admin/editor.sku-list.highlights.chooseDefaultSpecification\", \n\n117\n\n+ \"typeSpecifications\": \"Has Certificates\" \n\n118\n\n+ }, \n\n119\n\n+ \"showLabel\": false \n\n120\n\n+ } \n\n121\n\n+ }, \n\n122\n\n+ \"flex-layout.col#sku-highlight-expiry-date\": { \n\n123\n\n+ \"props\": { \n\n124\n\n+ \"width\": \"20%\" \n\n125\n\n+ }, \n\n126\n\n+ \"children\": [ \n\n127\n\n+ \"sku-highlights#expiry-date\" \n\n128\n\n+ ] \n\n129\n\n+ }, \n\n130\n\n+ \"sku-highlights#expiry-date\": { \n\n131\n\n+ \"props\": { \n\n132\n\n+ \"conditional\": { \n\n133\n\n+ \"highlight\": \"admin/editor.sku-list.highlights.chooseDefaultSpecification\", \n\n134\n\n+ \"typeSpecifications\": \"Expiry Date\" \n\n135\n\n+ }, \n\n136\n\n+ \"showLabel\": false \n\n137\n\n+ } \n\n138\n\n+ }, \n\n139\n\n+ \"flex-layout.col#sku-inventory\": { \n\n140\n\n+ \"props\": { \n\n141\n\n+ \"width\": \"20%\" \n\n142\n\n+ }, \n\n143\n\n+ \"children\": [ \n\n144\n\n+ \"sku-inventory#default\" \n\n145\n\n+ ] \n\n146\n\n+ }, \n\n147\n\n+ \"sku-inventory#default\": { \n\n148\n\n+ \"props\": { \n\n149\n\n+ \"showLabel\": false \n\n150\n\n+ } \n\n151\n\n+ }, \n\n152\n\n+ \"sku-seller#inventory\": { \n\n153\n\n+ \"children\": [ \n\n154\n\n+ \"seller-inventory\" \n\n155\n\n+ ] \n\n156\n\n+ }, \n\n157\n\n+ \"flex-layout.col#sku-price\": { \n\n158\n\n+ \"props\": { \n\n159\n\n+ \"width\": \"20%\" \n\n160\n\n+ }, \n\n161\n\n+ \"children\": [ \n\n162\n\n+ \"sku-price\" \n\n163\n\n+ ] \n\n164\n\n+ }, \n\n165\n\n+ \"flex-layout.col#sku-quantity-selector\": { \n\n166\n\n+ \"props\": { \n\n167\n\n+ \"width\": \"20%\" \n\n168\n\n+ }, \n\n169\n\n+ \"children\": [ \n\n170\n\n+ \"sku-quantity-selector\" \n\n171\n\n+ ] \n\n172\n\n+ }, \n\n173\n\n+ \"sku-content.mobile\": { \n\n174\n\n+ \"children\": [ \n\n175\n\n+ \"flex-layout.row#item-main-mobile\" \n\n176\n\n+ ] \n\n177\n\n+ }, \n\n178\n\n+ \"flex-layout.row#item-main-mobile\": { \n\n179\n\n+ \"props\": { \n\n180\n\n+ \"preventHorizontalStretch\": false \n\n181\n\n+ }, \n\n182\n\n+ \"children\": [ \n\n183\n\n+ \"flex-layout.col#sku-highlight-certificates-mobile\", \n\n184\n\n+ \"flex-layout.col#sku-highlight-expiry-date-mobile\", \n\n185\n\n+ \"flex-layout.col#sku-inventory-mobile\", \n\n186\n\n+ \"flex-layout.col#sku-price-mobile\", \n\n187\n\n+ \"flex-layout.col#sku-quantity-selector-mobile\" \n\n188\n\n+ ] \n\n189\n\n+ }, \n\n190\n\n+ \"flex-layout.col#sku-highlight-certificates-mobile\": { \n\n191\n\n+ \"props\": { \n\n192\n\n+ \"width\": \"20%\" \n\n193\n\n+ }, \n\n194\n\n+ \"children\": [ \n\n195\n\n+ \"sku-highlights#certificates-mobile\" \n\n196\n\n+ ] \n\n197\n\n+ }, \n\n198\n\n+ \"sku-highlights#certificates-mobile\": { \n\n199\n\n+ \"props\": { \n\n200\n\n+ \"conditional\": { \n\n201\n\n+ \"highlight\": \"admin/editor.sku-list.highlights.chooseDefaultSpecification\", \n\n202\n\n+ \"typeSpecifications\": \"Has Certificates\" \n\n203\n\n+ }, \n\n204\n\n+ \"showLabel\": true \n\n205\n\n+ } \n\n206\n\n+ }, \n\n207\n\n+ \"flex-layout.col#sku-highlight-expiry-date-mobile\": { \n\n208\n\n+ \"props\": { \n\n209\n\n+ \"width\": \"20%\" \n\n210\n\n+ }, \n\n211\n\n+ \"children\": [ \n\n212\n\n+ \"sku-highlights#expiry-date-mobile\" \n\n213\n\n+ ] \n\n214\n\n+ }, \n\n215\n\n+ \"sku-highlights#expiry-date-mobile\": { \n\n216\n\n+ \"props\": { \n\n217\n\n+ \"conditional\": { \n\n218\n\n+ \"highlight\": \"admin/editor.sku-list.highlights.chooseDefaultSpecification\", \n\n219\n\n+ \"typeSpecifications\": \"Expiry Date\" \n\n220\n\n+ }, \n\n221\n\n+ \"showLabel\": true \n\n222\n\n+ } \n\n223\n\n+ }, \n\n224\n\n+ \"flex-layout.col#sku-inventory-mobile\": { \n\n225\n\n+ \"props\": { \n\n226\n\n+ \"width\": \"20%\" \n\n227\n\n+ }, \n\n228\n\n+ \"children\": [ \n\n229\n\n+ \"sku-inventory#default-mobile\" \n\n230\n\n+ ] \n\n231\n\n+ }, \n\n232\n\n+ \"sku-inventory#default-mobile\": { \n\n233\n\n+ \"props\": { \n\n234\n\n+ \"showLabel\": true \n\n235\n\n+ } \n\n236\n\n+ }, \n\n237\n\n+ \"sku-seller#inventory-mobile\": { \n\n238\n\n+ \"children\": [ \n\n239\n\n+ \"seller-inventory#mobile\" \n\n240\n\n+ ] \n\n241\n\n+ }, \n\n242\n\n+ \"seller-inventory#mobile\": { \n\n243\n\n+ \"props\": { \n\n244\n\n+ \"showLabel\": true \n\n245\n\n+ } \n\n246\n\n+ }, \n\n247\n\n+ \"flex-layout.col#sku-price-mobile\": { \n\n248\n\n+ \"props\": { \n\n249\n\n+ \"width\": \"20%\" \n\n250\n\n+ }, \n\n251\n\n+ \"children\": [ \n\n252\n\n+ \"sku-price#mobile\" \n\n253\n\n+ ] \n\n254\n\n+ }, \n\n255\n\n+ \"sku-price#mobile\": { \n\n256\n\n+ \"props\": { \n\n257\n\n+ \"showLabel\": true \n\n258\n\n+ } \n\n259\n\n+ }, \n\n260\n\n+ \"flex-layout.col#sku-quantity-selector-mobile\": { \n\n261\n\n+ \"props\": { \n\n262\n\n+ \"width\": \"20%\" \n\n263\n\n+ }, \n\n264\n\n+ \"children\": [ \n\n265\n\n+ \"sku-quantity-selector\" \n\n266\n\n+ ] \n\n267\n\n+ }, \n\n268\n\n+ \"sku-quantity-selector#mobile\": { \n\n269\n\n+ \"props\": { \n\n270\n\n+ \"showLabel\": true \n\n271\n\n+ } \n\n272\n\n+ }, \n\n`\n\n## Customization\n\nIn order to apply CSS customizations in this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).\n\n| CSS Handles |\n| --------------------------------------- |\n| availableQuantityContainer |\n| buttonDataContainer |\n| buttonItemsPrice |\n| buyButtonContainer |\n| buyButtonText |\n| buyButtonText |\n| colGroupLeadTime |\n| colGroupQuantityBreak |\n| colGroupUnitPrice |\n| highlightContent |\n| highlightTitle |\n| highlightValue |\n| inventory |\n| inventoryContainer |\n| itemHighlight |\n| priceContainer |\n| productPriceBreaksContainer |\n| productPriceBreaksContainer |\n| productPriceQuantityDataColumn |\n| productPriceTable |\n| productPriceTableFooterMultipleColumn |\n| productPriceTableFooterRow |\n| productPriceTableHeader |\n| productPriceTableHeaderRow |\n| productPriceTableHeaderRowData |\n| productPriceTableLeadTimeColumn |\n| productPriceTableMainHeader |\n| productPriceTablePriceColumn |\n| productPriceTableQuantities |\n| productPriceTableRow |\n| productPricingTableTitle |\n| quantitySelectorContainer |\n| quantitySelectorStepper |\n| quantitySelectorTitle |\n| selectedSkuContentWrapper |\n| sellerInventory |\n| sellerInventoryWrapper |\n| sellerName |\n| sellerPriceContainer |\n| skuContentWrapper |\n| skuImage |\n| skuName |\n| specificationItemProperty |\n| specificationItemSpecifications |\n| specificationsTable |\n| specificationsTableContainer |\n| specificationsTablePropertyHeading |\n| specificationsTableSpecificationHeading |\n| specificationsTabsContainer |\n| specificationsTitle |\n\n[Quickorder« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.quickorder)[B2B SuiteNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.b2b-suite)\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.sku-list/docs/apps/vtex.sku-list%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.sku-list/docs/apps/vtex.sku-list%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d5d69845
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides governance and shared security in vtex io apps in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/updates/release-notes)\n\nApp Development\n\n[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-what-is-vtex-io)\n\n---\n\n[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-what-is-a-vtex-app)\n\n---\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\n---\n\n[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/code-samples)\n\n---\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-getting-started)\n\n---\n\nProject structure\n\n---\n\n[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)\n\n---\n\n[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-workspace)\n\n---\n\nManaging apps\n\n---\n\nDevelopment guides\n\n---\n\n[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/app-development-guides)\n\n---\n\n[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/graphql-in-vtex-io)\n\n---\n\n[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-policies)\n\n---\n\n[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)\n\n---\n\n[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-app-store)\n\n---\n\n[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/managing-edition-apps)\n\n---\n\n[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/vtex-io-documentation-frequently-asked-questions)\n\n---\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/app-development)\n\n[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps)\n\nGovernance and shared security in VTEX IO apps\n\nUnderstand the responsibilities of VTEX, developers, and clients for IO apps\n\nIn VTEX IO, each [app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-what-is-a-vtex-app) is a resource on the platform. This means it can interact with other systems on its behalf. These interactions must be duly authorized by the [Sponsor user](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-the-sponsor-user--3oPr7YuIkEYqUGmEqIMSEy) or an [account administrator](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/predefined-roles--jGDurZKJHvHJS13LnO7Dy%23user-administrator-restricted).\n\nSecurity and governance in this environment follow a shared responsibility model:\n\n* VTEX provides and maintains the core security infrastructure.\n* Clients manage tokens and access at the account level.\n* App developers declare the necessary permissions their apps require.\n\nThe sections below outline these responsibilities in detail.\n\n## VTEX responsibilities\n\n* Generating the [available tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens) in the context of VTEX IO.\n* Maintaining the access control infrastructure and license verification via [License Manager](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources).\n* Protecting the token lifecycle.\n* Monitoring and responding to incidents in the ecosystem.\n\n## Client responsibilities\n\n* Creating the necessary tokens for apps that integrate with external (third-party) services.\n* Monitoring how tokens are used.\n* Revoking or rotating tokens periodically to minimize security risks.\n\n## App developer responsibilities\n\n* Declaring the necessary permissions and roles to access any API the app uses in the [manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest).\n* Choosing how permissions are handled when creating an app: \n 1. **User-level permission:** The app only allows actions that match the permissions of the user's assigned token. \n 2. **App-level permission:** The app operates using its own token, granting users the permissions defined for the app itself. This may expand the user’s access beyond what their individual token would normally allow.\n\nTherefore, when creating an app, carefully evaluate the level of permission to be granted for each available token. Assigning unnecessary or excessive permissions can expose the account to security risks.\n\nSee also:\n\n* [App authentication using auth tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/app-authentication-using-auth-tokens)\n* [Discovering VTEX Commerce APIs and authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/calling-commerce-apis-2-discovering-vtex-commerce-apis-and-authentication)\n* [GraphQL authorization in IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/graphql-authorization-in-io-apps)\n* [Security Shared Responsibility Model](https://read.calvincode.net/reader?url=https://compliance.vtex.com/?itemUid=b80a34d3-b6a1-47ca-b274-d6ab7de4749c)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/App-Guides/governance-and-shared-security-in-vtex-io-apps.md)\n\n[What is a VTEX App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps//docs/guides/vtex-io-documentation-what-is-a-vtex-app)[Code samples and templatesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps//docs/guides/code-samples)\n\nContributors\n\n1\n\n[](https://github.com/henriquessb)\n\nON THIS PAGE\n\n[VTEX responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps%23vtex-responsibilities)\n\n[Client responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps%23client-responsibilities)\n\n[App developer responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps%23app-developer-responsibilities)\n\nWas this helpful?\n\n 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/governance-and-shared-security-in-vtex-io-apps.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[VTEX responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps%23vtex-responsibilities)\n\n[Client responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps%23client-responsibilities)\n\n[App developer responsibilities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/governance-and-shared-security-in-vtex-io-apps/docs/guides/governance-and-shared-security-in-vtex-io-apps%23app-developer-responsibilities)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_ffec34df
|
[
{
"role": "system",
"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 issues during extending the faststore api schema in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\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/issues-during-extending-the-faststore-api-schema/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/api-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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/docs/storefront-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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/docs/troubleshooting)\n\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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/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/issues-during-extending-the-faststore-api-schema/docs/troubleshooting)\n\nDevelopment\n\nIssues during extending the FastStore API schema\n\nDevelopment and deployment challenges may arise while extending FastStore API schema with GraphQL.\n\n**Keywords:** FastStore | API extension\n\nAlthough the FastStore API provides a GraphQL schema for ecommerce, you can extend the FastStore API schema to access other or more specific information from your store. During this implementation, you encounter issues such as not having the GraphQL changes you performed aren’t visible during development or in the store production.\n\nBelow are different troubleshooting checks and instructions you can use to solve API extension issues:\n\n* [GraphQL changes not visible during development](#graphql-changes-not-visible-during-development)\n* [Deploy preview/production GraphQL schema different from development](#deploy-previewproduction-graphql-schema-different-from-development)\n* [Type generation errors and warnings](#type-generation-errors-and-warnings) \n * [Error details](#error-details)\n* [GraphQL changes not visible in production/deploy preview](#graphql-changes-not-visible-in-productiondeploy-preview)\n\n## GraphQL changes not visible during development\n\nIf your GraphQL changes aren't visible during development, the changes you have made since you started the development server (`yarn dev`) are probably not optimized.\n\nTo trigger the optimization, run `yarn generate` (recommended) or `yarn run faststore generate-graphql`. Alternatively, you can stop and restart the development server using `yarn dev`.\n\n> This optimization can also be performed while the development server is running.\n\n## Deploy preview/production GraphQL schema different from development\n\nIf you notice differences between the GraphQL schema in your deploy preview or production environment and your development setup, it may be because the schema has not been optimized since the development server's initiation. The build process optimizes the schema before deployment to accurately reflect the schema declared in the store's code.\n\nTo fix the issue, refer to the [GraphQL changes not visible during development](#graphql-changes-not-visible-during-development) topic.\n\n## Type generation errors and warnings\n\nSome errors can occur during GraphQL optimizations and type generation. Here's how to troubleshoot them:\n\n| **Error message** | **Possible cause** | **Solution** |\n| --------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |\n| error Failed to run 'yarn generate:schema'. Please check your setup. | Malformed files in your GraphQL Schema Extensions definitions. | Check the graphql files inside the src/graphql/(vtex or thirdParty)/typeDefs folders for syntax or definition errors. |\n| error GraphQL was not optimized and TS files were not updated. Changes in the GraphQL layer did not take effect | Malformed files or GraphQL types within your GraphQL layer, including errors in GraphQL Schema Extensions, declared queries, and fragments. | Check the graphql files inside the src/graphql/(vtex or thirdParty)/typeDefs folders and component (.ts, tsx) files declaring queries and fragments in your project for syntax or definition errors. |\n| warn: Failed to format generated files. 'yarn format:generated' thrown errors | An issue occurred during the formatting process for the generated GraphQL optimization and types files. | This is a warning, not an error. Your GraphQL layer will still function correctly. If you want to investigate and resolve the formatting issue, follow these steps: 1\\. Retry formatting: Run the yarn format:generated command again. 2\\. Check formatting configuration: Ensure the formatting rules are correct and compatible with the generated files.3\\. Inspect error logs: Look for specific error messages that might provide more clues about the issue. |\n\n### Error details\n\nTo access more detailed error information, use the `--debug` flag when manually running the `yarn generate` command to see detailed errors on why the generation has failed.\n\n## GraphQL changes not visible in production/deploy preview\n\nDuring the build step, the GraphQL optimization and type files are always generated fresh, reflecting the most recent changes in the code.\n\nIf your changes are not visible in production, this means you must not have committed them to the branch you're currently working on. If you see different GraphQL schema, queries, or data during development, refer to the [GraphQL changes not visible during development](#graphql-changes-not-visible-during-development) topic.\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/issues-during-extending-the-faststore-api-schema.md)\n\n[I am getting errors with my service configuration app« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)[I can’t access the Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/unable-to-access-headless-cms)\n\nContributors\n\n2\n\n[](https://github.com/carolinamenezes)\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[GraphQL changes not visible during development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23graphql-changes-not-visible-during-development)\n\n[Deploy preview/production GraphQL schema different from development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23deploy-previewproduction-graphql-schema-different-from-development)\n\n[Type generation errors and warnings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23type-generation-errors-and-warnings)\n\n[Error details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23error-details)\n\n[GraphQL changes not visible in production/deploy preview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23graphql-changes-not-visible-in-productiondeploy-preview)\n\nWas this helpful?\n\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/issues-during-extending-the-faststore-api-schema.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[GraphQL changes not visible during development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23graphql-changes-not-visible-during-development)\n\n[Deploy preview/production GraphQL schema different from development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23deploy-previewproduction-graphql-schema-different-from-development)\n\n[Type generation errors and warnings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23type-generation-errors-and-warnings)\n\n[Error details](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23error-details)\n\n[GraphQL changes not visible in production/deploy preview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/issues-during-extending-the-faststore-api-schema/docs/troubleshooting/issues-during-extending-the-faststore-api-schema%23graphql-changes-not-visible-in-productiondeploy-preview)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_60b46b0f
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore using themes importing ui components styles in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/styling-overview)\n\n[Themes reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/themes-overview)\n\n[Global tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/global-tokens-overview)\n\n[Iconography](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/styling-icons)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-overview)\n\n[Styling the layout and breakpoints](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-mixins-breakpoints)\n\n[Styling a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-components)\n\n[Styling a section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-pages)\n\n[Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/storefront-features-overview)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/styling-overview)\n\n[Using themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-overview)\n\nImporting FastStore UI component styles\n\nIf you are using a [FastStore UI component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index) and want to apply its styles to your FastStore project, follow the steps below.\n\nThere are two different scenarios on how to import FastStore UI component styles:\n\n* [Overriding a component](#importing-styles-when-overriding-a-component): For this use case, we will override the `ProductTitle` component within the `ProductDetails` section.\n* [Creating a new section](#importing-styles-when-creating-a-new-section): For this use case, we will create a new section in the CMS called `OurStore`.\n\n## Before you begin\n\n### Ensure you have a basic understanding of overrides\n\nRefer to the [Overriding components and props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1) and [Creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) guides for more information. In this guide, we will use the [ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1%23product-title) component and [OurStores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section%23ourstore) section.\n\n### Using CSS modules\n\nWe recommend using [CSS Modules](https://read.calvincode.net/reader?url=https://nextjs.org/docs/app/building-your-application/styling/css-modules) to style your new component.\n\n## Importing styles when overriding a component\n\nFor this scenario, we will use as an example the override of the [ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/overrides-components-and-props-v1%23product-title) component within the `ProductDetails` section.\n\n1. Open your FastStore project, navigate to the `components` folder, and create the `customProductTitle.module.scss` file. This file is responsible for importing the FastStore UI component style.\n2. Add the following code to the `customProductTitle.module.scss` file. \n\"customProductTitle.module.scss\" \n`1 \n.customProductTitle { \n2 \n @import '@faststore/ui/src/components/molecules/Tag/styles.scss'; \n3 \n} \n`\n\nThis code imports the [Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-tag) styles to the custom component that you are creating.\n\n1. Import the styles in the `CustomProductTitle.tsx` file and add a `className` to the `section` \nCustomProductTitle.tsx \n`1 \nimport React from 'react' \n2 \nimport { ProductTitle, Tag } from '@faststore/ui' \n3 \n \n4 \n \n5 \nimport styles from './customProductTitle.module.scss' \n6 \n \n7 \nexport default function CustomProductTitle() { \n8 \n return ( \n9 \n <section className={styles.customProductTitle}> \n10 \n <ProductTitle title={<h1>New headphones</h1>} /> \n11 \n <Tag variant=\"warning\" label=\"On sale\" onClose={() => {}} /> \n12 \n </section> \n13 \n ) \n14 \n} \n`\n2. Run `yarn dev` in the terminal and open the local development server to see the changes. You should see a result similar to the image below: \n\n\n## Importing styles when creating a new section\n\nTo follow this guide, we recommend creating the [OurStores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section%23ourstore) section, which we will use as an example.\n\nWith [the section on the page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section%23ourstore), add some styles to it by opening the `components` folder and creating the `ourStores.module.scss` file. This file will import the FastStore UI components styles. Add the following code to the `ourStores.module.scss` file:\n\n\"src/components/ourStores.module.scss\"\n\n`1\n\n.ourStores { \n\n2\n\n @import '@faststore/ui/src/components/atoms/Button/styles.scss'; \n\n3\n\n @import '@faststore/ui/src/components/atoms/Select/styles.scss'; \n\n4\n\n @import '@faststore/ui/src/components/molecules/SelectField/styles.scss'; \n\n5\n\n} \n\n`\n\nThis code imports the [Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-icon) and [SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-select-field) styles to the custom component that you are creating. You also need to import the `Select` component styles since `SelectField` inherits them.\n\n1. Now, import this stylesheet to `OurStores.tsx` file and apply it. \n\"src/components/OurStores.tsx\" \n`1 \nimport React from 'react' \n2 \nimport { Button, Icon, SelectField } from '@faststore/ui' \n3 \n \n4 \nimport styles from './ourStores.module.scss' \n5 \n \n6 \nexport interface OurStoresProps { \n7 \n title: string \n8 \n description: string \n9 \n} \n10 \n \n11 \nexport default function OurStores(props: OurStoresProps) { \n12 \n return ( \n13 \n <section className={styles.ourStores}> \n14 \n <h2>{props.title}</h2> \n15 \n <p>{props.description}</p> \n16 \n <div> \n17 \n <SelectField \n18 \n id=\"select-state-store\" \n19 \n label=\"State:\" \n20 \n options={{ \n21 \n newYork: 'New York', \n22 \n arizona: 'Arizona', \n23 \n massachusetts: 'Massachusetts', \n24 \n hawaii: 'Hawaii', \n25 \n }} \n26 \n /> \n27 \n <SelectField \n28 \n id=\"select-city-store\" \n29 \n label=\"City:\" \n30 \n options={{ \n31 \n newYorkCity: 'New York City', \n32 \n phoenix: 'Phoenix', \n33 \n boston: 'Boston', \n34 \n honolulu: 'Honolulu', \n35 \n }} \n36 \n /> \n37 \n <Button \n38 \n variant=\"secondary\" \n39 \n icon={<Icon name=\"ArrowRight\" />} \n40 \n iconPosition=\"right\" \n41 \n > \n42 \n Find Store \n43 \n </Button> \n44 \n </div> \n45 \n </section> \n46 \n ) \n47 \n} \n`\n\nYou should be able to see something like the following:\n\n\n\n1. Let's add more styles to it. You can customize it using the [design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/global-tokens-overview%23global-tokens) and [component's data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/atoms-button%23customization). \n\"src/components/ourStores.module.scss\" \n`1 \n.ourStores { \n2 \n @import '@faststore/ui/src/components/atoms/Button/styles.scss'; \n3 \n @import '@faststore/ui/src/components/atoms/Select/styles.scss'; \n4 \n @import '@faststore/ui/src/components/molecules/SelectField/styles.scss'; \n5 \n \n6 \n width: 100%; \n7 \n display: flex; \n8 \n flex-direction: column; \n9 \n justify-content: center; \n10 \n align-items: center; \n11 \n padding: var(--fs-spacing-5); \n12 \n margin: auto; \n13 \n background-color: var(--fs-color-neutral-bkg); \n14 \n \n15 \n [data-fs-select-field] { \n16 \n flex-direction: column; \n17 \n align-items: flex-start; \n18 \n \n19 \n [data-fs-select] { \n20 \n border: var(--fs-border-width) solid var(--fs-border-color); \n21 \n margin-top: var(--fs-spacing-0); \n22 \n width: 10rem; \n23 \n height: var(--fs-control-min-height); \n24 \n \n25 \n select { \n26 \n width: 100%; \n27 \n } \n28 \n } \n29 \n } \n30 \n} \n31 \n \n32 \n.ourStores__title { \n33 \n font-size: var(--fs-text-size-title-section); \n34 \n margin-bottom: var(--fs-spacing-1); \n35 \n} \n36 \n \n37 \n.ourStores__content { \n38 \n display: flex; \n39 \n align-items: flex-end; \n40 \n column-gap: var(--fs-spacing-5); \n41 \n margin: var(--fs-spacing-5); \n42 \n} \n` \n\"src/components/OurStores.tsx\" \n`1 \nimport React from 'react' \n2 \nimport { Button, Icon, SelectField } from '@faststore/ui' \n3 \n \n4 \nimport styles from './ourStores.module.scss' \n5 \n \n6 \nexport interface OurStoresProps { \n7 \n title: string \n8 \n description: string \n9 \n} \n10 \n \n11 \nexport default function OurStores(props: OurStoresProps) { \n12 \n return ( \n13 \n <section className={styles.ourStores}> \n14 \n <h2 className={styles.ourStores__title}>{props.title}</h2> \n15 \n <p>{props.description}</p> \n16 \n <div className={styles.ourStores__content}> \n17 \n <SelectField \n18 \n id=\"select-state-store\" \n19 \n label=\"State:\" \n20 \n options={{ \n21 \n newYork: 'New York', \n22 \n arizona: 'Arizona', \n23 \n massachusetts: 'Massachusetts', \n24 \n hawaii: 'Hawaii', \n25 \n }} \n26 \n /> \n27 \n <SelectField \n28 \n id=\"select-city-store\" \n29 \n label=\"City:\" \n30 \n options={{ \n31 \n newYorkCity: 'New York City', \n32 \n phoenix: 'Phoenix', \n33 \n boston: 'Boston', \n34 \n honolulu: 'Honolulu', \n35 \n }} \n36 \n /> \n37 \n <Button \n38 \n variant=\"secondary\" \n39 \n icon={<Icon name=\"ArrowRight\" />} \n40 \n iconPosition=\"right\" \n41 \n > \n42 \n Find Store \n43 \n </Button> \n44 \n </div> \n45 \n </section> \n46 \n ) \n47 \n} \n`\n\nAfter applying these additional styles, you should be able to see this final look:\n\n\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/using-themes/importing-ui-components-styles.mdx)\n\n[Styling a section« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-pages)[UI componentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/components-index)\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/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23before-you-begin)\n\n[Ensure you have a basic understanding of overrides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23ensure-you-have-a-basic-understanding-of-overrides)[Using CSS modules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23using-css-modules)\n\n[Importing styles when overriding a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23importing-styles-when-overriding-a-component)\n\n[Importing styles when creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23importing-styles-when-creating-a-new-section)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/styling/using-themes/importing-ui-components-styles.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23before-you-begin)\n\n[Ensure you have a basic understanding of overrides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23ensure-you-have-a-basic-understanding-of-overrides)[Using CSS modules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23using-css-modules)\n\n[Importing styles when overriding a component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23importing-styles-when-overriding-a-component)\n\n[Importing styles when creating a new section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles/docs/guides/faststore/using-themes-importing-ui-components-styles%23importing-styles-when-creating-a-new-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_2f6f1c65
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides alternative api requests in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/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/alternative-api-requests/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/alternative-api-requests/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/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/alternative-api-requests/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/catalog-integration)\n\n[Categories](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/categories)\n\n[Brands](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/brands)\n\n[Products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/products)\n\n[Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/specifications)\n\n[Product specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/product-specifications)\n\n[SKU specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/sku-specifications)\n\n[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/updating-sku-specifications-with-catalog-api)\n\n[SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/skus)\n\n[Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/images)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/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/alternative-api-requests/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/alternative-api-requests/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/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/alternative-api-requests/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides)\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/catalog-integration)\n\n[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/alternative-api-requests)\n\nAlternative API requests\n\nAs you may have noticed, many catalog API requests use VTEX IDs in order to create and update values. Fields like `BrandId`, `FieldId`, `FieldValueId`, `GroupId` and `CategoryId`.\n\nWhile it is important to keep track of these IDs, there are some alternative endpoints that do not require them for performing some tasks.\n\n## Create product using brand name and category path\n\n[Create product API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/post-product)\n\n### Example body:\n\n`1\n\n{ \n\n2\n\n \"Name\": \"Test Product\", \n\n3\n\n \"CategoryPath\": \"Storage/Hard Drive\", \n\n4\n\n \"BrandName\": \"Sample Brand\", \n\n5\n\n \"RefId\": \"310117069123\", \n\n6\n\n \"Title\": \"Browser Title for this product\", \n\n7\n\n \"LinkId\": \"test-product\", \n\n8\n\n \"Description\": \"This is a cool product\", \n\n9\n\n \"ReleaseDate\": \"2019-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\": \"tag test\", \n\n14\n\n \"ShowWithoutStock\": true, \n\n15\n\n \"Score\": 1 \n\n16\n\n} \n\n`\n\n## Create product specification using field, group names\n\nAPI request: [Associate product specification using specification and group names](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/put%5Fapi-catalog-pvt-product-productid-specificationvalue)\n\n### Example body\n\n`1\n\n{ \n\n2\n\n \"FieldName\": \"TesteAPI\", \n\n3\n\n \"GroupName\": \"TestGroup\", \n\n4\n\n \"RootLevelSpecification\": true, \n\n5\n\n \"FieldValues\": [ \n\n6\n\n \"Value123\" \n\n7\n\n ] \n\n8\n\n} \n\n`\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/catalog-integration/alternative-api-requests.md)\n\n[Images« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests//docs/guides/images)[How to implement product color variationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests//docs/guides/how-to-implement-product-color-variation)\n\nContributors\n\n1\n\n[](https://github.com/brunoamui)\n\nON THIS PAGE\n\n[Create product using brand name and category path](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/alternative-api-requests%23create-product-using-brand-name-and-category-path)\n\n[Example body:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/alternative-api-requests%23example-body)\n\n[Create product specification using field, group names](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/alternative-api-requests%23create-product-specification-using-field-group-names)\n\n[Example body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/alternative-api-requests%23example-body)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/catalog-integration/alternative-api-requests.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Create product using brand name and category path](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/alternative-api-requests%23create-product-using-brand-name-and-category-path)\n\n[Example body:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/alternative-api-requests%23example-body)\n\n[Create product specification using field, group names](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/alternative-api-requests%23create-product-specification-using-field-group-names)\n\n[Example body](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/alternative-api-requests/docs/guides/alternative-api-requests%23example-body)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_0648540a
|
[
{
"role": "system",
"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 ProductName 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/ProductName/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/ProductName/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductName/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductName/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductName/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductName/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/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/ProductName/docs/vtex-io-apps)\n\nProduct Name\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 `product-name` block is responsible for displaying a product name along with other information about the product, such as the **SKU** or **brand**.\n\n\n\n## Configuration\n\n1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file, as in the following example:\n\n`1\n\n \"dependencies\": { \n\n2\n\n \"vtex.store-components\": \"3.x\" \n\n3\n\n } \n\n`\n\n1. Add the `product-name` block to any child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n \"flex-layout.row#product\", \n\n4\n\n ] \n\n5\n\n }, \n\n6\n\n \"flex-layout.row#product\": { \n\n7\n\n \"children\": [ \n\n8\n\n+ \"product-name\" \n\n9\n\n ] \n\n10\n\n }, \n\n`\n\n1. Then, declare the `product-name` block using the props stated in the [Props](#props) table. For example:\n\n`1\n\n \"product-name\": { \n\n2\n\n \"props\": { \n\n3\n\n \"showSku\": true, \n\n4\n\n \"showBrandName\": true \n\n5\n\n } \n\n6\n\n }, \n\n`\n\n### Props\n\n| Prop name | Type | Description | Default value |\n| -------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| classes | CustomCSSClasses | Overrides default CSS handles. For further information, please refer to [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined |\n| displayMode | enum | Displays the product name (plainText) or the link to the product page (linkToProductPage). | plainText |\n| showBrandName | boolean | Displays the brand name. | false |\n| showProductReference | boolean | Displays the product reference code. | false |\n| showSku | boolean | Displays the SKU value. | false |\n| showSponsoredBadge | boolean | Displays a sponsored badge above the product's name. | false |\n| sponsoredBadgeLabel | string | Text of the sponsored badge if it's rendered. | \"\" |\n| tag | string | Defines the HTML tag of the product container. Possible values are: div, h1, h2, h3. | div |\n\n## Customization\n\nTo apply CSS customizations in this and other blocks, follow the [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.\n\n| CSS Handles |\n| ---------------------- |\n| productBrand |\n| productNameBrandLoader |\n| productNameContainer |\n| productNameLoader |\n| productNameSkuLoader |\n| productReference |\n| productSku |\n| sponsoredBadge |\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/ProductName/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/ProductName/docs/apps/vtex.store-components@3.178.5/ProductName%23configuration)\n\n[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductName/docs/apps/vtex.store-components@3.178.5/ProductName%23props)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components@3.178.5/ProductName/docs/apps/vtex.store-components@3.178.5/ProductName%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_febe6777
|
[
{
"role": "system",
"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 audara 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.audara/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/api-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.audara/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.audara/docs/storefront-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.audara/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.audara/docs/troubleshooting)\n\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.audara/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/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.audara/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/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.audara/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.audara/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/guides/pixel-apps)\n\nAudara\n\nOfficial extension\n\nVersion: 1.0.3\n\nLatest version: 1.0.3\n\n> VTEX Audara first-party app\n\n## Setup\n\nOpen a terminal and type:\n\n`1\n\nvtex install vtex.audara@1.x \n\n`\n\nOpen your admin in the Apps section:\n\n<https://YOURSTORENAME.myvtex.com/admin/apps/vtex.audara@1.0.0/setup>\n\nFill in your Audara's Account ID and click save.\n\n[Alexa Certify« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.alexa-certify-code)[BluecoreNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.bluecore)\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[Setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.audara/docs/apps/vtex.audara%23setup)\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_35c7a5dc
|
[
{
"role": "system",
"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 cookiebot 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.cookiebot/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/api-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.cookiebot/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.cookiebot/docs/storefront-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.cookiebot/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.cookiebot/docs/troubleshooting)\n\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.cookiebot/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/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.cookiebot/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/pixel-apps)\n\n[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.alexa-certify-code)\n\n[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.audara)\n\n[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.bluecore)\n\n[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.blueknow)\n\n[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.btg360)\n\n[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.cookiebot)\n\n[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.cookie-script)\n\n[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.cybersource-fingerprint)\n\n[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.elfsight)\n\n[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.facebook-pixel)\n\n[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.facebook-domain-verification)\n\n[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.google-adwords)\n\n[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.google-customer-reviews)\n\n[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.hotjar)\n\n[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.ideacrm)\n\n[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.iubenda)\n\n[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.jivochat)\n\n[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.kelkoo)\n\n[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.logrocket)\n\n[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.lucky-orange)\n\n[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.google-search-console)\n\n[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.shareasale)\n\n[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.smarthint)\n\n[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.suite-share)\n\n[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.tawk-to)\n\n[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.trustpilot)\n\n[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.zendesk-chat)\n\n[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.zopim)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/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.cookiebot/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.cookiebot/docs/vtex-io-apps)\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/guides/pixel-apps)\n\nCookiebot\n\nOfficial extension\n\nVersion: 2.0.8\n\nLatest version: 2.0.8\n\n[](#contributors-)\n\nThis is a Cookiebot first party integration app. The [solution](https://read.calvincode.net/reader?url=https://www.cookiebot.com/) helps make your use of cookies and online tracking compliant.\n\n\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/installing-an-app/) the `vtex.cookiebot` app;\n2. In your VTEX account's admin, open the **App** section and select the Cookiebot App box;\n3. Fill in your **Domain Group ID**. You can find yours at the [Cookiebot Settings page](https://read.calvincode.net/reader?url=https://manage.cookiebot.com/en/manage);\n\n\n\n1. On the [Settings page](https://read.calvincode.net/reader?url=https://manage.cookiebot.com/en/manage), make sure you use **Active Consent**;\n \n \n1. On the [Cookies page](https://read.calvincode.net/reader?url=https://manage.cookiebot.com/en/cookies), run a Scan. After the scan is complete, make sure the following cookies are categorized as **Necessary**: `ASPXAUTH`, `checkout.vtex.com`, `CookieConsent`, `device`, `vtex_segment`, `vtex_session`, `VtexFingerPrint`, `VtexRCMacIdv7`, `VtexRCRequestCounter`, `VtexRCSessionIdv7`, `VtexWorkspace`;\n2. Save your changes.\n\nThis pixel app also creates the page `/cookie-declaration` in your store with Cookiebot's Cookie declaration:\n\n\n\nYou can edit the new page using the admin's Site Editor.\n\n[BTG360« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.btg360)[Cookie ScriptNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.cookiebot/docs/apps/vtex.cookie-script)\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.cookiebot/docs/apps/vtex.cookiebot%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_a55626b4
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides querying documents in 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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-master-data-v1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-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/querying-documents-in-master-data-v1/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-master-data-v1/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-master-data-v1/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-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/querying-documents-in-master-data-v1/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-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/querying-documents-in-master-data-v1/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/master-data)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-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/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1)\n\nQuerying documents in Master Data v1\n\nThere are two ways to search for Master Data v1 documents:\n\n* [Query a specific document by ID](#query-by-document-id)\n* [Query a collection of documents](#query-a-collection-of-documents)\n\n## Query by document ID\n\nThe ID is the most efficient reference to the exact storage address, so this type of query is the fastest way of recovering data. We recommend using the `GET` [Get document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/documents/-id-) endpoint to retrieve a document by its ID.\n\n## Query a collection of documents\n\nIn this type of search, the fields marked as **Is searchable?** or **Is filterable?** and the fields set as [indices](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-an-index-on-master-data--tutorials%5F785) in Master Data v1 data entity settings determine results. But they are not the only ones you should use. The **indices** are also part of this process. The best way of understanding the flow of this type of search is to look at an example.\n\nIn the example below, there is a data entity called `Client`, with the `CL` acronym, configured as follows:\n\n| Field name | Type | **Is filterable?** | **Is searchable?** |\n| ---------- | ----------- | ------------------ | ------------------ |\n| Email | Email | Yes | Yes |\n| Name | Varchar 100 | No | Yes |\n| Age | Integer | Yes | No |\n| Size | Varchar 10 | No | No |\n\n### Is filterable?\n\nThe **Is filterable?** attribute indicates that we can use a filter via a specific field or fields. Following the example, we can filter through the fields `Email` and `Age`.\n\nUsing the `GET` [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search) endpoint of [Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api), we can make the following queries:\n\n* Filter by `Email`: `/dataentities/CL/search?Email=meuemail@provider.com`\n* Filter by `Age`: `/dataentities/CL/search?Age=18`\n\nIf a filter is used in the `Name`, field, which is not marked as a filter, the answer will be `Bad Request` indicating that the `Name` field is not configured as a filter.\n\n### Is searchable?\n\nThe attribute **Is searchable?** indicates that we can search this field's values via the `_keyword` attribute in the `GET` [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search) endpoint of [Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api).\n\nThe `_keyword` would be used, for example, to retrieve all the documents containing the value `mary`.\n\nIn this case, the API path would be: `/dataentities/CL/search?_keyword=maria`\n\nAsterisks are indicators for a partial query. In other words, documents with the exact value `mary`, will not be searched for, but only those showing this group of characters somewhere.\n\nThe result of this query would return documents with values such as the following in the attributes `Name` and `Email`: `Name=Mary Lee | Email=mary@mail.com`.\n\n### Indices\n\nAn [index](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-an-index-on-master-data--tutorials%5F785) works as a shortcut to find documents. Using this resource, the query is quicker than with a normal filter or keyword search.\n\nHowever, the greater the number of indexes, the more slowly documents are written. The use of the index is recommended for search results of up to 1 thousand documents.\n\nQueries by indexes can be made through the `GET` [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search) endpoint. In the search flow, when Master Data interprets a query, it checks if the filter is part of an index and, if so, the search is done through the index.\n\n### Reindexing\n\nMaster Data reindexing is a background process that works as follows:\n\n1. It reads the configurations of fields marked as **Is filterable?** and **Is searchable?**.\n2. It updates the search engine with the new fields.\n3. It searches all stored documents and updates the values in the search engine.\n\nWhen the fields of a document are written in the search engine, it means this document is indexed.\n\nThis process only happens when fields marked as **Is filterable?** or **Is searchable?** are changed.\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/querying-documents-in-master-data-v1.md)\n\n[Master Data v1« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1//docs/guides/master-data-v1)[Implementing newletter opt-in with Master Data v1Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1//docs/guides/implementing-newsletter-opt-in-with-master-data-v1)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Query by document ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23query-by-document-id)\n\n[Query a collection of documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23query-a-collection-of-documents)\n\n[Is filterable?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23is-filterable)[Is searchable?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23is-searchable)[Indices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23indices)[Reindexing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23reindexing)\n\nWas this helpful?\n\n 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/querying-documents-in-master-data-v1.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Query by document ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23query-by-document-id)\n\n[Query a collection of documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23query-a-collection-of-documents)\n\n[Is filterable?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23is-filterable)[Is searchable?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23is-searchable)[Indices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23indices)[Reindexing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/querying-documents-in-master-data-v1/docs/guides/querying-documents-in-master-data-v1%23reindexing)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_dc98b081
|
[
{
"role": "system",
"content": "You are a VTEX 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 footer in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-footer/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-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/guides/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/guides/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/guides/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/guides/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/guides/vtex-store-footer/updates/release-notes)\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer/updates/release-notes)\n\nFooter\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\": [\"flex-layout.row#footer-desktop\"] \n\n7\n\n }, \n\n8\n\n \"footer-layout.mobile\": { \n\n9\n\n \"children\": [\"flex-layout.row#footer-mobile\"] \n\n10\n\n }, \n\n11\n\n \"flex-layout.row#footer-desktop\": { \n\n12\n\n \"children\": [\"social-networks\", \"accepted-payment-methods\", \"powered-by\"] \n\n13\n\n }, \n\n14\n\n \"flex-layout.row#footer-mobile\": { \n\n15\n\n \"children\": [\"social-networks\", \"accepted-payment-methods\", \"powered-by\"] \n\n16\n\n }, \n\n17\n\n \"social-networks\": { \n\n18\n\n \"props\": { \n\n19\n\n \"socialNetworks\": [ \n\n20\n\n { \"url\": \"https://facebook.com/foo\", \"name\": \"Facebook\" }, \n\n21\n\n { \"url\": \"https://twitter.com/foo\", \"name\": \"Twitter\" } \n\n22\n\n ] \n\n23\n\n } \n\n24\n\n }, \n\n25\n\n \"accepted-payment-methods\": { \n\n26\n\n \"props\": { \n\n27\n\n \"paymentMethods\": [\"mastercard\", \"visa\", \"diners club\"] \n\n28\n\n } \n\n29\n\n } \n\n30\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://developers.vtex.com/docs/guides/vtex-io-documentation-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\nContributors\n\n1\n\n[](https://github.com/carolinamenezes)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-store-footer.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-footer/docs/guides/vtex-store-footer%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer/docs/guides/vtex-store-footer%23customization)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-store-footer.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-footer/docs/guides/vtex-store-footer%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-footer/docs/guides/vtex-store-footer%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_a98a319b
|
[
{
"role": "system",
"content": "You are a VTEX 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 master data v2 triggers to interact with orders in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-master-data-v2-triggers-to-interact-with-orders/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/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-master-data-v2-triggers-to-interact-with-orders/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/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-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/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/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\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-master-data-v2-triggers-to-interact-with-orders/docs/guides/data-protection-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-master-data-v2-triggers-to-interact-with-orders/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/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-master-data-v2-triggers-to-interact-with-orders/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/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-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed)\n\n[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/order-modifications)\n\n[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/change-seller)\n\n[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/order-canceling-improvements)\n\n[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/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/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\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-master-data-v2-triggers-to-interact-with-orders/docs/guides/data-protection-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-master-data-v2-triggers-to-interact-with-orders/docs/guides)\n\nOrders\n\n[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed)\n\nFeed v3\n\nThe [order feed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-overview%23feed-v3) is a list of order updates. This means that whenever an order is updated, the event is included as a new entry in the feed. Updates can include status changes, items added or removed by the store, order delivered, and others.\n\nIn this sense, the feed is not a list of orders, but rather a list of events. For example, if the status of an order is changed to `Approve payment` and then to `Authorize shipping`, the feed will receive two events: one for each update, both related to the same order. You can configure the feed to filter the updates that will actually generate feed events, instead of having all updates in all orders generating events in the feed queue.\n\nThis guide explains how Feed and Hook work and how to configure them to build order integrations. Also, in the latter part of the article, we explain the differences between each and when to choose one over the other based on the specific needs of your operation.\n\n> Feed and Hook are independent configurations to build order integrations.\n\n## Best practices for integrations\n\nWhen designing an orders integration, consider the practices below to increase performance and avoid throttling errors:\n\n* Optimize your code to get only the required data.\n* Use caching for often-used data.\n* Consider including code that catches errors. By ignoring these errors and persisting in making requests, your app will not be able to recover gracefully.\n* After getting a 429 status code error, you should stop making additional API requests and wait before retrying. We recommend a 1-minute backoff time.\n* Configure your integration to communicate asynchronously with VTEX APIs in order to keep requests in a queue and do other processing tasks while waiting for the next queued job to run.\n\n> If your integration is getting 429 status code errors, we recommend you to regulate the rate of your requests for smoother distribution. When the account exceeds the request limit, VTEX Admin might also become unavailable.\n\n## Order integration: Feed vs. List orders\n\nSome stores use the List orders API request to check order status changes. However, this method only returns orders that have already been indexed, which may lead to some problems:\n\n* If a problem in the system prevents indexing, you will not be able to consume the order list, and order updates may not be visible.\n* Because the `list` method depends on indexing, it's slower and performs less than the feed.\n\nOn the other hand, the feed has been specifically developed to track order updates. It runs before indexing and doesn't depend on it, making it the most reliable and fastest method to track order updates.\n\n> If you have an integration based on the List orders API request, you should migrate it to the feed. However, keep in mind that this means changing the integration flow. Read the [order integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration) to learn how to implement this change.\n\n## Access\n\nConfiguring and using Feed v3 and Hook is only allowed when authorization is granted in the Order Management module.\n\nThe feed's API key must have a [role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc%23) with one of the appropriate resources: `Feed v3 and Hook Admin` or `Feed v3 and Hook view only`, depending on the intended use.\n\n> Each [appKey](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/api-keys--4bFEmcHXgpNksoePchZyy6) can configure or access only one feed. This means that different users sharing an appKey access the same feed. In this case, if a user commits an item to the queue, the item is removed from the feed and won't be available for any users sharing the same appKey. Therefore, we recommend configuring one feed per appKey per user, ensuring that each user has access to their own feed.\n\n## Configuration\n\nThe feed is set up through a POST request to the [Create or update Feed configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/feed/config) endpoint.\n\nThe body of this request has two objects, the `filter` and the `queue`.\n\n### `filter`\n\nWhen you configure the filter, you define which order updates should be displayed in the feed. Two types of filters can be used in the feed: `FromWorkflow` and `FromOrders`. You can see an example and description of each filter below.\n\n#### `FromWorkflow`\n\nWhen you use the `FromWorkflow` configuration, you can only filter order updates by status. You can pass an array of statuses in the field `status`, and whenever an order status is changed to one of those statuses, an update will appear in the feed.\n\nYou can see the list of possible order statuses in the article [Order flow in orders management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-de-pedido/%23understanding-the-status).\n\n`1\n\n\"filter\": { \n\n2\n\n \"type\": \"FromWorkflow\", \n\n3\n\n \"status\": [ \n\n4\n\n \"order-completed\", \n\n5\n\n \"ready-for-handling\", \n\n6\n\n \"start-handling\", \n\n7\n\n \"handling\", \n\n8\n\n \"waiting-ffmt-authorization\", \n\n9\n\n \"cancel\" \n\n10\n\n ] \n\n11\n\n } \n\n`\n\n> The `FromWorkflow` filter may be limited for some of the integration needs of your store. If you want more filter options, consider using the `FromOrders` filter.\n\n#### `FromOrders`\n\n`FromOrders` allows you to filter updates in your feed by any property in the order JSON document, not only status changes. This is done with a JSONata expression passed in the `expression` field.\n\n`1\n\n\"filter\": { \n\n2\n\n \"type\": \"FromOrders\", \n\n3\n\n \"expression\": \"status = \\\"payment-pending\\\"\", \n\n4\n\n \"disableSingleFire\": false \n\n5\n\n } \n\n`\n\n> The two filter types are mutually exclusive. If you pass `FromWorkflow` in the `type` field, you should not include the `expression` field nor `disableSingleFire` in the body. The reverse is also true. If you pass `FromOrders` `type`, you should not include the `status` field. If you combine them, you will get a `409 conflict` status response.\n\n> If the `filter` is not configured, the `FromWorkflow` type is used, and all status changes will appear in the feed.\n\n##### `expression`\n\nThis field receives a string with a JSONata query expression that defines what conditions must be met for an order to be included in the feed.\n\nJSONata is a query and transformation language for JSON data. You can learn more about it in the [JSONata documentation](https://read.calvincode.net/reader?url=https://docs.jsonata.org/overview.html).\n\nThis filter offers many possibilities that can't be achieved with the `FromWorkflow` configuration. For example, you can filter orders that have been delivered or had items added or removed by the store. You can also combine two or more selection criteria. See the examples below:\n\n* Delivered orders\n\n`1\n\nfinished = true \n\n`\n\n* Orders with added items\n\n`1\n\n$count(changesAttachment.changesData.itemsAdded) > 0 \n\n`\n\n* Orders with removed items\n\n`1\n\n$count(changesAttachment.changesData.itemsRemoved) > 0 \n\n`\n\nYou can also filter multiple properties at the same time. For example, the following is an expression that filters orders that contain at least one refrigerator that costs at least $1000.00:\n\n`1\n\n$count(items[name ~> /.*refrigerator.*/i and price>=1000]) > 0 \n\n`\n\nHere are some additional expression examples:\n\n* Order in specific status and trade policy (sales channel)\n\n`1\n\n(status = \"ready-for-handling\" and salesChannel=\"2\") \n\n`\n\n* Orders from a seller that don't have a specific [trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV) (sales channel)\n\n`1\n\n(salesChannel.Id != \"3\" and sellers.id =\"sellerId\") \n\n`\n\n* Order with refund/item return\n\n`1\n\n$count(packageAttachment.packages.restitutions.Refund.value) > 0 \n\n`\n\n* Order invoiced with a specific shipping policy\n\n`1\n\nstatus = \"invoiced\" and (packageAttachment.packages[$[$contains($string(courier), \"Carrier Name\")]]) \n\n`\n\n> Keep in mind that the `expression` field receives only strings and all JSONata expressions have to be escaped. For example, the expression `status = “canceled”` has to be passed as `”status = \\\\”canceled\\\\””` to be read correctly by the API.\n\nThe following is an example of a complete `filter` object with a more complex and escaped JSONata expression.\n\n`1\n\n\"filter\": { \n\n2\n\n \"type\": \"FromOrders\", \n\n3\n\n \"expression\": \"(status = \\\"handling\\\" and salesChannel = \\\"2\\\" and $count(packageAttachment.packages.restitutions.Refund.value) > 0)\", \n\n4\n\n “disableSingleFire”: false \n\n5\n\n}, \n\n`\n\n##### Expression tests\n\nYou should validate the events of the configured expression before implementing the filter in your integration. There are three useful tests:\n\n* [The API endpoint for JSONata Testing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/expressions/jsonata).\n* [JSONata Exerciser](https://read.calvincode.net/reader?url=https://try.jsonata.org/) which tests the expression against a real JSON file. To run this test, copy the order to JSONata Exerciser and simulate different expressions and requests. Use an order extracted from the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23get-/api/orders/pvt/document/-orderId-) endpoint from the [Orders API - PII data architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23overview). \n> Be aware that the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api-pii-version%23get-/api/orders/pvt/document/-orderId-) endpoint from **Orders API - PII data architecture** differs from the [Get order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/oms/pvt/orders/-orderId-) endpoint from **Orders API**.\n* Configure a test feed or hook with a test [appKey](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-authentication) and check whether the events behave as expected.\n\n##### `disableSingleFire`\n\nThis field limits how often a specific order shows in the feed after it meets the filter conditions. If this field is `false`, orders will appear in the feed only once.\n\n> The `FromOrders` filter receives order updates whenever any change is made to the order JSON document, provided the order meets the criteria set in the `expression` field. Because of this, if the `disableSingleFire` field is set to `true`, orders may appear more than once in a feed — even hundreds of times in some cases. To prevent that from happening, keep `disableSingleFire` set to `false`.\n\n### `queue`\n\nThe properties of this object define the behavior of feed items once they are included in the feed or are retrieved. This is an example of the `queue` object:\n\n`1\n\n\"queue\": { \n\n2\n\n \"visibilityTimeoutInSeconds\": 240, \n\n3\n\n \"messageRetentionPeriodInSeconds\": 345600 \n\n4\n\n } \n\n`\n\n* `visibilityTimeoutInSeconds` \\- This is the maximum time after retrieving an item from the feed when it can be [committed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/feed). When a user retrieves the events from the feed queue using the [Retrieve Feed items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed) API request, the returned items are omitted from the feed for the time set in this field. Then, the user may take any necessary actions and [commit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/feed) the items to the feed. If events are not committed, they are returned to the feed after this time expires.\n* `MessageRetentionPeriodInSeconds` \\- Items will be excluded from the feed — even if they aren't [committed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/feed) — when they stay in the feed longer than the retention period defined in this field.\n\n> The minimum value for the `messageRetentionPeriodInSeconds` field is `345600` and the maximum is `1209600`.\n\n### Other fields\n\nThere are also a couple of other fields that give us some information about the state of the field:\n\n* `quantity`: Current number of messages in the feed, including messages that may not be visible due to time out after retrieval.\n* `approximateAgeOfOldestMessageInSeconds`: Approximate age of the oldest message in the feed (in seconds).\n\n### Examples\n\nHere are two complete example bodies for the [Feed configuration response](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed/config), using each `filter` type:\n\n`1\n\n{ \n\n2\n\n \"filter\": { \n\n3\n\n \"type\": \"FromWorkflow\", \n\n4\n\n \"status\": [ \n\n5\n\n “order-completed”, \n\n6\n\n \"ready-for-handling\", \n\n7\n\n “start-handling”, \n\n8\n\n “handling”, \n\n9\n\n “waiting-ffmt-authorization”, \n\n10\n\n “cancel” \n\n11\n\n ] \n\n12\n\n }, \n\n13\n\n \"queue\": { \n\n14\n\n \"visibilityTimeoutInSeconds\": 240, \n\n15\n\n \"messageRetentionPeriodInSeconds\": 345600 \n\n16\n\n }, \n\n17\n\n \"quantity\": 1261, \n\n18\n\n \"aproximateAgeOfOldestMessageInSeconds\": 1113.349305555555 \n\n19\n\n} \n\n`\n\n`1\n\n{ \n\n2\n\n \"filter\": { \n\n3\n\n \"type\": \"FromOrders\", \n\n4\n\n \"expression\": \"status = \\\"payment-pending\\\"\", \n\n5\n\n \"disableSingleFire\": false \n\n6\n\n }, \n\n7\n\n \"queue\": { \n\n8\n\n \"visibilityTimeoutInSeconds\": 240, \n\n9\n\n \"messageRetentionPeriodInSeconds\": 345600 \n\n10\n\n }, \n\n11\n\n \"quantity\": 1261, \n\n12\n\n \"aproximateAgeOfOldestMessageInSeconds\": 1113.349305555555 \n\n13\n\n} \n\n`\n\n> When a new feed is configured, its queue contains any orders that are changed right after the setup is complete. If the feed is reconfigured, events from the former queue will remain in the feed until they are [committed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/feed) or the retention period expires.\n\n> If the feed doesn't receive any new events in its queue during the time set in `messageRetentionPeriodInSeconds`, your configuration will be removed, and you will have to reconfigure it with the [Feed configuration API call](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed/config) to continue using the feed. Therefore, it's important to be mindful of the filter configuration you are using. You can check it any time using the [Get feed configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed/config) endpoint.\n\n## Feed readout\n\nEvery system that depends on order updates should consume the feed to be able to take the necessary actions based on that information. The most common behavior is a store system or an integration reading every event in the feed and, based on its status, making a decision for each one.\n\n> When filtering statuses, be aware that all possible order statuses must be dealt with during integration to avoid errors. Particular attention should be paid to `Status Null`, which may be unidentified and end up being mapped as another status, which can potentially lead to errors.\n\n### Example\n\nThe order feed can be useful in many ways. For instance, say you want to develop an integration between your ERP and VTEX. This integration could have the following behavior:\n\n1. It retrieves ten events from the feed.\n2. For each one of the ten events, it evaluates the status the order was changed to.\n3. If the order changed to the status `Ready for handling`, the integration gets the complete order data, records it in the ERP, and updates the status on VTEX to `Handling shipping` (which indicates the start of handling).\n4. Then, it commits the events to the Feed (removing them from the queue).\n5. After reading and removing these ten events from the list, the integration moves to the following ten events in the feed and repeats the process.\n\n\n\nCheck the [back-office order integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration) to learn more about how you can integrate the VTEX order feed with an ERP.\n\n## Hook\n\nHook is a counterpart to Feed. It allows integrations to consume order update data differently. Instead of receiving events to form a queue that can be retrieved, a hook automatically sends the items to a URL provided by the user in the hook configuration.\n\n> Since Hook is a counterpart, [access](#access) follows the same principles described for Feed above. This means each appKey can configure or access only one hook. Different users that sharing the same appKey access the same hook. We recommend configuring one hook per appKey per user, ensuring that each user has access to their own hook.\n\n### Hook configuration\n\nSimilar to a feed, a hook can be configured through a POST call to the [Create or update hook configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/hook/config) endpoint of the Orders API. Here are a couple of body examples for the request, each using a different filter type:\n\n`FromWorkflow`\n\n`1\n\n{ \n\n2\n\n \"filter\": { \n\n3\n\n \"type\": \"FromWorkflow\", \n\n4\n\n \"status\": [ \n\n5\n\n \"payment-pending\" \n\n6\n\n ] \n\n7\n\n }, \n\n8\n\n \"hook\": { \n\n9\n\n \"url\": \"https://endpoint.example/path\", \n\n10\n\n \"headers\": { \n\n11\n\n \"key\": \"value\" \n\n12\n\n } \n\n13\n\n } \n\n14\n\n} \n\n`\n\n`FromOrders`\n\n`1\n\n{ \n\n2\n\n \"filter\": { \n\n3\n\n \"type\": \"FromOrders\", \n\n4\n\n \"expression\": \"status = \\\"payment-pending\\\"\", \n\n5\n\n \"disableSingleFire\": true \n\n6\n\n }, \n\n7\n\n \"hook\": { \n\n8\n\n \"url\": \"https://endpoint.example/path\", \n\n9\n\n \"headers\": { \n\n10\n\n \"key\": \"value\" \n\n11\n\n } \n\n12\n\n } \n\n13\n\n} \n\n`\n\nAs you can see, the `filter` object is configured the same way as the `filter` in the feed configuration described above. The other object in the body is the `hook` object, which contains information about how the data should be sent to the integration:\n\n* `url` is the endpoint path that should receive the order update information.\n* `headers` contains the credentials that should be used to access the given endpoint.\n* `key` is the endpoint key that should be used to access the given endpoint.\n\nWhen the hook is configured, VTEX sends a ping to the endpoint given in the configuration request body to ensure it is up and running. It is a `POST` request similar to this:\n\n`1\n\n{ \n\n2\n\n \"hookConfig\": \"ping\" \n\n3\n\n} \n\n`\n\n> The given endpoint should return status 200 for the above-mentioned request. Otherwise, the Hook API will return status `400 Bad Request`, and you won't be able to save the configuration.\n\n> We recommend configuring the hook in the main account. This ensures more visibility to commit all events correctly and that the configured endpoint is more frequently notified, preventing the hook from being excluded due to inactivity.\n\n### Hook notifications\n\nIf configured, the Hook notifies the integration endpoint whenever an order update is made and meets the conditions specified in the `filter`.\n\nIf a new event is not correctly notified to the endpoint, the interval for future retries is recalculated based on an internal geometric progression algorithm.\n\n> If the hook has no notifications for three days, your configuration will be removed, and you will have to reconfigure it with the [Hook configuration API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/hook/config) call to continue using it. Therefore, it's important to be mindful of your filter configuration. You can check it any time using the [Get hook configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/hook/config) endpoint.\n\n> When notified, the configured endpoint must always respond with HTTP status 200 within 5000 ms. Below is an example of a hook notification request body made to the integration endpoint.\n\n`1\n\n{ \n\n2\n\n \"Domain\": \"Marketplace\", \n\n3\n\n \"OrderId\": \"v40484048naf-01\", \n\n4\n\n \"State\": \"payment-approved\", \n\n5\n\n \"LastChange\": \"2019-07-29T23:17:30.0617185Z\", \n\n6\n\n \"Origin\": { \n\n7\n\n \"Account\": \"accountABC\", \n\n8\n\n \"Key\": \"vtexappkey-keyEDF\" \n\n9\n\n } \n\n10\n\n} \n\n`\n\n> When using a hook, it's important to be aware that it's a reactive feature. This means your middleware or ERP system must be ready to deal with whatever volume of data the hook sends. Large peaks in sales – due to Black Friday, for example – tend to increase hook notifications. If the implementation is not prepared for this peak, it may cause problems in the integration, compromising the store’s ability to handle orders and receive further notifications. Learn more about how to deal with this issue in the next section. Getting order updates from a feed requires the integration to make periodical API calls, returning whatever number of available updates each time, with no guarantee of ordination due to the infrastructure and technology used. A hook, on the other hand, notifies the integration whenever a new update is available. This means a feed is active, whereas a hook is reactive.\n\nBecause of this, a hook can be more efficient and provide a lower response time for each order update. But as a reactive feature, the integration must have scalability to handle great variations in data volume, such as can be caused by a Black Friday sales peak, for example.\n\nSome ERPs, for instance, do not have this scaling capacity. If you integrate a hook with an ERP, a possible workaround is to build middleware that is able to handle large variations in the data volume received from the hook and have the integration send the data to the ERP at a lower speed based on the capacity of the ERP.\n\nAnother option is using a hook as the primary source of data for the integration and a feed as a backup source that may be used when the hook integration has trouble scaling.\n\nWe recommend a hook for larger and more complex operations, which tend to have greater middleware scalability capacity and can benefit more from the feature’s efficiency.\n\nOn the other hand, a feed requires active [retrieving](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23get-/api/orders/feed) and [committing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/orders/feed) items to the queue. This means the integration has control over how many order updates it receives, and it knows how much data it needs to be able to handle at any given time. For this reason, it is less likely for the integration to crash or miss updates from the queue.\n\nTo learn more, read the [order integration with ERP](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-set-up-order-integration) guide and the API reference for [Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/feed-v3) and [Hook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-overview%23creating-an-order-integration).\n\nContributors\n\n3\n\n[](https://github.com/mariananantua)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/Isabella-Veloso)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Orders/orders-feed.md)\n\n[Metadata information in payment transactions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders//docs/guides/metadata-information-in-payment-transactions)[Order modificationsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders//docs/guides/order-modifications)\n\nContributors\n\n3\n\n[](https://github.com/mariananantua)\n\n[](https://github.com/julia-rabello)\n\n[](https://github.com/Isabella-Veloso)\n\nON THIS PAGE\n\n[Best practices for integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23best-practices-for-integrations)\n\n[Order integration: Feed vs. List orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23order-integration-feed-vs-list-orders)\n\n[Access](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23access)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23configuration)\n\n[filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23filter)[queue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23queue)[Other fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23other-fields)[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23examples)\n\n[Feed readout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23feed-readout)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23example)\n\n[Hook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23hook)\n\n[Hook configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23hook-configuration)[Hook notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23hook-notifications)\n\nWas this helpful?\n\n 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/orders-feed.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Best practices for integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23best-practices-for-integrations)\n\n[Order integration: Feed vs. List orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23order-integration-feed-vs-list-orders)\n\n[Access](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23access)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23configuration)\n\n[filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23filter)[queue](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23queue)[Other fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23other-fields)[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23examples)\n\n[Feed readout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23feed-readout)\n\n[Example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23example)\n\n[Hook](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23hook)\n\n[Hook configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23hook-configuration)[Hook notifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/using-master-data-v2-triggers-to-interact-with-orders/docs/guides/orders-feed%23hook-notifications)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_ec62af4d
|
[
{
"role": "system",
"content": "You are a VTEX 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 adding custom headers to your store framework 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-adding-custom-headers-to-your-store-framework-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-adding-custom-headers-to-your-store-framework-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-adding-custom-headers-to-your-store-framework-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-adding-custom-headers-to-your-store-framework-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-adding-custom-headers-to-your-store-framework-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-adding-custom-headers-to-your-store-framework-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-adding-custom-headers-to-your-store-framework-store/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-routing)\n\n[Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)\n\n[Best practices for associating a custom page with a content type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\n[Customizing your 404 page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-customizing-your-404-page)\n\n[Enabling 404 pages for invalid single-segment paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\n[Managing URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-managing-url-redirects)\n\n[Using several service workers in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-store-theme)\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/getting-started-3)\n\nConcepts\n\n[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-building-pages)\n\n[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-using-components)\n\n[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-using-advanced-layouts)\n\n[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-working-with-site-editor)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-styling)\n\n[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-dealing-with-events)\n\n[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-configuring-analytics-google-tag-manager)\n\n[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-setting-up-cross-border-stores)\n\n[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-multi-language-stores)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-routing)\n\n[Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)\n\n[Best practices for associating a custom page with a content type](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\n[Customizing your 404 page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-customizing-your-404-page)\n\n[Enabling 404 pages for invalid single-segment paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-enabling-404-pages-for-invalid-single-segment-paths)\n\n[Managing URL redirects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-managing-url-redirects)\n\n[Using several service workers in your store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-using-several-service-workers-in-your-store)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-managing-performance)\n\n[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-semantic-html-migration)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-go-live)\n\n[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-updating-live-stores)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework)\n\n[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/store-framework-routing)\n\n[Adding custom headers to your Store Framework store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store)\n\nAdding custom headers to your Store Framework store\n\nDiscover how to configure custom headers in your store\n\nIn this guide, you'll learn how to configure custom response headers in your Store Framework store. HTTP headers play a key role in communication between the user's browser and the server, providing additional information about the request in progress. There are two main types of headers:\n\n* **Request Headers:** Sent by the client to the server. They contain information about the request made, such as the type of HTTP method used, the type of accepted content, cookies, among others.\n* **Response Headers:** Sent by the server to the client. They provide information about the sent response, such as the response status, type of returned content, cookies, among others.\n\n> For more information, check the MDN guide [HTTP](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP) and the related documentation.\n\n## Security Response Headers\n\nHere are the headers that accept editing:\n\n* [**X-Frame-Options**](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options): Allows the control of how websites can be incorporated into other ones through the use of frames. This header is a security measure to protect users against [click-jacking](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/Security/Types%5Fof%5Fattacks%23click-jacking) attacks, which occur when an attacker tricks users into clicking something on a web page without their consent.\n* [**X-Content-Type-Options**](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options): Protects against [MIME](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Basics%5Fof%5FHTTP/MIME%5Ftypes) vulnerabilities, which can occur when a website allows users to upload content.\n* [**Content-Security-Policy (CSP)**](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy): Allows to control the resources a user agent can load on a given page, preventing [cross-site scripting](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Glossary/Cross-site%5Fscripting) attacks.\n* [**Strict-Transport-Security (HSTS)**](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security): Informs browsers that the site should only be accessed using HTTPS.\n* [**X-XSS-Protection**](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection): Instructs browsers on how to handle cross-site scripting (XSS) attacks, activating the integrated filter to block malicious scripts from executing in the user's browser.\n* [**Referrer-Policy**](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Referrer-Policy): Determines which origin page information is shared with the destination page in HTTP requests, essential to protect user privacy and website security.\n\n## Instructions\n\nYou can configure a custom header, a value that is not standardized and is tailored to the specific requirements or features of your store. To add a custom heading, follow the instructions below:\n\n1. In the VTEX Admin, go to **Store Settings > Storefront > Store**.\n2. Click the Advanced tab.\n3. Scroll down to the **Custom Header** section.\n4. Click **Add**.\n\n\n\n1. Complete the fields based on the [Security Response Headers](#security-response-headers) and the following guidelines: \n * **Header ID:** ID that identifies your custom header. \n * **Key:** Header key, following HTTP standards. \n * **Value:** Header value, following HTTP standards. \n> For more information on HTTP headers, see the MDN documentation on [headers](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers).\n\nSee the example below:\n\n\n\nIn the example above, the value `max-age=31536000; includeSubdomains` in the `Strict-Transport-Security` (HSTS) header defines the maximum duration in seconds that the HSTS policy should be applied by the browser for a specific domain and its subdomains. The `preload` directive indicates that the domain should be included in the HSTS preload list, which ensures that compliant browsers will only connect via HTTPS, even for the initial request.\n\n1. Click **Apply** to apply the settings. The update can take up to a day to reflect due to caching.\n\n### Best practices\n\n* When adding new headers to your account, always check the [official MDN documentation](https://read.calvincode.net/reader?url=https://developer.mozilla.org/en-US/docs/Web/HTTP).\n* When using the `frame-ancestors` header, remember to add the `self` parameter, which indicates that the page can only be embedded in iframes on the domain itself. Without this setting, the Site Editor content may be blocked, as iframes can be used to load and display parts of the store.\n* When using the `X-Frame-Options` header, remember to add the `SAMEORIGIN` parameter, which allows the page to be loaded in iframes only when the origin (domain) of the iframe is the same as the main page. Without this setting, the Site Editor content may be blocked, as the header restricts the site display within any iframe.\n* Always run tests in a [development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-a-development-workspace) before making the configuration available in production stores.\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store.md)\n\n[Routing« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store//docs/guides/store-framework-routing)[Best practices for associating a custom page with a content typeNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store//docs/guides/vtex-io-documentation-best-practices-for-associating-a-custom-page-with-a-content-type)\n\nContributors\n\n1\n\n[](https://github.com/barbara-celi)\n\nON THIS PAGE\n\n[Security Response Headers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store%23security-response-headers)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store%23instructions)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store%23best-practices)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Security Response Headers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store%23security-response-headers)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store%23instructions)\n\n[Best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store/docs/guides/vtex-io-documentation-adding-custom-headers-to-your-store-framework-store%23best-practices)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_d9ae876e
|
[
{
"role": "system",
"content": "You are a VTEX 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 running io scripts in non io vtex stores in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/docs/guides/ab-tests)\n\n---\n\n[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/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-running-io-scripts-in-non-io-vtex-stores/docs/app-development)\n\nDevelopment guides\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-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores)\n\nRunning IO scripts in non-IO VTEX stores\n\nExecute VTEX IO scripts in non-IO VTEX stores using a custom Scripts app.\n\nTo make it possible to run VTEX IO scripts in non-IO VTEX stores, you must develop and release your own _Scripts app_.\n\nA _Scripts app_ is an application that allows the usage of pre-defined VTEX IO scripts in pages external to the VTEX IO. That means that any VTEX store that installs your new _Scripts app_, even the ones that don't use the VTEX IO, can take advantage of running the VTEX IO scripts defined within your application in its website pages.\n\nNotice that nothing keeps an account from having multiple _Scripts apps_ installed. Hence, we recommend that, when building a _Scripts app_, you define a clear goal and offer a suite of coherent functionalities.\n\nIn the following sections, we'll teach you how to develop and implement your own _Scripts app_.\n\n## Before you begin\n\nBefore proceeding with the steps outlined in this document, ensure that you have the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed on your machine.\n\n## Instructions\n\n### Step 1 - Clone the boilerplate repository\n\n1. Using your terminal, clone the _Scripts app_ boilerplate repository to your local files by running: \n`1 \ngit clone https://github.com/vtex-apps/app-scripts-example \n`\n2. Then, using any code editor of your choice, open the boilerplate repository's directory.\n\n### Step 2 - Update the manifest metadata\n\n1. Open the `manifest.json` file and update its metadata, according to your scenario. It's essential that you update the following fields: \n * `vendor` \\- The app owner. That is, the VTEX account responsible for the app development, maintenance, and distribution. \n * `name` \\- The app name. It should concisely express the app's purpose. They must be comprised of lowercase letters separated by hyphens. Special characters, such as `*` and `@`, and numbers at the beginning of the name are not recommended. \n * `title` \\- The app distribution name. This name is the one used in the Apps section from the Administrative Panel and in the VTEX App Store. \n * `description` \\- A brief description explaining the app's purpose. This description will be publicly available in the App Store, providing context for whoever wants to install your app.\n\n### Step 3 - Customize your script\n\n1. In the `/scripts` folder, replace the example files with your own `.ts` script files.\n2. In the `/scripts` folder, open the `loader.json` file and declare which scripts should be executed on which page. Each entry in the `loader` `JSON` object must have a `RegExp` key indicating the page path, and a corresponding array of strings. Each string in the array points to the script files that need to be loaded on a page when the `RegExp` key matches the URL path of that page .\n\nTake the following example:\n\n`1\n\n{ \n\n2\n\n \".*\": [\"script1\"], \n\n3\n\n \".*/b$\": [\"script2\"], \n\n4\n\n \".*/p$\": [\"script2\", \"script3\"] \n\n5\n\n} \n\n`\n\nIn this example, the `script1` will be loaded and executed in all pages (`.*`) of the application.\n\nFor brand pages, expressed by URLs ending in `/b`, besides the `script1`, the `script2` will also be loaded.\n\nFinally, for product pages, expressed by URLs ending in `/p`, besides the `script1`, the `script2` and the `script3` will also be loaded.\n\n> Note that, by default, the scripts are located in the `scripts` folder. Hence, the complete path can be omitted. Also, as the scripts builder only looks for `.ts` files, it's not necessary to indicate file extensions.\n\nAlthough a single `RegExp` can have multiple corresponding scripts and multiple `RegExp` can match a single URL path, each script is loaded and executed only one time per page, independently of how many occurrences it has in matched `RegExps`.\n\n### Step 4 - Link your app\n\n1. Open the Admin of the account you are using to develop your app, and follow the instructions provided in the [Importing scripts](#importing-scripts) section, considering a development workspace.\n2. Once your app is set up, use the terminal and the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/) to log in to the VTEX account that you are using to develop your VTEX IO _Scripts App_. \n> Remember to replace the values between the curly brackets according to your scenario. \n`1 \nvtex login {accountName} \n`\n3. Change to development workspace. \n`1 \nvtex use {workspace} \n`\n4. Go to the local app directory and [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) the app to your development workspace. \n`1 \ncd app-scripts-example \n2 \nvtex link \n`\n\n### Step 5 - Test and deploy\n\n1. Check the pages for which you implemented your scripts.\n2. Make your new app version publicly available by following [this guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available/).\n\n### Step 6 - Implement your app\n\nNow that you finished developing your _Scripts_ app, you follow these steps to implement it in your desired VTEX account:\n\n1. Using the VTEX IO CLI or the App Store, install the app you just developed in the desired account.\n2. Follow the instructions provided in the [Importing scripts](#importing-scripts) section, considering a production workspace.\n\n## Importing scripts\n\n1. Considering the workspace in which you're currently working, open the Admin of the desired account and workspace.\n2. Go to **Storefront > Layout**.\n3. Open the desired page template.\n4. Before the `body` closure, place a single HTML `script` tag to import the `load.js` file, as in the following examples:\n\n### Development\n\n`1\n\n<script \n\n2\n\n src=\"https://{devWorkspace}--{account}.myvtex.com/_v/public/vtex.scripts-server/v1/load.js\" \n\n3\n\n type=\"text/javascript\" \n\n4\n\n></script> \n\n`\n\nwhere:\n\n* `devWorkspace`\\- the development workspace of the account used to develop your _Scripts app._\n* `account`\\- the name of the account used to develop your _Scripts app._\n\n### Production\n\n`1\n\n<script \n\n2\n\n src=\"/api/io/_v/public/vtex.scripts-server/v1/load.js?workspace={productionWorkspace}\" \n\n3\n\n type=\"text/javascript\" \n\n4\n\n></script> \n\n`\n\nwhere:\n\n* `productionWorkspace` \\- the production workspace of the account you are implementing the _Scripts app._\n\nThe `src` value from the `script` tag is the same for all pages in which you want to load your app's scripts.\n\nAccording to the definitions from the `loader.json` file, the script server will load and execute only the appropriate scripts for that page: the ones whose the URL matches the `RegExps` from the `loader.json` file against the page path.\n\n## App behavior\n\nAll scripts available in a _Scripts app_ are saved in its `/scripts` folder along with a `loader.json` file, which indicates in which page each script must be executed.\n\nThe scrips builder, set in the `manifest.json` file, is responsible for parsing each script declared in the `loader.json` file and for making them available to the `/load.js` route of the VTEX IO script server.\n\nHence, once you install a _Scripts app_ in a VTEX account, you can import the script server's route (`/load.js`) to your pages by using the `script` HTML tag.\n\nFinally, according to the definitions from the `loader.json` file, the appropriate scripts for each page will be loaded and executed instantly.\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-running-io-scripts-in-non-io-vtex-stores.md)\n\n[Managing application logs« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores//docs/guides/vtex-io-documentation-managing-application-logs)[Creating an interface for your app settingsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores//docs/guides/vtex-io-documentation-creating-an-interface-for-your-app-settings)\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-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23instructions)\n\n[Step 1 - Clone the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-1-clone-the-boilerplate-repository)[Step 2 - Update the manifest metadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-2-update-the-manifest-metadata)[Step 3 - Customize your script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-3-customize-your-script)[Step 4 - Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-4-link-your-app)[Step 5 - Test and deploy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-5-test-and-deploy)[Step 6 - Implement your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-6-implement-your-app)\n\n[Importing scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23importing-scripts)\n\n[Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23development)[Production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23production)\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23app-behavior)\n\nWas this helpful?\n\n 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-running-io-scripts-in-non-io-vtex-stores.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23before-you-begin)\n\n[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23instructions)\n\n[Step 1 - Clone the boilerplate repository](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-1-clone-the-boilerplate-repository)[Step 2 - Update the manifest metadata](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-2-update-the-manifest-metadata)[Step 3 - Customize your script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-3-customize-your-script)[Step 4 - Link your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-4-link-your-app)[Step 5 - Test and deploy](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-5-test-and-deploy)[Step 6 - Implement your app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23step-6-implement-your-app)\n\n[Importing scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23importing-scripts)\n\n[Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23development)[Production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23production)\n\n[App behavior](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores/docs/guides/vtex-io-documentation-running-io-scripts-in-non-io-vtex-stores%23app-behavior)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_f952cbcf
|
[
{
"role": "system",
"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 availabilitysubscriber 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/availabilitysubscriber/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/availabilitysubscriber/docs/api-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/availabilitysubscriber/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/availabilitysubscriber/docs/storefront-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/availabilitysubscriber/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/availabilitysubscriber/docs/troubleshooting)\n\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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/docs/guides/store-components)\n\n[Autocomplete Result List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/autocompleteresults)\n\n[Availability Subscriber](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/availabilitysubscriber)\n\n[Back To Top Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/backtotopbutton)\n\n[Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/image)\n\n[Info Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/infocard)\n\n[Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/logo)\n\n[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/notification)\n\n[Product Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productbrand)\n\n[Product Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productdescription)\n\n[Product Images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productimages)\n\n[Product Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productname)\n\n[Product SKU Attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/productskuattributes)\n\n[Search Bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/searchbar)\n\n[Share](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/share)\n\n[Shipping Simulator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/shippingsimulator)\n\n[SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/skuselector)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/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/availabilitysubscriber/docs/vtex-io-apps)\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/guides/store-components)\n\nAvailability Subscriber\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 `availability-subscriber` component shows the availability subscriber form displayed when a product isn't available. This component can be imported and used by any VTEX App.\n\n\n\nThis component only collects the emails of the customers that subscribed to receive updates about a specific out-of-stock product. It does not email shoppers automatically when the product gets back in stock.\n\n> Info\n> \n> Alternatively, check the [Availability Notify component](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-availability-notify), which renders a subscription form when a product is unavailable and also emails the shopper when the requested product is back in stock.\n\n## Before you start\n\nBefore configuring the Availability Subscriber component in your theme, make sure you've already configured a **JSON schema in Master Data** to collect the emails correctly. Otherwise, the subscriber form won't be properly saved with the shoppers' emails. Please refer to the [Creating a product availability form](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-creating-a-product-availability-form) guide for more information.\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 `availability-subscriber` block as a child of the `store.product` template (Product Details Page template). For example:\n\n`1\n\n \"store.product\": { \n\n2\n\n \"children\": [ \n\n3\n\n+ \"availability-subscriber” \n\n4\n\n ] \n\n5\n\n } \n\n`\n\nThe Availability Subscriber component does not have any props. Hence, once added to your Product Details Page template, the Availability Subscriber component is ready for use.\n\n### Blocks API\n\nWhen implementing this component as a block, various inner blocks may be available. The following interface lists the blocks available within `AvailabilitySubscriber` and describes if they are mandatory or optional.\n\n`1\n\n \"availability-subscriber\": { \n\n2\n\n \"component\": \"AvailabilitySubscriber\" \n\n3\n\n } \n\n`\n\nFor now this block does not have any mandatory or optional blocks.\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| content |\n| error |\n| form |\n| input |\n| inputEmail |\n| inputName |\n| submit |\n| subscriberContainer |\n| subscribeLabel |\n| success |\n| title |\n\n[Autocomplete Result List« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/autocompleteresults)[Back To Top ButtonNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/backtotopbutton)\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/availabilitysubscriber/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[Before you start](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/availabilitysubscriber%23before-you-start)\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/availabilitysubscriber%23configuration)\n\n[Blocks API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/availabilitysubscriber%23blocks-api)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/availabilitysubscriber/docs/apps/vtex.store-components/availabilitysubscriber%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_62d4a6f8
|
[
{
"role": "system",
"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 complete a purchase on a faststore website in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\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-complete-a-purchase-on-a-faststore-website/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-complete-a-purchase-on-a-faststore-website/docs/api-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-complete-a-purchase-on-a-faststore-website/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-complete-a-purchase-on-a-faststore-website/docs/storefront-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-complete-a-purchase-on-a-faststore-website/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-complete-a-purchase-on-a-faststore-website/docs/troubleshooting)\n\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-complete-a-purchase-on-a-faststore-website/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n[I can't complete a purchase on a FastStore website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website)\n\n[My store is slow or unavailable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/my-store-is-slow-or-unavailable)\n\n[Google Analytics 4 is tracking inconsistent data from my store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store)\n\n[UTMs are not being applied to the cart at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/utms-are-not-being-applied-to-the-cart-at-checkout)\n\n[My routes are not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/my-routes-are-not-behaving-as-expected)\n\n[My store is presenting price inconsistencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/my-store-is-presenting-price-inconsistencies)\n\n[My store translation is not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/updates/release-notes)\n\nTroubleshooting\n\nAPI\n\n---\n\nDevelopment\n\n---\n\nStore performance\n\n[I can't complete a purchase on a FastStore website](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website)\n\n[My store is slow or unavailable](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/my-store-is-slow-or-unavailable)\n\n[Google Analytics 4 is tracking inconsistent data from my store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/google-analytics-4-is-tracking-inconsistent-data-from-my-store)\n\n[UTMs are not being applied to the cart at Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/utms-are-not-being-applied-to-the-cart-at-checkout)\n\n[My routes are not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/my-routes-are-not-behaving-as-expected)\n\n[My store is presenting price inconsistencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/my-store-is-presenting-price-inconsistencies)\n\n[My store translation is not behaving as expected](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/my-store-translation-is-not-behaving-as-expected)\n\n---\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting)\n\nStore performance\n\nI can't complete a purchase on a FastStore website\n\nWhile trying to checkout on a FastStore website, you might see a 'This Connection Is Not Private' error.\n\n**Keywords:** FastStore | Checkout | DNS | SSL\n\nWhen trying to complete a purchase on your FastStore website, you may receive the following error message: `This Connection Is Not Private`\n\n\n\nThis error occurs when your browser cannot verify whether a website is safe to visit. It usually happens when the browser notices a problem while creating an SSL connection or cannot verify the certificate.\n\n## Solution\n\nTo solve this problem, there are two troubleshooting checks and instructions you can follow:\n\n* [Configuring an external DNS](#step-1---configuring-an-external-dns): Ensure your FastStore website is accessible via a custom domain and that the checkout works properly.\n* [Check the secure subdomain pointing](#step-2---check-the-secure-subdomain-pointing): If the error persists after configuring an external DNS, check if the `secure` subdomain is pointing to VTEX.\n\n### Step 1 - Configuring an external DNS\n\nConfigure an external DNS to allow customers to access your FastStore website through your chosen domain and enable features like VTEX Checkout. See the [Configuring external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/go-live-1-configuring-external-dns) guide for more information.\n\n### Step 2 - Check the `secure` subdomain pointing\n\nIf the error continues, check if your website's `secure` subdomain is pointing to `secure.{hostname}.cdn.vtex.com`, where `hostname` is the complete address of your store. To check, follow these steps:\n\n1. Go to your preferred tool, such as the [DNS Checker](https://read.calvincode.net/reader?url=https://dnschecker.org/), to check DNS records for a given domain name.\n2. Enter `secure.{hostname}` in the search bar.\n3. Choose `CNAME` in the dropdown menu.\n4. Check if the `secure` subdomain is pointing to the `secure.{hostname}.cdn.vtex.com`, as in the example below: \n\n\nIf the `secure` subdomain is pointing to `secure.{hostname}.cdn.vtex.com` but the problem continues, open a ticket with [VTEX Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).\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/store-performance/i-cant-complete-a-purchase-on-a-faststore-website.md)\n\n[I don't see my Store Theme changes« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/i-dont-see-my-store-theme-changes)[My store is slow or unavailableNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/my-store-is-slow-or-unavailable)\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-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website%23solution)\n\n[Step 1 - Configuring an external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website%23step-1-configuring-an-external-dns)[Step 2 - Check the secure subdomain pointing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website%23step-2-check-the-secure-subdomain-pointing)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/store-performance/i-cant-complete-a-purchase-on-a-faststore-website.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-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website%23solution)\n\n[Step 1 - Configuring an external DNS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website%23step-1-configuring-an-external-dns)[Step 2 - Check the secure subdomain pointing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website/docs/troubleshooting/i-cant-complete-a-purchase-on-a-faststore-website%23step-2-check-the-secure-subdomain-pointing)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_b223af64
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides faststore feature regionalization in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/storefront-best-practices)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/updates/release-notes)\n\nStorefront Development\n\n[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/getting-started-with-storefront-solutions)\n\n---\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore)\n\n[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)\n\n[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/getting-started-overview)\n\n[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/webops-dashboard)\n\n[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/headless-cms-overview)\n\n[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/developer-tools-overview)\n\n[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/styling-overview)\n\n[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/components-index)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-overview)\n\n[Adding third-party scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-handling-third-party-scripts)\n\n[Building navigation menus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-building-navigation-menus)\n\n[Displaying content for authenticated users](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)\n\n[Implementing regionalization features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features)\n\n[Implementing search features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-search-features)\n\n[Managing product images in specific contexts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-managing-product-images-in-specific-contexts)\n\n[Implementing Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/delivery-promise-implementation)\n\n[Implementing Live Shopping for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore)\n\n[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/faststore-api-overview)\n\n[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/sdk-overview)\n\n[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/developing-and-overriding-components-overview)\n\n[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/api-extensions-overview)\n\n[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/managing-performance-overview)\n\n[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/seo-overview)\n\n[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/go-live-overview)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/troubleshooting-overview)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/store-framework)\n\n---\n\n(Legacy) CMS Portal\n\n---\n\n[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/storefront-best-practices)\n\n---\n\n[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/storefront-development)\n\n[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore)\n\n[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-overview)\n\nImplementing regionalization features\n\nThis feature enables customers to set a location using a valid Postal Code.\n\nRegionalization is a feature of [VTEX Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG) that optimizes search results according to the availability of sellers in the customer's region.\n\nRegionalization uses a behavior from VTEX Intelligent Search called [Availability](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/7LMQbWK5nElIkXo0NK8Kux). It searches for products available in the inventory of sellers that serve a particular region.\n\nStores that have more than one registered white-label seller usually have specific inventories for each region. This is the case for supermarkets, for example.\n\nWith the Regionalization feature enabled, if a customer enters their Postal Code while browsing the store (before checkout), only products available in the corresponding region will be displayed in the search results.\n\n---\n\n## Usage\n\n1. Intentionally, a user sets its location using a postal code.\n2. Updates product catalog.\n3. Gets notified if there's a product conflict at Minicart.\n\n---\n\n## Components\n\n* Region Bar \nThe RegionBar is a custom Button, usually used on mobile devices only. It should trigger the RegionModal. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/molecules-region-bar)\n* Open Region Modal \nRegion Modal \nA modal with region configurations. \n[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/organisms-region-modal)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-regionalization-features.mdx)\n\n[Displaying content for authenticated users« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-displaying-content-for-authenticated-users)[Implementing search featuresNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-search-features)\n\nContributors\n\n1\n\n[](https://github.com/mariana-caetano)\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features%23components)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/storefront-features/implementing-regionalization-features.mdx)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features%23usage)\n\n[Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/feature-regionalization/docs/guides/faststore/storefront-features-implementing-regionalization-features%23components)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_2b4eeddd
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides setting up alternate keys in master data v2 in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/updates/release-notes)\n\nGuides\n\n[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/vtex-platform-overview)\n\n---\n\n[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/api-usage)\n\n---\n\n[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/getting-started)\n\n---\n\nIntegration Guides\n\n---\n\n[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/catalog-integration)\n\n---\n\n[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/checkout-api-overview)\n\n---\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data)\n\n[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/understanding-master-data)\n\n[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data-best-practices)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data-v2)\n\nSchemas\n\nTriggers\n\n[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data-v2-document-saving-flow)\n\n[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)\n\n[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)\n\n[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\n[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\n[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data-v1)\n\n---\n\nPayments\n\n---\n\nOrders\n\n---\n\nLogistics\n\n---\n\nB2B Suite\n\n---\n\nVTEX Sales App\n\n---\n\nUI Customization\n\n---\n\nMessage Center\n\n---\n\nPricing\n\n---\n\nPromotions\n\n---\n\nInfrastructure\n\n---\n\nSearch\n\n---\n\nStorefront Permissions\n\n---\n\n[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/activity-flow)\n\n---\n\n[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/vtex-ads)\n\n---\n\nVTEX Session\n\n---\n\nVTEX Shield\n\n---\n\n[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/data-protection-plus)\n\n---\n\nWeni by VTEX\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides)\n\n[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data)\n\n[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/master-data-v2)\n\n[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)\n\nSetting up alternate keys in Master Data v2\n\nWith Master Data v2 you can configure alternate keys, which are cross JSON schema.\n\nThere are two types of alternate keys:\n\n* `Single`\n* `Multiple`\n\nThe `Single` type sets the value of the field as unique in the data entity, while in the `Multiple` type, other documents may have this same value.\n\n## Get documents using alternate keys\n\nTo get a document using an alternate key, add the following query in the search API:\n\n`1\n\n/search?{{fieldName}}={{fieldValue}} \n\n`\n\nIn this scenario, Master Data will not try to get the document in the indexer. It is a faster process than getting a single document in the indexer.\n\nThe `Multiple` type must be used in the case of low quantities of matching documents. For instance, the Profile System uses this `Multiple` index to get clients' addresses. The amount of addresses of a given client is less than one hundred. So this is a good use case.\n\nIf your alternate key has over one hundred matches available, you need to set the field as indexed and paginate your searches.\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nWas this helpful?\n\nYes\n\nNo\n\n[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/setting-up-alternate-keys-in-master-data-v2.md)\n\n[Searching by geocoordinates in Master Data v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2//docs/guides/searching-by-geocoordinates-in-master-data-v2)[Setting up an auto increment field in Master Data v2Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2//docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)\n\nContributors\n\n1\n\n[](https://github.com/julia-rabello)\n\nON THIS PAGE\n\n[Get documents using alternate keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2%23get-documents-using-alternate-keys)\n\nWas this helpful?\n\n Send feedback\n\n[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/setting-up-alternate-keys-in-master-data-v2.md)\n\nCopy page\n\nOn this page\n\nON THIS PAGE\n\n[Get documents using alternate keys](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-alternate-keys-in-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2%23get-documents-using-alternate-keys)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_01a9dc0f
|
[
{
"role": "system",
"content": "You are a VTEX 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 debugging performance issues in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\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-debugging-performance-issues/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-debugging-performance-issues/docs/api-reference)\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-debugging-performance-issues/docs/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-debugging-performance-issues/docs/storefront-development)\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-debugging-performance-issues/docs/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-debugging-performance-issues/docs/troubleshooting)\n\n[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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/docs/guides/faststore)\n\n---\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/store-framework)\n\n[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/docs/guides/store-framework-routing)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/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-debugging-performance-issues/docs/storefront-development)\n\n[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/store-framework)\n\n[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/store-framework-managing-performance)\n\n[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues)\n\nDebugging performance issues\n\nIn the ecommerce business, website performance and user experience are closely connected. That means that performance can directly impact sales conversion rate, user session time, among other relevant metrics.\n\nA series of tools are available to measure website performance, such as [Lighthouse](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/lighthouse)/[PageSpeed Insights](https://read.calvincode.net/reader?url=https://developers.google.com/speed/pagespeed/insights/) and [SpeedCurve](https://read.calvincode.net/reader?url=https://speedcurve.com/).\n\nKeeping an eye on how your store's website performs is essential for delivering a fast and efficient solution to final users.\n\nWith that in mind, the [Instructions](#instructions) intends to guide you when debugging performance issues, aiming for high scores in Lighthouse audits.\n\n> The practices presented in this doc are intended to guide you when debugging your store's performance, they do not provide definitive solutions. For information on how to improve performance, [folow this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance).\n\n## Instructions\n\nBefore proceeding any further, we recommend that you run [Lighthouse](https://read.calvincode.net/reader?url=https://developers.google.com/speed/pagespeed/insights/) using the following URL pattern `https://{account}.myvtex.com/?workspace={workspace}`, given the production workspace you're currently working, and take note of your store's performance. You can also analyze the store in production. In this case, please consider the URL available to end-users.\n\n> **Keep in mind:** you must always use the `?workspace={workspace}` query string to analyze performance in a production workspace. Using the standard URL pattern `https://{workspace}--{account}.myvtex.com/` won't show the performance score of your store in the specified workspace.\n\nAlso, when running Lighthouse, consider analyzing pages from different contexts separately. For example, run specific audits for the Home, Search, Category, and Product pages.\n\n### Step 1: Testing the server-side rendering\n\nMost websites use JavaScript to support a dynamic and interactive user experience.\n\nGenerally, the amount of JavaScript that is shipped to the browser increases as the application complexity grows, for example, with the inclusion of third-party scripts and other JavaScript libraries.\n\nHowever, it is important to remember that JavaScript handles data fetching, templating, and routing on the client-side rather than on the server-side.\n\nConsequently, JavaScript must be processed before the page content is rendered, competing for processing power and delaying the rendering process.\n\nIn light of that, you may want to see how your web page looks and behaves when JavaScript is disabled.\n\nAdopting this practice will help you implement progressive improvements. That is, guaranteeing your server-side rendering (SSR) HTML is functional and free of bugs so you can improve your website's capabilities through JavaScript.\n\n> If applicable, check Google's documentation on [how to disable javascript in Google Chrome](https://read.calvincode.net/reader?url=https://developers.google.com/web/tools/chrome-devtools/javascript/disable).\n\nWhen performing this test, your store will probably not function the same way as planned. However, its core functionalities may work as expected. Take the following subsections as a reference:\n\n#### Undesired behaviors\n\n* The page does not render anything.\n* Instead of updating only the different content, the page is fully refreshed when navigating to another page.\n* Misplaced layout.\n\n#### Expected behaviors\n\n* Simpler design.\n* Animations and interactive menus do not work.\n* The below-the-fold content does not render.\n\n> Before Google crawlers incorporated and improved the indexing of JavaScript content and links capability, SEO used to be a common concern for websites based on JavaScript. Even though this issue has been addressed, be aware that other search engines might not have this feature yet.\n\n### Step 2: Checking the effect of third-party apps\n\nOne of the first actions to debug performance issues is to test the desired page without [Pixel apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-pixel-app).\n\n> Pixel apps are applications that integrate a third-party solution into your store's website.\n\nChecking how your store pages perform without third-party apps might help detect if the problem comes from there.\n\nFor that, you must run Lighthouse again, including the `__disablePixels` and `v` query strings in the URL, as in the following: `https://www.{account}.com.br/?workspace={workspace}&__disablePixels&v={randomvalue}`.\n\n> Notice that the random value added to the query string `v` is used to avoid cache. Remember to replace the values between the curly brackets according to your scenario.\n\nTake the following example:\n\n\n\n### Step 3: Checking an app's bundle size\n\nIf you are building a custom React component, you can get a glimpse of your app's performance by analyzing its bundle size.\n\n> The app’s bundle size indicates the size of the JavaScript files needed to load your app.\n\nLarge bundle sizes imply a longer loading time. If it is too slow, it may harm performance and, consequently, the user experience.\n\nFor analyzing you app's bundle, you can access the following paths:\n\n* In the development mode: `https://{workspace}--{account}.myvtex.com/_v/private/assets/v1/linked/{app}@{version}/public/react/devReport.html`\n* In production: `https://{workspace}--{account}.myvtex.com/_v/public/assets/v1/published/{app}@{version}/public/react/[prod|dev]Report.html`\n\n> Remember to replace the values between the curly brackets according to your scenario.\n\nHere is an example of the result:\n\n\n\nFrom the given example, we have the name of the bundle (`vendors~Pickup.js`) followed by the `modules` folder, in which it's noticeable that the `react-icons` component takes up the majority of the bundle size.\n\nBy knowing that, it's possible to take targeted actions to reduce your app's bundle size. Possible solutions are: code-splitting, fetching bundles asynchronously, and replacing a large dependency with a more minimalistic and specialized solution.\n\n### Step 4: Identifying heavy scripts\n\nUse [SpeedCurve](https://read.calvincode.net/reader?url=https://speedcurve.com/) or any other tool of your preference to detect your website's heaviest scripts, and consider:\n\n* Removing them.\n* Replacing them with lighter and similar scripts.\n* Implementing alternative loading solutions with a lower negative impact on performance.\n\n### Step 5: Enabling performance settings\n\nTo help you guarantee the success of your brand's online presence, we provide a series of performance settings, which can be enabled at your stores's admin, under _Store Settings > Storefront > Store > Advanced_.\n\n> Follow [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance) to learn about the currently available performance settings.\n\n> Follow [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-safely-enabling-performance-settings) to learn how to safely enable performance settings.\n\nWe recommend that you gradually enable the available features and measure their impact using Lighthouse and other tools.\n\n### Step 6: Testing the critical CSS\n\nVTEX IO offers the option of [enabling critical CSS optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance%23optimizing-critical-css) in home pages, product pages, and product listing pages. This feature allows the browser to find the minimum CSS code blocks needed to display the page's critical content first. Meanwhile, the remainder CSS code is loaded asynchronously.\n\n> Critical, also known as above-the-fold, refers to the portion of a web page a user sees when first loading a page. Notice that, for a good user experience, the critical content needs to be loaded quickly. Follow [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-optimizing-performance%23optimizing-critical-css) to learn how to optimize critical CSS.\n\nCritical CSS optimization requires that the page is server-side rendered and that CSS concatenation is enabled. Also, the process of optimizing CSS for each page can take some time and varies depending on the page and viewport size.\n\n> CSS optimization may not respond immediately. Only after different users access the same page using a similar viewport will the CSS's optimized version take effect. Take product pages as an example: some products may have SKU selectors, while others don't. Since it isn't necessary to serve SKU selector styles for product pages that don't have this component, product pages might not share the same critical optimization. Similarly, two users accessing the same page using different devices, such as mobile and desktop, won't share the same optimization.\n\nHence, after enabling the critical CSS optimization, check if your pages are being optimized:\n\n1. Make sure your pages are server-side rendered (Step 1)\n2. Look for the style tag `<style id=\"critical\" type=\"text/css\">` inside the `<head>` tag of the corresponding pages.\n\n### Step 7: Using the Lighthouse Scoring Calculator\n\nWith the performance features enabled, as proposed in Step 5, reproduce your scores in the [Lighthouse Scoring Calculator](https://read.calvincode.net/reader?url=https://googlechrome.github.io/lighthouse/scorecalc/%23version=6) to identify which metrics have the greatest potential for improvement.\n\n> [Lighthouse Scoring Calculator](https://read.calvincode.net/reader?url=https://googlechrome.github.io/lighthouse/scorecalc/%23version=6) is a tool created by Google that allows you to play with Lighthouse performance metrics and define the thresholds you should aim for to achieve the desired Performance Score.\n\n1. If the [Total Blocking Time (TBT)](https://read.calvincode.net/reader?url=https://web.dev/tbt/) is too long, use the browser's performance tab and [React Dev Tools](https://read.calvincode.net/reader?url=https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) (if applicable) to identify components running JavaScript for long periods and, consequently, blocking the main thread and impeding the browser to respond to other requests. To improve the implementation of these components, consider breaking tasks into smaller ones so that they do not block the main thread for more than 50ms.\n\n> [React Dev Tools](https://read.calvincode.net/reader?url=https://chrome.google.com/webstore/detail/react-developer-tools/fmkadmapgofadopljbjfkapdkoienihi?hl=en) is a Chrome DevTools extension for the open-source React JavaScript library.\n\n1. If [First Contentful Paint (FCP)](https://read.calvincode.net/reader?url=https://web.dev/fcp/) is high, consider prioritizing the above-the-fold content by bringing, at first, only the necessary assets to render that part of the page.\n2. If [Largest Contentful Paint (LCP)](https://read.calvincode.net/reader?url=https://web.dev/lcp/) is high, consider centering most of the page content on one or fewer elements, such as a banner, and having that part rendered with priority (e.g., loading the main image first).\n\n> Follow [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-getting-started-with-lighthouse) to learn more about Lighthouse metrics.\n\n> Follow [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score) to learn more about how to track changes in Lighthouse performance scores using the Lighhouse Scoring Calculator.\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-debugging-performance-issues.md)\n\n[Deactivating the VTEX IO native service worker« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues//docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)[Displaying asynchronous pricesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues//docs/guides/vtex-io-documentation-displaying-asynchronous-prices)\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-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23instructions)\n\n[Step 1: Testing the server-side rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-1-testing-the-server-side-rendering)[Step 2: Checking the effect of third-party apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-2-checking-the-effect-of-third-party-apps)[Step 3: Checking an app's bundle size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-3-checking-an-apps-bundle-size)[Step 4: Identifying heavy scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-4-identifying-heavy-scripts)[Step 5: Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-5-enabling-performance-settings)[Step 6: Testing the critical CSS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-6-testing-the-critical-css)[Step 7: Using the Lighthouse Scoring Calculator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-7-using-the-lighthouse-scoring-calculator)\n\nWas this helpful?\n\n 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-debugging-performance-issues.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-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23instructions)\n\n[Step 1: Testing the server-side rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-1-testing-the-server-side-rendering)[Step 2: Checking the effect of third-party apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-2-checking-the-effect-of-third-party-apps)[Step 3: Checking an app's bundle size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-3-checking-an-apps-bundle-size)[Step 4: Identifying heavy scripts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-4-identifying-heavy-scripts)[Step 5: Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-5-enabling-performance-settings)[Step 6: Testing the critical CSS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-6-testing-the-critical-css)[Step 7: Using the Lighthouse Scoring Calculator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-debugging-performance-issues/docs/guides/vtex-io-documentation-debugging-performance-issues%23step-7-using-the-lighthouse-scoring-calculator)\n\nOn this page\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
doc_7888a3f6
|
[
{
"role": "system",
"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 orderquote 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.orderquote/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/api-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.orderquote/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.orderquote/docs/storefront-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.orderquote/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.orderquote/docs/troubleshooting)\n\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.orderquote/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/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.orderquote/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.orderquote/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/basic-components)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/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.orderquote/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.orderquote/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.orderquote/docs/vtex-io-apps)\n\nOrder Quote\n\nOfficial extension\n\nVersion: 1.6.2\n\nLatest version: 1.6.2\n\n[](#contributors-)\n\nThe Order Quote app provides **B2B** capabilities to save a shopping cart (its items, product quantities and prices) for further use.\n\n> The Order Quote app is not compatible with the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-suite) solution. Therefore, these instructions do not apply to stores using the B2B Suite. If you are using the B2B Suite, refer to the [B2B Quotes & Carts](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-b2b-quotes) documentation instead.\n\nThe user can also print the quotation information containing the cart information along with expiration date which is defined at **Admin > Apps**.\n\n\n\n## Configuration\n\n1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/installing-an-app/) the Order Quote app by running `vtex install vtex.orderquote@1.x`.\n2. Head over to your VTEX account's admin and access the **Apps** section.\n3. Select the **Order Quote** app and click on **Settings**.\n4. Fill out the **Lifespan** and **Store logo URL** fields.\n5. Click on **Save**.\n6. Add the Order Quote app as a `peerDependency` in your `store-theme`'s `manifest.json` file:\n\n`1\n\n \"peerDependencies\": { \n\n2\n\n+ \"vtex.orderquote\": \"1.x\" \n\n3\n\n } \n\n`\n\nOnce declared as a [Peer Dependency](https://read.calvincode.net/reader?url=https://vtex.io/docs/concepts/peerdependencies/), the app will generate a few routes under the `/orderquote` path in order to create the Order Quote custom page. Namely, they are:\n\n| Route | Description |\n| -------------------- | --------------------------------------------------------------------------------------------- |\n| /orderquote | Lists all saved cart quotations. |\n| /orderquote/create | Retrieves the current cart information, allowing you to create cart quotations as you desire. |\n| /orderquote/view/:ID | Details page, displayed when you click on a quote from the listing page (/orderquote). |\n\nThe new routes already contain a default template with all blocks automatically exported by the `orderquote` app, meaning that the Order Quote pages are ready to be rendered and no further actions are required from you.\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| buttonDelete |\n| buttonPrint |\n| buttonSave |\n| buttonsContainer |\n| buttonUse |\n| checkboxClear |\n| containerCreate |\n| containerFields |\n| containerList |\n| containerView |\n| refreshButton |\n| refreshLoading |\n| field |\n| inputCreate |\n| inputCreate |\n| listContainer |\n| logo |\n| notAuthenticatedMessage |\n| printingArea |\n| totalizerContainer |\n| itemNameContainer |\n| itemName |\n| itemSkuName |\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.orderquote/docs/apps/vtex.orderquote%23configuration)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.orderquote/docs/apps/vtex.orderquote%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_b38e1e37
|
[
{
"role": "system",
"content": "You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development."
},
{
"role": "user",
"content": "Provide a guide on guides vtex product highlights in VTEX."
},
{
"role": "assistant",
"content": "Documentation\n\n[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)\n\n[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides)\n\n[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/api-reference)\n\n[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/app-development)\n\n[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/storefront-development)\n\n[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/vtex-io-apps)\n\n[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/troubleshooting)\n\n[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides)\n\n[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/api-reference)\n\n[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/app-development)\n\n[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/storefront-development)\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/vtex-io-apps)\n\n[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/troubleshooting)\n\n---\n\n[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/updates/release-notes)\n\nVTEX IO Apps\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/basic-components)\n\n[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.add-to-cart-button)\n\n[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search/Autocomplete)\n\n[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search/banner)\n\n[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.breadcrumb)\n\n[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.store-footer)\n\n[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/google-one-tap-login)\n\n[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.store-header)\n\n[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.locale-switcher)\n\n[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.login)\n\n[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.menu)\n\n[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.minicart)\n\n[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.order-placed)\n\n[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-customizer)\n\n[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-highlights)\n\n[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-identifier)\n\n[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-list)\n\n[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-price)\n\n[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-quantity)\n\n[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-specifications)\n\n[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary)\n\n[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryattachmentlist)\n\n[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummarybuybutton)\n\n[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummarydescription)\n\n[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryimage)\n\n[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummarylist)\n\n[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryname)\n\n[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryshelf)\n\n[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryskuselector)\n\n[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-summary/productsummaryskuname)\n\n[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.rich-text)\n\n[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search)\n\n[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search/suggestions)\n\n[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search/didyoumean)\n\n[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.search-result)\n\n[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.store-image)\n\n---\n\n[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/store-components)\n\n---\n\n[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/advanced-components)\n\n---\n\n[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/b2b-components)\n\n---\n\n[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.b2b-suite)\n\n---\n\n[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/functional-apps)\n\n---\n\n[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/layout-apps)\n\n---\n\n[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/pixel-apps)\n\n---\n\n[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.my-account)\n\n---\n\n[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/vtex-io-deprecated-apps)\n\n---\n\n[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/vtex-io-apps)\n\n[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/guides/basic-components)\n\nProduct Highlights\n\nOfficial extension\n\nVersion: 2.3.2\n\nLatest version: 2.3.2\n\n[](#contributors-)\n\nThe Product Highlights app provides blocks to display highlight badges on products according to the collection or promotion they are linked to.\n\n\n\n_In the image above, the product has a `Top Seller` highlight._\n\n## Configuration\n\n### Step 1 - Adding the Product Highlights app to your theme dependencies\n\nIn your theme `manifest.json` file, add the Product Highlights app as a dependency:\n\n`1\n\n \"dependencies\": { \n\n2\n\n+ \"vtex.product-highlights\": \"2.x\" \n\n3\n\n} \n\n`\n\nNow, you can use all the blocks exported by the `product-highlights` app. See the full list below:\n\n| Block name | Description |\n| ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |\n| product-highlights | Parent block for defining how the Product Highlights component will be displayed, based on its children blocks (product-highlight-text and product-highlight-wrapper) and props. |\n| product-highlight-text | Renders a span HTML tag with the highlight name. It also provides data attributes and CSS handles for style customizations. |\n| product-highlight-wrapper | You may use this block if you need to render other blocks alongside the highlight name. It renders a div HTML tag and its children blocks, if any. |\n\n### Step 2 - Adding the Product Highlights blocks to your theme templates\n\nCopy one of the examples stated below and paste it into your desired theme template, making the necessary changes. If needed, add the `product-highlights` block to the template block list.\n\n* Simple example:\n\n`1\n\n{ \n\n2\n\n \"vtex.product-highlights@2.x:product-highlights\": { \n\n3\n\n \"children\": [\"product-highlight-text\"] \n\n4\n\n }, \n\n5\n\n \"product-highlight-text\": { \n\n6\n\n \"props\": { \n\n7\n\n \"message\": \"{highlightName}\" \n\n8\n\n } \n\n9\n\n } \n\n10\n\n} \n\n`\n\n* Example using the `link` prop:\n\n`1\n\n{ \n\n2\n\n \"vtex.product-highlights@2.x:product-highlights\": { \n\n3\n\n \"children\": [\"product-highlight-text\"] \n\n4\n\n }, \n\n5\n\n \"product-highlight-text\": { \n\n6\n\n \"props\": { \n\n7\n\n \"message\": \"{highlightName}\", \n\n8\n\n \"link\": \"/collection/{highlightId}\" \n\n9\n\n } \n\n10\n\n } \n\n11\n\n} \n\n`\n\n* Example using `product-highlight-wrapper`:\n\n`1\n\n{ \n\n2\n\n \"vtex.product-highlights@2.x:product-highlights\": { \n\n3\n\n \"children\": [\"product-highlight-wrapper\"] \n\n4\n\n }, \n\n5\n\n \"product-highlight-wrapper\": { \n\n6\n\n \"children\": [ \n\n7\n\n \"icon-star\", // You can add anything inside a product-highlight-wrapper \n\n8\n\n \"product-highlight-text\" \n\n9\n\n ] \n\n10\n\n }, \n\n11\n\n \"product-highlight-text\": { \n\n12\n\n \"props\": { \n\n13\n\n \"message\": \"{highlightName}\" \n\n14\n\n } \n\n15\n\n } \n\n16\n\n} \n\n`\n\n* Example using the prop `filter` and the prop `type`:\n\n`1\n\n{ \n\n2\n\n \"vtex.product-highlights@2.x:product-highlights\": { \n\n3\n\n \"props\": { \n\n4\n\n \"type\": \"teaser\", \n\n5\n\n \"filter\": { \n\n6\n\n \"type\": \"show\", \n\n7\n\n \"highlightNames\": [\"10% Boleto\"] \n\n8\n\n } \n\n9\n\n }, \n\n10\n\n \"children\": [\"product-highlight-text\"] \n\n11\n\n }, \n\n12\n\n \"product-highlight-text\": { \n\n13\n\n \"props\": { \n\n14\n\n \"message\": \"{highlightName}\", \n\n15\n\n \"blockClass\": \"boleto\" \n\n16\n\n } \n\n17\n\n } \n\n18\n\n} \n\n`\n\n> warning\n> \n> Note that **the Product Highlights blocks require a Product context to work properly, as they handle product data**. Therefore, when declaring these blocks, ensure that they are in a theme template or block where this context is available, such as the `store.product` and `product-summary.shelf`.\n\n#### `product-highlights` props\n\n| Prop name | Type | Description | Default value |\n| --------- | ------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| type | enum | The desired type of product highlight to be displayed. Possible values are: collection, promotion, and teaser. collection highlights the product's collection, so it must be used with the [Collection Highlight](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/collection-highlight-control--1tGdb2ndjqy6yWsk2YwKMu?locale=en) feature. promotion and teaser should be used when the product is configured with a [promotion that includes highlights](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-promotions-with-a-highlightflag--tutorials%5F2295?locale=en). It can be used even if the promotion does not have any restrictions. On the other hand, the teaser must only be used when the promotion has restrictions. ⚠️\\* Note that nominal promotions will only be displayed in the cart, not on the shelf or product page.\\* | collection |\n| filter | object | Defines which highlights should and should not be displayed by the block. | undefined |\n\n> Technically, the `collection` highlight maps to the [clusterHighlights](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-graphql/blob/ea1d7e244e6b00b58e5aa4272fbb16987c483468/graphql/types/Product.graphql%23L29) property; the `promotion` highlight maps to the [discountHighlights](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-graphql/blob/ea1d7e244e6b00b58e5aa4272fbb16987c483468/graphql/types/Product.graphql%23L283) property; and the `teaser` highlight maps to the [teasers](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/search-graphql/blob/ea1d7e244e6b00b58e5aa4272fbb16987c483468/graphql/types/Product.graphql%23L284) property.\n\n* **`filter` object:**\n\n| Prop name | Type | Description | Default value |\n| -------------- | ---------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| highlightNames | \\[string\\] | An array of highlight names that determine which highlights should be hidden or shown based on the type property defined in the product-highlights block. | undefined |\n| type | enum | Determines whether the highlights for the highlightNames prop should be displayed or hidden on the UI. Possible values are: hide (hides highlights declared in the highlightNames prop) or show (only shows the highlights declared in the highlightNames prop). | undefined |\n\n#### `product-highlight-text` props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |\n| blockClass | string | The block ID you chose to be used for [CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23using-the-blockclass-property). | undefined |\n| message | string | Defines the block default text message to be rendered in the UI. You can also use the Admin Site Editor and the markers prop to specify the text message that the block will render on the UI. | undefined |\n| markers | \\[string\\] | IDs you chose to identify the block's rendered text message and customize it using the Admin Site Editor. Learn how to use them in [Using the Markers prop to customize a block message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message). Note that a block message can also be customized in the Store Theme source code using the message prop. | \\[\\] |\n| link | string | If this prop is set, it creates a link to the string passed. You can interpolate the variables highlightText and highlightId. Example: /collection/{highlightId}. | undefined |\n\n#### `product-highlight-wrapper` props\n\n| Prop name | Type | Description | Default value |\n| ---------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------- |\n| blockClass | string | The block ID you chose to be used in [CSS customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization%23using-the-blockclass-property). | undefined |\n\n### Step 3 - Editing the `product-highlight-text` messages\n\nThe `product-highlight-text` block uses the [ICU Message Format](https://read.calvincode.net/reader?url=https://format-message.github.io/icu-message-format-for-translators/), enabling comprehensive customization of the rendered text messages.\n\nWhen using the `message` prop, you will not need to create an advanced configuration: declare the prop directly in your Store Theme app and pass to it the desired text value to be rendered with the block.\n\nThe `markers` prop, in turn, requires you to add an extra configuration in the Site Editor of the Admin to properly work. When using this prop, do not forget to check out the block's message variables (shown in the table below) and the [Using the Markers prop to customize a block's message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-the-markers-prop-to-customize-a-blocks-message) documentation.\n\n| Message variable | Type | Description |\n| ---------------- | ------ | -------------------- |\n| highlightName | string | Highlights the name. |\n\n## Customization\n\nTo apply CSS customizations to this and other blocks, follow the instructions in [Using CSS handles for store customizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).\n\n| CSS handles |\n| ----------------------- |\n| productHighlightText |\n| productHighlightWrapper |\n\n| Data attributes |\n| ------------------- |\n| data-highlight-name |\n| data-highlight-id |\n| data-highlight-type |\n\n[Product Customizer« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-customizer)[Product IdentifierNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-identifier)\n\nSee also\n\n[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)\n\nON THIS PAGE\n\n[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-highlights%23configuration)\n\n[Step 1 - Adding the Product Highlights app to your theme dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-highlights%23step-1-adding-the-product-highlights-app-to-your-theme-dependencies)[Step 2 - Adding the Product Highlights blocks to your theme templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-highlights%23step-2-adding-the-product-highlights-blocks-to-your-theme-templates)[Step 3 - Editing the product-highlight-text messages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-highlights%23step-3-editing-the-product-highlight-text-messages)\n\n[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-product-highlights/docs/apps/vtex.product-highlights%23customization)\n\nWas this helpful?\n\n[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)"
}
] |
Subsets and Splits
No community queries yet
The top public SQL queries from the community will appear here once available.