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

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/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/schema-mutations/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/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/schema-mutations/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/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/schema-mutations/updates/release-notes)

Storefront Development

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

---

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

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/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/schema-mutations/docs/guides/faststore/getting-started-overview)

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

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

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

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

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

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

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

[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-queries)

[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations)

[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-objects)

[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-inputs)

[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-enums)

[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-scalars)

[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)

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

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/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/schema-mutations/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/schema-mutations/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/schema-mutations/docs/guides/faststore/managing-performance-overview)

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

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

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

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

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

---

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

Storefront Development

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

---

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

[FastStore versions and support levels](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/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/schema-mutations/docs/guides/faststore/getting-started-overview)

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

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

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

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

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

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

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

[Queries](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-queries)

[Mutations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations)

[Objects](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-objects)

[Inputs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-inputs)

[Enums](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-enums)

[Scalars](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-scalars)

[Configuring GraphQL cache control for GET requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/faststore-api-configuring-graphql-cache-control)

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

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/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/schema-mutations/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/schema-mutations/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/schema-mutations/docs/guides/faststore/managing-performance-overview)

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

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

Mutations

## Cart

| Field            | Argument                                                                                | Type                                                                                | Description |
| ---------------- | ---------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- |
| **validateCart** | [StoreCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storecart)        | Checks for changes between the cart presented in the UI and the cart stored in the ecommerce platform. If changes are detected, it returns the cart stored on the platform. Otherwise, it returns null. |             |
| cart             | [IStoreCart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istorecart)!      | Shopping cart input.                                                                                |             |
| session          | [IStoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoresession) | Web session identifier.                                                                                |             |

> There is a Known Issue with the `validateCart` mutation. If an external request modifies the store cart with additional information like marketing data, it disrupts the store cart synchronization process, interfering with the connection between the cart displayed on the storefront and the actual cart data stored on the server. This may lead to issues for store users, such as items not being added, incorrect totals, or checkout problems. After any external cart update, refresh the cart data using the workaround instructions in the [Cart does not update in FastStore if an external request is made to update orderForm](https://read.calvincode.net/reader?url=https://help.vtex.com/en/known-issues/cart-does-not-update-in-faststore-if-external-request-is-made-to-update-orderform--7ef1GxxapbH2XKKf7HBuAM) guide.

## Session

| Field                     | Argument                                                                                | Type                                             | Description |
| ------------------------- | ------------------------------------------------------------------------------------------------------- | ------------------------------------------------ | ----------- |
| **validateSession**       | [StoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23storesession)           | Updates a web session with the specified values. |             |
| session                   | [IStoreSession](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23istoresession)!         | Web session identifier.                          |             |
| search                    | [String](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-scalars%23string)!                      |                                                  |             |
| **subscribeToNewsletter** | [PersonNewsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-objects%23personnewsletter)   | Subscribes a new person to the newsletter list.  |             |
| data                      | [IPersonNewsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-inputs%23ipersonnewsletter)! | Person data input to the newsletter.             |             |

Contributors

1

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

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/docs/faststore-api/schema/mutations.mdx)

[Queries« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-queries)[ObjectsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-objects)

Contributors

1

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

ON THIS PAGE

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations%23cart)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations%23session)

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/docs/faststore-api/schema/mutations.mdx)

Copy page

On this page

ON THIS PAGE

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations%23cart)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/schema-mutations/docs/guides/faststore/schema-mutations%23session)

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] How do I use the VTEX product comparison app? Provide documentation and configuration details.

[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/apps/vtex.product-comparison/docs/guides)

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

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

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

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

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/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/apps/vtex.product-comparison/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/advanced-components)

[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.availability-notify)

[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.category-menu)

[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexbr.kitlook)

[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-icons/iconpack)

[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.iframe)

[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexventures.livestreaming)

[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.connector-paypal-commerce-platform)

[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexventures.personal-shopper-free)

[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-availability)

[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison)

[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-gifts)

