[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides faststore molecules carousel in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[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-carousel/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/troubleshooting)

[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-carousel/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/components-index)

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-overview)

[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-accordion)

[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-alert)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-breadcrumb)

[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-buy-button)

[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-card)

[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel)

[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-cart-item)

[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-checkbox-field)

[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-discount-badge)

[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-dropdown)

[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-gift)

[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-icon-button)

[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-input-field)

[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-link-button)

[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-modal)

[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-navbar-links)

[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-order-summary)

[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-popover)

[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-card)

[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-price)

[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-title)

[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-quantity-selector)

[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-radio-field)

[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-radio-group)

[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-rating)

[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-rating-field)

[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-region-bar)

[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-auto-complete)

[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-dropdown)

[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-history)

[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-input-field)

[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-products)

[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-top)

[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-select-field)

[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-sku-selector)

[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-table)

[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-tag)

[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-textarea-field)

[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toast)

[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toggle)

[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toggle-field)

[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-tooltip)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/organisms-overview)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore)

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/getting-started-faststore-versions-and-support-levels)

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/components-index)

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-overview)

[Accordion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-accordion)

[Alert](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-alert)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-breadcrumb)

[BuyButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-buy-button)

[Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-card)

[Carousel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel)

[CartItem](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-cart-item)

[CheckboxField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-checkbox-field)

[DiscountBadge](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-discount-badge)

[Dropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-dropdown)

[Gift](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-gift)

[IconButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-icon-button)

[InputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-input-field)

[LinkButton](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-link-button)

[Modal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-modal)

[NavbarLinks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-navbar-links)

[OrderSummary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-order-summary)

[Popover](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-popover)

[ProductCard](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-card)

[ProductPrice](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-price)

[ProductTitle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-product-title)

[QuantitySelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-quantity-selector)

[RadioField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-radio-field)

[RadioGroup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-radio-group)

[Rating](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-rating)

[RatingField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-rating-field)

[RegionBar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-region-bar)

[SearchAutocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-auto-complete)

[SearchDropdown](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-dropdown)

[SearchHistory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-history)

[SearchInputField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-input-field)

[SearchProducts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-products)

[SearchTop](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-search-top)

[SelectField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-select-field)

[SKUSelector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-sku-selector)

[Table](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-table)

[Tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-tag)

[TextareaField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-textarea-field)

[Toast](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toast)

[Toggle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toggle)

[ToggleField](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-toggle-field)

[Tooltip](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-tooltip)

[Organisms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/organisms-overview)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/developing-and-overriding-components-overview)

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/api-extensions-overview)

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/components-index)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-overview)

Carousel

Slides through multiple elements using custom controls.

[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/molecules/Carousel)

The `Carousel` component slides through multiple elements using custom controls.

## Usage

### Import the component

`1

import { Carousel } from '@faststore/ui'

`

### Import styles

To apply styles, include the following in your stylesheet:

`1

@import '@faststore/ui/src/components/molecules/Carousel/styles.scss';

`

For 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).

---

## Examples

> This component is a work in progress, and in some cases, it may not perform as expected.

### Default

Example

Code

`itemsPerPage = 1`

* 1
* 2
* 3
* 4
* 5
* 6
* 7
* 8
* 9
* 10

Example

Code

`itemsPerPage = 5`

* 1
* 2
* 3
* 4
* 5
* 6
* 7
* 8
* 9
* 10

Example

Code

`itemsPerPage = 10`

* 1
* 2
* 3
* 4
* 5
* 6
* 7
* 8
* 9
* 10

### Infinite Scroll Mode

> This mode is only supported given the following props setup: `itemsPerPage={1}`, `variant="slide"` and `infiniteMode={true}`

Example

Code

* 1

---

## Design tokens

### Track

| Local token                   | Default value/Global token linked          |
| ----------------------------- | ------------------------------------------ |
| \--fs-carousel-padding-mobile | var(--fs-spacing-0) var(--fs-grid-padding) |

| Local token                    | Default value/Global token linked                                                 |
| ------------------------------ | --------------------------------------------------------------------------------- |
| \--fs-carousel-padding-desktop | var(--fs-spacing-0) calc((100% - var(--fs-grid-max-width))/2) var(--fs-spacing-0) |

### Item

| Local token                      | Default value/Global token linked |
| -------------------------------- | --------------------------------- |
| \--fs-carousel-item-margin-right | var(--fs-spacing-3)               |

### Controls

| Local token                              | Default value/Global token linked            |
| ---------------------------------------- | -------------------------------------------- |
| \--fs-carousel-controls-width            | 3.125rem                                     |
| \--fs-carousel-controls-height           | var(--fs-carousel-controls-width)            |
| \--fs-carousel-controls-bkg-color        | var(--fs-color-neutral-0)                    |
| \--fs-carousel-controls-border-radius    | var(--fs-border-radius-circle)               |
| \--fs-carousel-controls-box-shadow       | var(--fs-shadow-darker)                      |
| \--fs-carousel-controls-control-left     | var(--fs-spacing-4)                          |
| \--fs-carousel-controls-control-right    | var(--fs-carousel-controls-control-left)     |
| \--fs-carousel-controls-control-max-left | calc(-1 \* var(--fs-spacing-11))             |
| \--fs-carousel-controls-control-max-left | var(--fs-carousel-controls-control-max-left) |

### Bullets

| Local token                              | Default value/Global token linked         |
| ---------------------------------------- | ----------------------------------------- |
| \--fs-carousel-bullets-padding-top       | var(--fs-carousel-controls-control-left)  |
| \--fs-carousel-bullets-padding-left      | var(--fs-spacing-3)                       |
| \--fs-carousel-bullets-padding-right     | var(--fs-carousel-bullets-padding-left)   |
| \--fs-carousel-bullets-column-gap-mobile | var(--fs-carousel-item-margin-right)      |
| \--fs-carousel-bullets-column-gap-tablet | var(--fs-spacing-3)                       |
| \--fs-carousel-bullet-width-mobile       | 100%                                      |
| \--fs-carousel-bullet-width-desktop      | var(--fs-spacing-1)                       |
| \--fs-carousel-bullet-height-mobile      | var(--fs-carousel-item-margin-right)      |
| \--fs-carousel-bullet-height-desktop     | var(--fs-carousel-bullet-width-desktop)   |
| \--fs-carousel-bullet-bkg-color          | var(--fs-color-neutral-3)                 |
| \--fs-carousel-bullet-bkg-color-selected | var(--fs-color-main-4)                    |
| \--fs-carousel-bullet-border-radius      | var(--fs-carousel-controls-border-radius) |

---

## Data attributes

You can target and override `Carousel` styles using the following data attributes:

`data-fs-carousel`

`data-fs-carousel-track-container`

`data-fs-carousel-track`

`data-fs-carousel-item`

`data-fs-carousel-controls`

`data-fs-carousel-control`

`data-fs-carousel-bullets`

`data-fs-carousel-bullet`

---

## Use cases

### Using the `ProductCard` component

For the mobile preview, please refresh the browser after resizing it.

Example

Code

`itemsPerPage = 3`

* ![appleblack](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190932/mouse-black.jpg?v=1767729450)
### Apple Magic Mouse
Original price:$999Price:$950.04
* ![Monitor27](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190903/unsplash-monitor.jpg?v=1767729451)
### 4k Philips Monitor 27”
Original price:$490Price:$420
* ![echodotwhite](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190904/unsplash-smart-speaker.jpg?v=1767978734)
### Echo Dot Smart Speaker
Original price:$310Price:$280
* ![aedleheadphone](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190901/unsplash-headphone.jpg?v=1766352858)
### Aedle VK-1 L Headphone
Original price:$150Price:$130
* ![oculus](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190900/unsplash-vr-glasses.jpg?v=1765997962)
### Oculus VR Headset
Original price:$344Price:$315
* ![hic](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/173596/est.jpg?v=1757659088)
### Apple AirPods Pro
Original price:$249Price:$229
* ![quidem](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/179130/sint.jpg?v=1757911413)
### Anker SoundCore Liberty Air
Original price:$643.71Price:$486.34
* ![dolore](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/171611/eius.jpg?v=1757657196)
### Fujifilm X-T1 Camera
Original price:$495.97Price:$366.11
* ![culpa](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/159818/debitis.jpg?v=1757639123)
### SANDMARC Fisheye Lens
Original price:$946.73Price:$636.05
* ![odio](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/181988/nulla.jpg?v=1757915578)
### Apple AirTag
Original price:$679.29Price:$426.14

Example

Code

`itemsPerPage = 8`