[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexarg.product-highlight-by-vtex-segment)

[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-specification-badges)

[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexarg.quantity-on-cart)

[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.reviews-and-ratings)

[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.safedata)

[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.seller-selector)

[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.similar-products-variants)

[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-drawer)

[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-locator)

[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-form)

[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-link)

[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-media)

[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-newsletter)

[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-video)

[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.sandbox)

[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.shipping-option-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/vtex-io-deprecated-apps)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/storefront-development)

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/updates/release-notes)

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/basic-components)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/advanced-components)

[Availability Notify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.availability-notify)

[Category Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.category-menu)

[Kit Look](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexbr.kitlook)

[Icon Pack list](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-icons/iconpack)

[Iframe](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.iframe)

[Live Shopping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexventures.livestreaming)

[PayPal Checkout with Smart Payment Buttons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.connector-paypal-commerce-platform)

[Personal Shopper](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexventures.personal-shopper-free)

[Product Availability](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-availability)

[Product Comparison](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison)

[Product Gifts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-gifts)

[Product Highlight by VTEX Segment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexarg.product-highlight-by-vtex-segment)

[Product Specification Badges](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-specification-badges)

[Quantity On Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtexarg.quantity-on-cart)

[Reviews and Ratings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.reviews-and-ratings)

[Querying personal MasterData Information with SafeData](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.safedata)

[Seller Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.seller-selector)

[Similar Products Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.similar-products-variants)

[Store Drawer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-drawer)

[Store Locator](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-locator)

[Store Form](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-form)

[Store Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-link)

[Store Media](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-media)

[Store Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-newsletter)

[Video](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.store-video)

[VTEX IO Sandbox Component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.sandbox)

[Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.shipping-option-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.my-account)

---

[VTEX IO deprecated apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/vtex-io-deprecated-apps)

---

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

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/guides/advanced-components)

Product Comparison

Official extension

Version: 0.20.0

Latest version: 0.20.0