* ![appleblack](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190932/mouse-black.jpg?v=1767729450)
### Apple Magic Mouse
Original price:$999Price:$950.04
* ![Monitor27](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190903/unsplash-monitor.jpg?v=1767729451)
### 4k Philips Monitor 27”
Original price:$490Price:$420
* ![echodotwhite](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190904/unsplash-smart-speaker.jpg?v=1767978734)
### Echo Dot Smart Speaker
Original price:$310Price:$280
* ![aedleheadphone](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190901/unsplash-headphone.jpg?v=1766352858)
### Aedle VK-1 L Headphone
Original price:$150Price:$130
* ![oculus](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190900/unsplash-vr-glasses.jpg?v=1765997962)
### Oculus VR Headset
Original price:$344Price:$315
* ![hic](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/173596/est.jpg?v=1757659088)
### Apple AirPods Pro
Original price:$249Price:$229
* ![quidem](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/179130/sint.jpg?v=1757911413)
### Anker SoundCore Liberty Air
Original price:$643.71Price:$486.34
* ![dolore](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/171611/eius.jpg?v=1757657196)
### Fujifilm X-T1 Camera
Original price:$495.97Price:$366.11
* ![culpa](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/159818/debitis.jpg?v=1757639123)
### SANDMARC Fisheye Lens
Original price:$946.73Price:$636.05
* ![odio](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/181988/nulla.jpg?v=1757915578)
### Apple AirTag
Original price:$679.29Price:$426.14

> Considering the component structure placed inside the `Carousel`, determine the ideal `itemsPerPage` number to accommodate the items and achieve the desired UI properly.

---

## Props