[![{"base64":"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAQAAAABCAIAAAB2XpiaAAAACXBIWXMAAAsTAAALEwEAmpwYAAAAFUlEQVR4nGPg4+Mz1Nfjl5T7f2c+AAzxA3lptuDWAAAAAElFTkSuQmCC","img":{"src":"https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square","width":110,"height":20,"type":"svg"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)

The Product Comparison app compares specifications of pre-selected SKUs, allowing customers to better understand their needs when shopping.

The app exports several blocks, which you can leverage to display a Product Comparison drawer on your store's search results page and a new Product Comparison page.

![{"base64":"  ","img":{"width":1886,"height":843,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":451727,"url":"https://user-images.githubusercontent.com/2637457/90900569-43a41a00-e3e7-11ea-9aa9-9a12bbec8c5e.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/2637457/90900569-43a41a00-e3e7-11ea-9aa9-9a12bbec8c5e.png)

_Product Comparison drawer on the store's search results page_

![{"base64":"  ","img":{"width":1456,"height":937,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":270488,"url":"https://user-images.githubusercontent.com/2637457/90900828-a1386680-e3e7-11ea-96d1-e9ba2022aa7d.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/2637457/90900828-a1386680-e3e7-11ea-96d1-e9ba2022aa7d.png)

_Product Comparison page_

## Configuration

### Step 1 - Adding the Product Comparison app to your theme's dependencies

In your theme's `manifest.json` file, add the `Product Comparison` app as a dependency:

`1

 "dependencies": {

2

+ "vtex.product-comparison": "0.x"

3

 }

`

Now, you can use all the blocks exported by the Product Comparison app. Check out the full list below:

| Block name                                              | Description                                                                                |
| ------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| product-comparison-drawer                               | ![{"base64":"  ","img":{"width":69,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/-Mandatory-red"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/-Mandatory-red) Main block that renders the drawer from the Product Comparison component in which the items will be compared. |
| list-context.comparison-product-summary-slider          | Extends the list-context block to build the Product Comparison component using the [Slider Layout](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/layout-blocks/vtex.slider-layout/.)                                                                                |
| product-summary.shelf.product-comparison                | Extends the default product-summary.shelf block (from the [Product Summary app](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/all/vtex.product-summary/)) for the Product Comparison component's features.                                                                                |
| product-comparison-block                                | Logical block that, once extended (see blocks listed below), renders the Product Comparison component's features.                                                                                |
| product-comparison-block.selector                       | Renders the selector checkbox on the Product Comparison component.                                                                                |
| product-comparison-block.close-button                   | Renders the close button on the Product Comparison component.                                                                                |
| product-comparison-block.product-summary-row            | Renders the first row to list and compare products on the Product Comparison component.                                                                                |
| list-context.comparison-row                             | Extends the list-context block to build a row in the Product Comparison page using the [Slider Layout](https://read.calvincode.net/reader?url=https://vtex.io/docs/components/layout-blocks/vtex.slider-layout/.)                                                                                |
| product-comparison-block.grouped-product-specifications | Renders the section for product specification groups.                                                                                |
| product-comparison-block.product-specifications         | Renders the section for product specifications.                                                                                |
| product-comparison-block.sku-specifications             | Renders the section for SKU specifications.                                                                                |

### Step 2 - Adding extended interfaces

In the theme's `interfaces.json` file, add the following extended interfaces:

`1

+{

2

+ "store.search.product-comparison": {

3

+ "around": ["comparison-context-wrapper"]

4

+ },

5

+ "search-result-layout.desktop.product-comparison": {

6

+ "allowed": ["product-comparison-drawer"]

7

+ },

8

 "store.product.product-comparison": {

9

 "around": ["comparison-context-wrapper"],

10

 "allowed": ["product-comparison-drawer"]

11

 }

12

+}

`

### Step 3 - Wrapping the search blocks with Product Comparison context

1. In the theme's `search.jsonc` file, replace the default `store.search` blocks with the `store.search.product-comparison` blocks, as shown in the example below:

`1

{

2

 ...

3

- "store.search": {

4

+ "store.search.product-comparison": {

5

 ...

6

 },

7

- "store.search#brand": {

8

+ "store.search.product-comparison#brand": {

9

 ...

10

 },

11

- "store.search#department": {

12

+ "store.search.product-comparison#department": {

13

 ...

14

 }

15

- "store.search#category": {

16

+ "store.search.product-comparison#category": {

17

 ...

18

 }

19

- "store.search#subcategory": {

20

+ "store.search.product-comparison#subcategory": {

21

 ...

22

 }

23

 ...

`

> The `store.search.product-comparison` blocks wrap the `store.search` block with comparison context. The replacement is needed to synchronously display the selected products in the Product Comparison drawer.

1. Replace the `search-result-layout.desktop` blocks with the `search-result-layout.desktop.product-comparison` blocks, as shown below:

`1

{

2

 ...

3

"search-result-layout": {

4

 "blocks": [

5

- "search-result-layout.desktop#search"

6

+ "search-result-layout.desktop.product-comparison#search",

7

 "search-result-layout.mobile",

8

 "search-not-found-layout"

9

 ]

10

},

`

1. Replace the `product-summary.shelf`, child of the `gallery` block, with the `product-summary.shelf.product-comparison`:

`1

"gallery": {

2

- "blocks": ["product-summary.shelf"]

3

+ "blocks": ["product-summary.shelf.product-comparison#search"]

4

}

5

...

`

### Step 4 - Adding the Product Comparison to the product detail Page

1. In the theme's `product.json` file, replace the default `store.product` blocks with the `store.product.product-comparison` blocks, as shown in the example below:

`1

2

- "store.product": {

3

+ "store.product.product-comparison": {

4

 ...

5

 }

`

1. Add `product-comparison-drawer` to the `store.product.product-comparison` children, as shown in the example below:

`1

"store.product.product-comparison": {

2

 children:[

3

 ...

4

+ "product-comparison-drawer"

5

 ]

6

 ...

7

}

`

1. Add `product-comparison-block.selector#pdp` to the `store.product.product-comparison` block, as shown in the example below:

`1

 "store.product.product-comparison": {

2

 ...

3

 children:[

4

 ...

5

+ "product-comparison-block.selector#pdp"

6

 ]

7

 ...

8

 }

`

### Step 5 - Building the Product Comparison component

In any desired template, such as `store.search`, add the `product-comparison-drawer` block, as shown below:

`1

- "search-result-layout.desktop#search": {

2

+ "search-result-layout.desktop.product-comparison#search": {

3

 "children": [

4

 "flex-layout.row#did-you-mean",

5

 "flex-layout.row#suggestion",

6

 "flex-layout.row#banner-one",

7

 "flex-layout.row#searchbread",

8

 "flex-layout.row#searchtitle",

9

 "flex-layout.row#result",

10

+ "product-comparison-drawer"

11

 ],

12

 "props": {

13

 "pagination": "show-more",

14

 "preventRouteChange": false,

15

 "mobileLayout": {

16

 "mode1": "small",

17

 "mode2": "normal"

18

 }

19

 }

20

}

21

...

`

By adding the `product-comparison-drawer` block as shown above, you will declare the following structure behind the scenes:

`1

"product-comparison-drawer": {

2

 "blocks": ["list-context.comparison-product-summary-slider#drawer"]

3

},

4

"list-context.comparison-product-summary-slider#drawer": {

5

 "blocks": ["product-summary.shelf.product-comparison#drawer"],

6

 "children": ["slider-layout#comparison-drawer"]

7

},

8

"slider-layout#comparison-drawer": {

9

 "props": {

10

 "blockClass": "comparison-drawer",

11

 "itemsPerPage": {

12

 "desktop": 4,

13

 "tablet": 3,

14

 "phone": 1

15

 },

16

 "showPaginationDots": "never",

17

 "infinite": true,

18

 "fullWidth": true

19

 }

20

},

21

"product-summary.shelf.product-comparison#drawer": {

22

 "children": [

23

 "product-summary-column#drawer-col2",

24

 "product-comparison-block.close-button"

25

 ],

26

 "props": {

27

 "blockClass": "drawer-summary"

28

 }

29

},

30

"product-summary-column#drawer-col2": {

31

 "children": ["product-summary-name", "product-summary-price#comparison"],

32

 "props": {

33

 "blockClass": "drawer-summary-col2"

34

 }

35

},

36

"product-summary-price#comparison": {

37

 "props": {

38

 "showListPrice": false,

39

 "showSellingPriceRange": false,

40

 "showLabels": false,

41

 "showInstallments": false,

42

 "showDiscountValue": false

43

 }

44

}

`

> _The code above is a default implementation of the Product Comparison component. To make any changes, declare the code above in your theme and perform the needed updates according to the available blocks._

### Step 6 - Building the Product Comparison page

1. In the `/store/blocks` folder, create a new file called `product-comparison.json` and include the following JSON:

`1

"store.custom#product-comparison-list": {

2

 "blocks": ["comparison-page"]

3

},

4

5

"comparison-page": {

6

 "children": ["slider-layout-group#comparison-page"]

7

},

8

9

"slider-layout-group#comparison-page": {

10

 "children": [

11

 "product-comparison-block.product-summary-row",

12

 "product-comparison-block.grouped-product-specifications"

13

 ]

14

},

15

"product-comparison-block.product-summary-row": {

16

 "blocks": ["list-context.comparison-product-summary-slider#comparison-page"]

17

},

18

"list-context.comparison-product-summary-slider#comparison-page": {

19

 "blocks": ["product-summary.shelf.product-comparison#comparison-page"],

20

 "children": ["slider-layout#comparison-page-product-summary"]

21

},

22

"product-summary.shelf.product-comparison#comparison-page": {

23

 "children": [

24

 "flex-layout.row",

25

 "product-summary-image#comparison-page",

26

 "product-summary-name",

27

 "product-summary-space",

28

 "product-summary-price#comparison",

29

 "product-summary-buy-button"

30

 ],

31

 "props": {

32

 "blockClass": "comparison-page-summary"

33

 }

34

},

35

"flex-layout.row": {

36

 "children": ["product-comparison-block.close-button"],

37

 "props": {

38

 "blockClass": "close",

39

 "horizontalAlign": "right"

40

 }

41

},

42

"product-summary-image#comparison-page": {

43

 "props": {

44

 "width": 200,

45

 "heightProp": 200

46

 }

47

},

48

"product-comparison-block.grouped-product-specifications": {

49

 "blocks": ["list-context.comparison-row#comparison-page-row"]

50

},

51

"list-context.comparison-row#comparison-page-row": {

52

 "children": ["slider-layout#comparison-no-arrows"]

53

},

54

"slider-layout#comparison-page-product-summary": {

55

 "props": {

56

 "blockClass": "comparison-page",

57

 "itemsPerPage": {

58

 "desktop": 4,

59

 "tablet": 3,

60

 "phone": 1

61

 },

62

 "showPaginationDots": "never",

63

 "infinite": true,

64

 "fullWidth": true

65

 }

66

},

67

"slider-layout#comparison-no-arrows": {

68

 "props": {

69

 "itemsPerPage": {

70

 "desktop": 4,

71

 "tablet": 3,

72

 "phone": 1

73

 },

74

 "showPaginationDots": "never",

75

 "infinite": true,

76

 "fullWidth": true,

77

 "blockClass": "comparison-page",

78

 "showNavigationArrows": "never"

79

 }

80

}

`

1. In the theme's `routes.json` file, add a new route for the Product Comparison page:

`1

+{

2

+ "store.custom#product-comparison-list": {

3

+ "path": "/product-comparison"

4

+ }

5

+}

`

#### `product-comparison-block.grouped-product-specifications` props

| Prop name                        | Type       | Description                                                                                | Default value |
| -------------------------------- | ---------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| productSpecificationsToHide      | \[string\] | List of product fields that should be hidden in the Product Comparison page. The desired product fields must be separated by a comma.                             | undefined     |
| productSpecificationGroupsToHide | \[string\] | List of product specification groups that should be hidden on the Product Comparison page. The desired product specification groups must be separated by a comma. | undefined     |

#### `product-comparison-block.product-specifications` props

| Prop name                   | Type       | Description                                                                                | Default value |
| --------------------------- | ---------- | ------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| productSpecificationsToHide | \[string\] | List of product fields that should be hidden in the Product Comparison page. The desired product fields must be separated by a comma. | undefined     |

#### `product-comparison-block.sku-specifications` props

| Prop name               | Type       | Description                                                                                | Default value |
| ----------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| skuSpecificationsToHide | \[string\] | List of SKU specification fields that should be hidden on the Product Comparison page. The desired SKU specification fields must be separated by a comma. | undefined     |

#### `product-comparison-block.product-summary-row` props

| Prop name               | Type    | Description                                                                                | Default value |
| ----------------------- | ------- | --------------------------------------------------------------------------------------------- | ------------- |
| isShowDifferenceDefault | boolean | Set the "show only differences" checkbox to true as the default value on the comparison page. | false         |
| \=======                |         |                                                                                |               |

### Step 7 - Change the comparison bucket size

This is an optional configuration, so you can set a fixed number in the app configuration to change the maximum number of items in the comparison bucket. The default value is 10 items; if you exceed the maximum limit, you will receive a notification.

#### Instructions

1. Go to `/admin/apps`, then find the `Product Comparison` app under `Installed` apps.
2. Click Settings.
3. Enter the maximum comparison bucket size for your application.

## Customization

To apply CSS customizations in this and other blocks, follow the instructions in [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).

| CSS Handles                 |
| --------------------------- |
| closeButton                 |
| closeButtonContainer        |
| compareProductsButton       |
| comparisonButtons           |
| comparisonCol               |
| drawer                      |
| drawerContainer             |
| expandCollapseButton        |
| fieldNameCol                |
| fieldNameCol                |
| productFieldValue           |
| productSelectorContainer    |
| productSpecificationValue   |
| productSpecificationValues  |
| productSummaryRowContainer  |
| rowContainer                |
| showDifferencesContainer    |
| skuFieldValue               |
| skuSpecificationValue       |
| skuSpecificationValues      |
| title                       |
| removeAllItemsButtonWrapper |
| compareProductButtonWrapper |
| removeAllWrapper            |
| drawerTitleOuterContainer   |
| drawerTitleInnerContainer   |
| drawerOpened                |
| drawerClosed                |

[Product Availability« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-availability)[Product GiftsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-gifts)

See also

[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23configuration)

[Step 1 - Adding the Product Comparison app to your theme's dependencies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-1-adding-the-product-comparison-app-to-your-themes-dependencies)[Step 2 - Adding extended interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-2-adding-extended-interfaces)[Step 3 - Wrapping the search blocks with Product Comparison context](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-3-wrapping-the-search-blocks-with-product-comparison-context)[Step 4 - Adding the Product Comparison to the product detail Page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-4-adding-the-product-comparison-to-the-product-detail-page)[Step 5 - Building the Product Comparison component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-5-building-the-product-comparison-component)[Step 6 - Building the Product Comparison page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-6-building-the-product-comparison-page)[Step 7 - Change the comparison bucket size](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23step-7-change-the-comparison-bucket-size)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-comparison/docs/apps/vtex.product-comparison%23customization)

Was this helpful?

[Github](https://read.calvincode.net/reader?url=https://github.com/vtex-apps)[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/)[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)[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 recaptcha 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/recaptcha/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/updates/release-notes)

Guides

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

---

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

---

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

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha)

[Applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/applicable-cases)

[Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/implementing-recaptcha-in-integrations)

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/erp-integration-guide)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/punchout)

[Offer Management Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/sent-offers-integration-guide-connectors)

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha)

[Applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/applicable-cases)

[Implementing reCAPTCHA in integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/implementing-recaptcha-in-integrations)

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/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/recaptcha/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Integration Guides

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha)

reCAPTCHA

reCAPTCHA is a tool used to determine if a given action is performed by a real user or malicious automation. Therefore, it is particularly helpful in preventing ecommerce fraud.

This guide shows you how to implement this feature in checkout integrations. To learn more about this type of validation in VTEX stores, see this [article on reCAPTCHA](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP) on our help center.

> VTEX is integrated with reCAPTCHA enterprise, which offers two validation approaches: checkbox (equivalent to reCAPTCHA v2) and score-based (equivalent to reCATPCHA v3). See this article on [reCAPTCHA at VTEX Checkout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/recaptcha-no-checkout--18Te3oDd7f4qcjKu9jhNzP%23recaptcha-versions) to learn what version you should use depending on your storefront characteristics. You can also learn more each method: [reCAPTCHA v2](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/display) or [reCAPTCHA v3](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/v3) with the documentation provided by Google.

To configure reCAPTCHA verification, follow the steps below:

1. Make a `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm).
2. Make a `POST` request using the endpoint [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) with the same data obtained in the GET request, just modifying the `recaptchaValidation` parameter to one of the following values:
   * `"never"`: no purchases are validated with reCAPTCHA.
   * `"always"`: all purchases are validated with reCAPTCHA. This is the recommended option if you are using score-based validation (equivalent to reCATPCHA v3).
   * `"vtexCriteria"`: only some purchases are validated with reCAPTCHA in order to minimize friction and improve the shopping experience. VTEX’s algorithm determines which sessions are trustworthy and which should be validated with reCAPTCHA. This is the recommended option if you are using checkbox validation (equivalent to reCAPTCHA v2).
3. Make a new `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm) to confirm activation.

This configuration is valid for the entire account. It is not possible to activate reCAPTCHA for a limited number of [bindings](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/o-que-e-binding--4NcN3NJd0IeYccgWCI8O2W%23).

> If you activate reCAPTCHA for your account, it is important to note that any integrations that deal with placing orders should be able to handle the validation. If reCAPTCHA is required for a given order, it can not be placed without validation. However, if your store uses VTEX’s native UI, it is already capable of handling reCAPTCHA. ⚠ If you are implementing a headless checkout experience in your store or even carrying out order creation tests via API, reCAPTCHA in active mode can block order completion requesting the reCAPTCHA validation key that is not possible to generate only via API, its only possible to generate displaying the reCAPTCHA widget.

Learn more about the [applicable cases](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/applicable-cases) and [how to implement reCAPTCHA for Checkout integrations](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/implementing-recaptcha-in-integrations).

## reCAPTCHA score

Score-based reCAPTCHA returns a score for the user interaction at your store. Possible values are `0.1`, `0.3`, `0.7` and `0.9`, where `1.0` is is very likely a good interaction and `0.0` is very likely a bot. Learn more about [how to interpret this score](https://read.calvincode.net/reader?url=https://developers.google.com/recaptcha/docs/v3?%23interpreting%5Fthe%5Fscore).

If you are implementing score-based reCAPTCHA, you have the option to set a minimum score for each [key that you create](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-recaptcha-in-integrations%23getting-the-recaptcha-key-for-mobile-implementations) and set a minimum score for your account.

The priority order of score application for any given purchase is:

`1

reCAPTCHA key score > Account score > VTEX default score (0.7)

`

This means that if you set minimum scores for both your key and account, the minimum score of the key will be applied. On the other hand, if you set neither, VTEX will apply the default value of `0.7`.

Interactions that return a value lower than the minimum value applicable will not be able to place orders.

### Setting an account minimum score

To set a minimum score for your account, follow the steps below:

1. Make a `GET` request using the endpoint [Get orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pvt/configuration/orderForm).
2. Make a `POST` request using the endpoint [Update orderForm configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23post-/api/checkout/pvt/configuration/orderForm) with the same data obtained in the GET request, just adding or modifying the value of the field `recaptchaMinScore`, which is a decimal number.

Contributors

2

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

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

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/recaptcha.md)

[Pricing Hub« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha//docs/guides/pricing-hub)[Applicable casesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha//docs/guides/applicable-cases)

Contributors

2

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

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

ON THIS PAGE

[reCAPTCHA score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha%23recaptcha-score)

[Setting an account minimum score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha%23setting-an-account-minimum-score)

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/recaptcha.md)

Copy page

On this page

ON THIS PAGE

[reCAPTCHA score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha%23recaptcha-score)

[Setting an account minimum score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/recaptcha/docs/guides/recaptcha%23setting-an-account-minimum-score)

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] Explain the VTEX api reference organization units api API and how to use it.

[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/api-reference/organization-units-api/docs/guides)

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

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

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/storefront-development)

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

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/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/api-reference/organization-units-api/updates/release-notes)

API Reference

Filter By

Post

Get

Put

Delete

Patch

[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/antifraud-provider-protocol/)

---

[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/audience-api/)

---

[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/buyer-organizations/)

---

[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/budgets-api/)

---

[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/legacy-cms-portal-api/)

---

[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/card-token-vault-api/)

---

[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/catalog-api-seller-portal/)

---

[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/catalog-api/)

---

[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/checkout-api/)

---

[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/customer-credit-api/)

---

[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/delivery-promise-notification-api/)

---

[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/giftcard-api/)

---

[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/giftcard-provider-protocol/)

---

[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/giftcard-hub-api/)

---

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/headless-cms-api/)

---

[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/intelligent-search-api/)

---

[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/intelligent-search-events-api-headless/)

---

[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/license-manager-api/)

---

[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/logistics-api/)

---

[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/marketplace-apis/)

---

[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/marketplace-protocol/)

---

[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/master-data-api-v2/)

---

[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/masterdata-api/)

---

[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/message-center-api/)

---

[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/mtls-api/)

---

[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/operational-capacity-api/)

---

[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/orders-api/)

---

[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/organization-units-api/)

Users

Organization Units

Scopes

---

[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/payment-provider-protocol/)

---

[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/payments-gateway-api/)

---

[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pick-and-pack-api/)

---

[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pick-and-pack-protocol-api/)

---

[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pick-and-pack-order-changes-api/)

---

[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/policies-system-api/)

---

[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pricing-api/)

---

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pricing-hub/)

---

[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/promotions-and-taxes-api/)

---

[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/promotions-and-taxes-api-v2/)

---

[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/punchout-api/)

---

[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/reviews-and-ratings-api/)

---

[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/recommendations-bff-api/)

---

[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/sku-bindings-api/)

---

[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/search-api/)

---

[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/session-manager-api/)

---

[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/ssl-certificates-api/)

---

[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/storefront-permissions-api/)

---

[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/subscriptions-api-v3/)

---

[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/vtex-ads-api/)

---

[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/vtex-shipping-network-api/)

---

[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/tracking/)

---

[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/vtex-do-api/)

---

[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/vtex-id-api/)

---

[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/profile-system/)

---

[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/orders-api-pii-version/)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/guides)

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

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/updates/release-notes)

API Reference

Filter By

Post

Get

Put

Delete

Patch

[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/antifraud-provider-protocol/)

---

[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/audience-api/)

---

[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/buyer-organizations/)

---

[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/budgets-api/)

---

[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/legacy-cms-portal-api/)

---

[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/card-token-vault-api/)

---

[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/catalog-api-seller-portal/)

---

[Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/catalog-api/)

---

[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/checkout-api/)

---

[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/customer-credit-api/)

---

[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/delivery-promise-notification-api/)

---

[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/giftcard-api/)

---

[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/giftcard-provider-protocol/)

---

[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/giftcard-hub-api/)

---

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/headless-cms-api/)

---

[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/intelligent-search-api/)

---

[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/intelligent-search-events-api-headless/)

---

[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/license-manager-api/)

---

[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/logistics-api/)

---

[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/marketplace-apis/)

---

[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/marketplace-protocol/)

---

[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/master-data-api-v2/)

---

[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/masterdata-api/)

---

[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/message-center-api/)

---

[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/mtls-api/)

---

[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/operational-capacity-api/)

---

[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/orders-api/)

---

[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/organization-units-api/)

Users

Organization Units

Scopes

---

[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/payment-provider-protocol/)

---

[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/payments-gateway-api/)

---

[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pick-and-pack-api/)

---

[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pick-and-pack-protocol-api/)

---

[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pick-and-pack-order-changes-api/)

---

[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/policies-system-api/)

---

[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pricing-api/)

---

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/pricing-hub/)

---

[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/promotions-and-taxes-api/)

---

[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/promotions-and-taxes-api-v2/)

---

[Punchout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/punchout-api/)

---

[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/reviews-and-ratings-api/)

---

[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/recommendations-bff-api/)

---

[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/sku-bindings-api/)

---

[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/search-api/)

---

[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/session-manager-api/)

---

[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/ssl-certificates-api/)

---

[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/storefront-permissions-api/)

---

[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/subscriptions-api-v3/)

---

[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/vtex-ads-api/)

---

[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/vtex-shipping-network-api/)

---

[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/tracking/)

---

[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/vtex-do-api/)

---

[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/vtex-id-api/)

---

[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/profile-system/)

---

[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/orders-api-pii-version/)

---

[PoAdd Log in Orders« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/interactions)[GeGet user scopesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/organization-units-api/docs/api-reference/organization-units-api%23get-/api/organization-units/v1/users/-userId-/scopes)

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