| Name                | Type                                                                     | Description                                                                            | Default                                                |          |
| ------------------- | ------------------------------------------------------------------------ | -------------------------------------------------------------------------------------- | ------------------------------------------------------ | -------- |
| **id**              | string                                                                   | ID of the current instance of the component.                                           | fs-carousel                                            |          |
| **testId**          | string                                                                   | ID to find this component in testing tools (e.g.: cypress, testing library, and jest). | fs-carousel                                            |          |
| **className**       | string                                                                   | Returns the value of element's class content attribute.                                |                                                        |          |
| **aria-label**      | string                                                                   | Defines a string value that labels the current element when title is not used.         |                                                        |          |
| **infiniteMode**    | false \| true                                                            | Whether or not the Carousel is infinite slide/scroll. Only for the \`slide\` variant.  | false                                                  |          |
| **controls**        | "complete" \| "navigationArrows"                                         | "paginationBullets"                                                                    | Specifies which navigation elements should be visible. | complete |
| **transition**      | { duration: number; property: string; delay?: number; timing?: string; } | Specifies the slide transition. Only for the \`slide\` variant                         | { duration: 400, property: 'transform', }              |          |
| **itemsPerPage**    | number                                                                   | Specifies the number of items per page.                                                | 1                                                      |          |
| **variant**         | "slide" \| "scroll"                                                      | Specifies the Carousel track variant.                                                  | scroll                                                 |          |
| **navigationIcons** | { left?: ReactNode; right?: ReactNode; }                                 | Specifies the navigation icons.                                                        | undefined                                              |          |

---

## Best Practices

### ✅ Do's

* We recommend using Carousel when the total of items being displayed is at least 10 items.
* Choose an `itemsPerPage` value that effectively accommodates the items within the slide without compromising the UI. Consider proposing different values for mobile and desktop.
* Maintain the visibility of the controls (`navigationArrows` & `paginationBullets`) to ensure that users can easily navigate through the slider. On desktop, these controls are displayed on `hover`, allowing for intuitive item selection.

### ❌ Don'ts

* Don't exaggerate the number of items according to the item's width. You can combine it, providing an alternate navigation path like a `See More` button to a collection. Also, make sure to check how they look on different screens.

---

## Related components

* * ![appleblack](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190932/mouse-black.jpg?v=1767729450)
   ### Apple Magic Mouse
   Original price:$999Price:$950.04
   * ![Monitor27](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190903/unsplash-monitor.jpg?v=1767729451)
   ### 4k Philips Monitor 27”
   Original price:$490Price:$420
   * ![echodotwhite](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190904/unsplash-smart-speaker.jpg?v=1767978734)
   ### Echo Dot Smart Speaker
   Original price:$310Price:$280
   * ![aedleheadphone](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190901/unsplash-headphone.jpg?v=1766352858)
   ### Aedle VK-1 L Headphone
   Original price:$150Price:$130
   * ![oculus](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/190900/unsplash-vr-glasses.jpg?v=1765997962)
   ### Oculus VR Headset
   Original price:$344Price:$315
   * ![hic](https://read.calvincode.net/reader?url=https://storeframework.vtexassets.com/arquivos/ids/173596/est.jpg?v=1757659088)
   ### Apple AirPods Pro
   Original price:$249Price:$229
Product Shelf
Displays a list of products to be used as a section on the store.
[See more ](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/organisms-product-shelf)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/carousel.mdx)

[Card« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-card)[CartItemNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-cart-item)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F67270558%3Fv%3D4%26w=64%26q=75)](https://github.com/mariana-caetano)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F62757720%3Fv%3D4%26w=64%26q=75)](https://github.com/aliceoq)

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23usage)

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23import-styles)

[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23examples)

[Default](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23default)[Infinite Scroll Mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23infinite-scroll-mode)

[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23design-tokens)

[Track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23track)[Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23item)[Controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23controls)[Bullets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23bullets)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23data-attributes)

[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23use-cases)

[Using the ProductCard component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23using-the-productcard-component)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23props)

[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23best-practices)

[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23-donts)

[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23related-components)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/components/molecules/carousel.mdx)

Copy page

On this page

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23usage)

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23import-styles)

[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23examples)

[Default](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23default)[Infinite Scroll Mode](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23infinite-scroll-mode)

[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23design-tokens)

[Track](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23track)[Item](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23item)[Controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23controls)[Bullets](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23bullets)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23data-attributes)

[Use cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23use-cases)

[Using the ProductCard component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23using-the-productcard-component)

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23props)

[Best Practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23best-practices)

[✅ Do's](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23-dos)[❌ Don'ts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23-donts)

[Related components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/molecules-carousel/docs/guides/faststore/molecules-carousel%23related-components)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides working with schemas in the profile system in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-protection-plus)

[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/pii-data-architecture-specifications)

[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-residency)

[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/profile-system)

[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system)

[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)

[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-protection-plus)

[PII Data Architecture specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/pii-data-architecture-specifications)

[Data residency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-residency)

[Profile System integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/profile-system)

[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system)

[Changes in VTEX features behavior to handle PII data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)

[Limitations of the PII data architecture during closed beta](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/limitations-of-the-pii-data-architecture-during-closed-beta)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides)

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-protection-plus)

[Working with schemas in the Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system)

Working with schemas in the Profile System

> [Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/data-protection-plus) is in closed beta phase, only available in select regions.
>
> This feature is part of [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you are already a VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you are not yet a customer but are interested in this solution, please complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/contact/).

A JSON Schema defines the structure of data stored in the [Profile System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system). It determines, for example, which fields a profile has and their respective formats. To learn more about JSON Schemas, read the [JSON Schema external documentation](https://read.calvincode.net/reader?url=http://json-schema.org/).

The following endpoints in the [Profile System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/profile-system) allow you to interact with the profile schema:

| Endpoint name                                                                                | Description                                                                                |
| ---------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------- |
| GET [Get full schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/schemas/profileSystem)                       | Retrieves the full profile schema, including default and custom fields.                                                                        |
| GET [Get custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23get-/api/storage/profile-system/schemas/profileSystem/custom)              | Retrieves custom fields in the profile schema.                                                                                |
| PUT [Create or delete custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23put-/api/storage/profile-system/schemas/profileSystem/custom) | Allows you to customize fields. Learn more about possible customizations in [Customizing the profile schema](#customizing-the-profile-schema). |

## Customizing the profile schema

Using the `PUT` [Create or delete custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23put-/api/storage/profile-system/schemas/profileSystem/custom) endpoint allows you to customize the schema for the profile entity in the Profile System by:

* [Adding custom fields](#adding-custom-fields)
* [Defining PII and sensitive custom fields](#defining-pii-and-sensitive-custom-fields)
* [Configuring TTL](#configuring-ttl)
* [Deleting custom fields](#deleting-custom-fields)
* [Restrictions](#restrictions)

> Make sure you check the applicable [Restrictions](#restrictions).

### Adding custom fields

Extend the profile schema with custom fields by making a request to `PUT` [Create or delete custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23put-/api/storage/profile-system/schemas/profileSystem/custom), with a request body structured as in the following example.

**Request body example**

`1

{

2

 "customField1": {

3

 "type": ["string", "null"],

4

 "sensitive": true,

5

 "pii": true

6

 },

7

 "customField2": {

8

 "type": ["string", "null"],

9

 "sensitive": false,

10

 "pii": false

11

 }

12

}

`

> Every time you add new custom properties or edit existing ones, you must pass all custom properties in the request body, or they will be replaced by those present in the most recent request body used. For example, to edit `customField2` later on, you need to include `customField1` in the request body even if it has not changed.

### Defining PII and sensitive custom fields

Properties marked as Personally Identifiable Information (PII) or sensitive are the ones that are masked by default and must be audited when accessed by a user for legal reasons.

Set the `sensitive` and/or `pii` properties as `true` inside the JSON Schema property definition to determine that they must follow this behavior, as exemplified below.

**Request body example - PII and sensitive field**

`1

{

2

 "document": {

3

 "type": "string",

4

 "sensitive": true,

5

 "pii": true

6

 }

7

}

`

### Configuring TTL

The TTL (Time To Live) property is a value expressed in days used to schedule the deletion of the document in the future. When this time expires, the document is automatically deleted.

**Example**

`1

"documentTTL": 1825,

`

### Deleting custom fields

If you want to delete all custom fields, make a request to `PUT` [Create or delete custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/profile-system%23put-/api/storage/profile-system/schemas/profileSystem/custom) with an empty JSON as the request body.

To delete only one or more fields, but not all, make this request including every custom field in the request body except the ones to be removed.

### Restrictions

The following restrictions apply when working with custom fields in the profile schema:

* You cannot use `oneOf`, `anyOf`, `allOf,` or `not` [keywords](https://read.calvincode.net/reader?url=https://swagger.io/docs/specification/data-models/oneof-anyof-allof-not/).
* The schema is valid per account.
* You cannot remove or edit required fields. Custom fields cannot be mandatory, so the existing documents will still be compatible with the new schema.
* Default fields cannot be changed.
* Custom fields cannot be in `v-indexed` or in `v-unique`.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/working-with-schemas-in-the-profile-system.md)

[Profile System integration« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system//docs/guides/profile-system)[Changes in VTEX features behavior to handle PII dataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system//docs/guides/changes-in-vtex-features-behavior-to-handle-pii-data)

See also

[Profile System integrationGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/profile-system)[Data Protection PlusGuides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/data-protection-plus)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F77292838%3Fv%3D4%26w=64%26q=75)](https://github.com/julia-rabello)

ON THIS PAGE

[Customizing the profile schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23customizing-the-profile-schema)

[Adding custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23adding-custom-fields)[Defining PII and sensitive custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23defining-pii-and-sensitive-custom-fields)[Configuring TTL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23configuring-ttl)[Deleting custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23deleting-custom-fields)[Restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23restrictions)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/data-privacy/working-with-schemas-in-the-profile-system.md)

Copy page

On this page

ON THIS PAGE

[Customizing the profile schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23customizing-the-profile-schema)

[Adding custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23adding-custom-fields)[Defining PII and sensitive custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23defining-pii-and-sensitive-custom-fields)[Configuring TTL](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23configuring-ttl)[Deleting custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23deleting-custom-fields)[Restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/working-with-schemas-in-the-profile-system/docs/guides/working-with-schemas-in-the-profile-system%23restrictions)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)


[System] You are a VTEX documentation expert. You provide accurate, detailed information about VTEX platform, APIs, apps, and Store Framework development.

[User] Provide a guide on guides simulate a shopping cart in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/shopping-cart-section-api-quick-start-guides)

[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart)

[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/create-a-new-cart)

[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/get-cart-information-by-id)

[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/remove-all-items-from-cart)

[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/remove-all-personal-data)

[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/add-cart-items)

[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/update-cart-items)

[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/change-price)

[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/ignore-profile-data)

[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/get-cart-installments-information)

[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/add-coupons-to-the-cart)

[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/add-service-to-the-cart)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-api-overview)

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/shopping-cart-section-api-quick-start-guides)

[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart)

[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/create-a-new-cart)

[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/get-cart-information-by-id)

[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/remove-all-items-from-cart)

[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/remove-all-personal-data)

[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/add-cart-items)

[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/update-cart-items)

[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/change-price)

[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/ignore-profile-data)

[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/get-cart-installments-information)

[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/add-coupons-to-the-cart)

[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/add-service-to-the-cart)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides)

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/checkout-api-overview)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/shopping-cart-section-api-quick-start-guides)

[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart)

Simulate a shopping cart

The 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.

This guide will describe the process of simulating a shopping cart at Checkout.

## Simulating a shopping cart

The first step is to send the parameters you want to be in the cart. This can be done via the [Cart Simulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/cartsimulation) endpoint's request body.

See a request body example below:

`1

{

2

 "items": [

3

 {

4

 "id": "1",

5

 "quantity": 1,

6

 "seller": "1"

7

 }

8

 ],

9

 "country": "BRA"

10

}

`

>  The fields `id`, `quantity`, `seller`, and `country` are just examples of content that you can simulate in your cart. You can add more fields to the request as per your need. Access the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview to check the available fields.

After sending the request, the endpoint will return the response body containing the shopping cart information, as shown in the example below:

`1

"items": [

2

 {

3

 "id": "1",

4

 "requestIndex": 0,

5

 "quantity": 1,

6

 "seller": "1",

7

 "sellerChain": [

8

 "1"

9

 ],

10

 "tax": 0,

11

 "priceValidUntil": "2023-09-28T11:53:03Z",

12

 "price": 9999,

13

 "listPrice": 13499,

14

 "rewardValue": 0,

15

 "sellingPrice": 2999700,

16

 "offerings": [],

17

 "priceTags": [],

18

 "measurementUnit": "un",

19

 "unitMultiplier": 300.0000,

20

 "parentItemIndex": null,

21

 "parentAssemblyBinding": null,

22

 "availability": "available",

23

 "catalogProvider": "vrn:vtex.catalog-api-proxy:-:lojadobreno:master:/proxy/authenticated/catalog/pvt/sku/stockkeepingunitbyid/1",

24

 "priceDefinition": {

25

 "calculatedSellingPrice": 2999700,

26

 "total": 2999700,

27

 "sellingPrices": [

28

 {

29

 "value": 2999700,

30

 "quantity": 1

31

 }

32

 ]

33

 }

34

 }

35

 ],

36

 ...

`

## Error codes

The following errors may appear as a message in the response body.

### 200 - OK

Despite the code `200` (which indicates the success of the request), if the item `id` sent is incorrect or unavailable, the following message will appear.

* **Message error example (code ORD027)**: `"Item 5550 não encontrado ou indisponível"` (_item 5550 not found or unavailable_).

`1

"messages": [

2

 {

3

 "code": "ORD027",

4

 "text": "Item 5550 não encontrado ou indisponível",

5

 "status": "error",

6

 "fields": {

7

 "id": "5550"

8

 }

9

 }

10

 ]

`

### 400 - Bad Request

The Bad Request error appears for several reasons, such as when a mandatory field was not filled in correctly (eg seller) or the item quantity was not specified. In addition to the 400 error code, an additional code will be shown to indicate the type of error.

* **Message error example (code ORD005)**: `"O campo Id do item é obrigatório"` (_item ID field is required_).

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD005",

5

 "message": "O campo Id do item é obrigatório",

6

 "exception": null

7

 },

8

 "operationId": "5ac2e42e-0967-43b3-b0b4-dcbc6da118b1"

9

}

`

* **Message error example (code CHK0024)**: `"Id de vendedor de item inválido"` (_invalid item seller id_).

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "CHK0024",

5

 "message": "Id de vendedor de item inválido",

6

 "exception": null

7

 },

8

 "operationId": "7adbc4af-32c8-4365-9f7e-c40ffc9ccf5a"

9

}

`

### 404 - Not Found

* **Message error example**: `"The requested URL was not found on the server"`. Check that the URL data is correct.

`1

2

404 Not Found

3

The requested URL was not found on this server.

4

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

Was this helpful?

Yes

No

[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/simulate-a-shopping-cart.md)

[Shopping Cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart//docs/guides/shopping-cart-section-api-quick-start-guides)[Get current or create a new cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart//docs/guides/create-a-new-cart)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[Simulating a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23simulating-a-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23error-codes)

[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23404-not-found)

Was this helpful?

 Send feedback

[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/simulate-a-shopping-cart.md)

Copy page

On this page

ON THIS PAGE

[Simulating a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23simulating-a-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23error-codes)

[200 - OK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23200-ok)[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/simulate-a-shopping-cart/docs/guides/simulate-a-shopping-cart%23404-not-found)

On this page

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)