[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 vtex io documentation best practices for rendering images 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/vtex-io-documentation-best-practices-for-rendering-images/docs/guides)

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

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

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-managing-performance)

[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)

[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-debugging-performance-issues)

[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)

[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-enabling-order-form-optimization)

[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)

[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-enabling-performance-settings)

[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)

[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-using-the-fold-blocks)

[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-optimizing-image-rendering)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-setting-up-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-managing-performance)

[Deactivating the VTEX IO native service worker](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-deactivating-the-vtex-io-native-service-worker)

[Debugging performance issues](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-debugging-performance-issues)

[Displaying asynchronous prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-displaying-asynchronous-prices)

[Enabling the Order Form optimization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-enabling-order-form-optimization)

[Getting started with Lighthouse performance audit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-getting-started-with-lighthouse)

[Enabling performance settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-enabling-performance-settings)

[Tracking changes in Lighthouse performance score](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-tracking-changes-in-lighthouse-performance-score)

[Lazy loading components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-using-the-fold-blocks)

[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-optimizing-image-rendering)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/storefront-best-practices)

---

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/storefront-development)

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/store-framework-managing-performance)

[Optimizing image rendering](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-optimizing-image-rendering)

Optimizing image rendering

Learn how to optimize image rendering for faster load times.

This guide outlines best practices for using images in your [Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-store-theme) to maintain consistency and performance.

Images are crucial for creating a strong brand identity, but if not managed properly, they may slow down your store. To address this, Store Framework offers several image blocks tailored for different purposes, minimizing performance loss and allowing you to display images effectively. Additionally, there are best practices to follow when uploading images in your Store Theme.

This guide presents the following sections:

* [List of image blocks](#list-of-image-blocks): Presents the VTEX native components available in Store Framework that you can use to optimize image rendering on your store.
* [Best practices for uploading images](#best-practices-for-uploading-images): Describes best practices to maintain performance and visual consistency when updating images.

## List of image blocks

Store Framework offers several image blocks for different use cases. Selecting the right block helps to maintain performance and visual consistency.

* [**Logo**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/logo): Renders your brand logo, typically in the header or footer.
* [**Infocard**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/infocard): Renders images with links and call-to-action (CTA) buttons when you want to guide users with image-based CTAs.
* [**Rich Text**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.rich-text): Renders markdown text when you need to combine text and images in a single block.
* [**Product Summary Image**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryimage): Renders the product image attached to the product summary information, such as the product name and price. It's commonly used within other store components, like the [Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shelf), to display products with their key details.
When using the Product Summary block, configure at least one of the following props:
   * `aspectRatio`
   * `width`
   * `height`
   * `maxHeight`
These props define image dimensions, ensuring that product summary images are displayed at a consistent size, even if the images uploaded in the catalog have different dimensions. By declaring these props, your store shelf will replicate image consistency across all products being displayed, differently from the shelf example below:
![{"base64":"  ","img":{"width":2192,"height":1016,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":712774,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-best-practices-for-rendering-images-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-io-documentation-best-practices-for-rendering-images-0.png)
> You don't need to define all four properties in your Product Summary Image block at the same time. Each property has a unique purpose and can be configured based on your needs.
* [**Image**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-components/image): Renders standalone images without additional elements such as links or text, for when you just need to display an image.

## Best practices for uploading images

Follow these guidelines to upload images efficiently and avoid performance issues:

* To upload images, use the [Assets Builder](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-assets-builder) or [Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-working-with-site-editor). These tools handle cropping automatically, ensuring a consistent user experience across your store.
* Avoid hardcoding image URLs in the `blocks.json` file, as this can lead to image deformation.
* Don't use images with large dimensions, as they may not crop correctly in Site Editor, leading to display issues.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

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/vtex-io/Perks/best-practices/vtex-io-documentation-optimizing-image-rendering.md)

[Lazy loading components« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images//docs/guides/vtex-io-documentation-using-the-fold-blocks)[Improving store accessibility with semantic HTML migrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images//docs/guides/vtex-io-documentation-semantic-html-migration)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F112641072%3Fv%3D4%26w=64%26q=75)](https://github.com/barbara-celi)

ON THIS PAGE

[List of image blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-optimizing-image-rendering%23list-of-image-blocks)

[Best practices for uploading images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-optimizing-image-rendering%23best-practices-for-uploading-images)

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/vtex-io/Perks/best-practices/vtex-io-documentation-optimizing-image-rendering.md)

Copy page

On this page

ON THIS PAGE

[List of image blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-optimizing-image-rendering%23list-of-image-blocks)

[Best practices for uploading images](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-best-practices-for-rendering-images/docs/guides/vtex-io-documentation-optimizing-image-rendering%23best-practices-for-uploading-images)

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 hotjar 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.hotjar/docs/guides)

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

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

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.alexa-certify-code)

[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.audara)

[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.bluecore)

[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.blueknow)

[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.btg360)

[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.cookiebot)

[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.cookie-script)

[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.cybersource-fingerprint)

[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.elfsight)

[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.facebook-pixel)

[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.facebook-domain-verification)

[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.google-adwords)

[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.google-customer-reviews)

[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.hotjar)

[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.ideacrm)

[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.iubenda)

[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.jivochat)

[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.kelkoo)

[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.logrocket)

[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.lucky-orange)

[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.google-search-console)

[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.shareasale)

[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.smarthint)

[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.suite-share)

[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.tawk-to)

[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.trustpilot)

[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.zendesk-chat)

[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.zopim)

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

[Alexa Certify](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.alexa-certify-code)

[Audara](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.audara)

[Bluecore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.bluecore)

[Blueknow app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.blueknow)

[BTG360](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.btg360)

[Cookiebot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.cookiebot)

[Cookie Script](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.cookie-script)

[CyberSource Fingerprint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.cybersource-fingerprint)

[Elfsight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.elfsight)

[Facebook pixel](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.facebook-pixel)

[Facebook Domain Verification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.facebook-domain-verification)

[Google Adwords](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.google-adwords)

[Google Customer Reviews](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.google-customer-reviews)

[Hotjar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.hotjar)

[Idea CRM](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.ideacrm)

[Iubenda](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.iubenda)

[JivoChat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.jivochat)

[Kelkoo app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.kelkoo)

[LogRocket](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.logrocket)

[Lucky Orange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.lucky-orange)

[Search Console](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.google-search-console)

[Shareasale](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.shareasale)

[smarthint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.smarthint)

[Suiteshare](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.suite-share)

[Tawk.to](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.tawk-to)

[Trustpilot](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.trustpilot)

[Zendesk Chat](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.zendesk-chat)

[Zopim](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.zopim)

---

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

---

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

---

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

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

Hotjar

Official extension

Version: 0.1.6

Latest version: 0.1.6

Open the VTEX APP Store and install the app on your store.

or

Run the following command:

`1

vtex install vtex.hotjar@0.x

`

Next, open the app settings on your admin and fill the form with Site ID.

### Setup in Cart and Checkout page

Open your admin in the Checkout section in the `checkout6-custom.js`:

<https://ACCOUNT.myvtex.com/admin/portal/#/sites/default/code/files/checkout6-custom.js>

Add the following snippet in the file and replace `"YOURSITEID"` with your Site ID:

`1

// Hotjar

2

(function(h,o,t,j,a,r){

3

 var siteId = 'YOURSITEID';

4

 h.hj=h.hj||function(){(h.hj.q=h.hj.q||[]).push(arguments)};

5

 h._hjSettings={hjid:siteId,hjsv:6};

6

 a=o.getElementsByTagName('head')[0];

7

 r=o.createElement('script');r.async=1;

8

 r.src=t+h._hjSettings.hjid+j+h._hjSettings.hjsv;

9

 a.appendChild(r);

10

})(window,document,'https://static.hotjar.com/c/hotjar-','.js?sv=');

`

Click Save.

[Google Customer Reviews« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.google-customer-reviews)[Idea CRMNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.ideacrm)

See also

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

ON THIS PAGE

[Setup in Cart and Checkout page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.hotjar/docs/apps/vtex.hotjar%23setup-in-cart-and-checkout-page)

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 vtex store header 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/vtex-store-header/docs/guides)

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

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

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

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

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

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

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

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

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

---

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

Header

The Header app is responsible for displaying a **navigation bar** fixed on a store's page upper side. Other blocks that are important for user navigation are found in the Header, for example the store's [logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo), the [minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/), user [login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-login/) and [search bar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-searchbar).

![{"base64":"  ","img":{"width":2854,"height":1578,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":1340793,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-header-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-header-0.png)

## Configuration

1. Add the `store-header` app to your theme's dependencies in `manifest.json`:

`1

 dependencies: {

2

 "vtex.store-header": "2.x"

3

 }

`

Now, you are able to use all blocks exported by the `store-header` app. Check out the full list below:

| Block name            | Description                                                                                |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| header-layout.desktop | An error occurred while loading the image https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-header-1.png Defines the Header layout for desktop device through header-row blocks. |
| header-layout.mobile  | Defines the Header layout for mobile device through header-row blocks.                                                                                |
| header-row            | An error occurred while loading the image https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-header-2.png Create Header lines according to your store needs.                      |
| header-border         | Adds a 1px margin to a Header row.                                                                                |
| header-force-center   | Centralizes its children blocks in a Header row.                                                                                |
| header-spacer         | Adds spacing between blocks throughout a Header row.                                                                                |

1. Declare the two `header-layout` blocks, allowing you to define how the Header should be displayed for both mobile and desktop:

`1

{

2

 "header": {

3

 "blocks": [

4

 "header-layout.desktop",

5

 "header-layout.mobile"

6

 ]

7

 },

`

> _The Header does not need to be declared in a specific template of your theme, once the app is defined as default store interface element in the `interfaces.json` file. This means that Store Framework will reproduce the configurations defined in the file you just created for all store templates behind the scenes. If you want to apply different configurations to each store template, check the **advanced configurations** section below._

1. Configure both `header-layout.desktop` and `header-layout.mobile`, declaring `header-row` to create Header lines according to your store needs.

`1

{

2

 "header": {

3

 "blocks": [

4

 "header-layout.desktop",

5

 "header-layout.mobile"

6

 ]

7

 },

8

 "header-layout.desktop": {

9

 "children": [

10

 "header-row#1-desktop",

11

 "header-row#2-desktop",

12

 "header-row#3-desktop",

13

 "header-row#4-desktop"

14

 ]

15

 },

`

> _In the example above, we configured 4 different levels for `header-layout.desktop`. It will thus be possible to replicate the Header displayed above sheltering the telemarketing functionalities (when activated), a notification, links to pages and every other blocks, such as Logo, Menu, etc. **Remember that the number of `header-row`s should meet your business needs**, determining how many Header lines you want to apply to your store._

1. Configure each of the `header-row`s , applying props and declaring the desired store blocks for each line. To correctly structure your Header, you should check the [app documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/vtex-io-apps) for each of the desired blocks. The most commonly used are [Logo](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-logo), [Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-minicart/) and [Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-menu/). In the example below, we will configure the `header-row#1-desktop` as [Telemarketing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-telemarketing/):

`1

"header-row#1-desktop": {

2

 "children": [

3

 "telemarketing"

4

 ],

5

 "props": {

6

 "fullWidth": true

7

 }

8

},

`

* `header-row` props:

| Prop name | Type    | Description                                                                                | Default value |
| --------- | ------- | ------------------------------------------------------------------------------------------------------------ | ------------- |
| zIndex    | Number  | CSS property that controls the vertical stacking order of elements for overlapping.                          | 0             |
| sticky    | Boolean | Whether the Header margin should be fixed on the layout (true) or not (false)                                | false         |
| fullWidth | Boolean | Whether the Header should take the full width of the screen or not                                           | true          |
| inverted  | Boolean | Whether the row will use the base color (false) or the inverted base color (true) as defined in styles.json. | false         |

> _**Repeat step 4 for any other `header-rows` you may have in the `header-layout.desktop`**. Remember to declare the desired blocks for each row, as we declared the Telemarketing block for the `header-row#1-desktop`, and properly configure all blocks using props. Once it is all finished, **redo steps 3 and 4 to define your `header-layout.mobile` as well**_.

Three blocks can be added as `header-row`'s children in order to customize your Header row layout: `header-border`, `header-force-center` and `header-spacer`.

* **`header-border`**:

When declared, the `header-border` block adds a `1px` margin to your store's Header.

`1

"header-row#2-desktop": {

2

 "children": [

3

 "header-border",

4

 "notification.bar#home"

5

 ],

6

 "props": {

7

 "fullWidth": "true"

8

 }

9

},

10

"notification.bar#home": {

11

 "props": {

12

 "content": "SELECTED ITEMS ON SALE! CHECK IT OUT!"

13

 }

14

},

`

| Prop name | Type    | Description                                                    | Default value |
| --------- | ------- | -------------------------------------------------------------- | ------------- |
| sticky    | Boolean | Whether the Header margin should be fixed in the layout or not | false         |

* **`header-force-center`**

When passed on, the `header-force-center` centralizes its children blocks in a Header row, for example:

`1

"header-row#4-desktop": {

2

 "props": {

3

 "blockClass": "main-header",

4

 "horizontalAlign": "center",

5

 "verticalAlign": "center",

6

 "preventHorizontalStretch": true,

7

 "preventVerticalStretch": true,

8

 "fullWidth": true

9

 },

10

 "children": ["header-force-center"]

11

},

12

"header-force-center": {

13

 "children":[

14

 "logo#desktop"

15

 ]

16

},

17

"logo#desktop": {

18

 "props": {

19

 "title": "Logo",

20

 "href": "/",

21

 "url": "https://storecomponents.vteximg.com.br/arquivos/store-theme-logo.png",

22

 "width": "180"

23

 }

24

},

`

![{"base64":"  ","img":{"width":2850,"height":1576,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":1413481,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-header-3.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-header-3.png)

* **`header-spacer`**:

The `header-spacer` is tasked with adding spacing between blocks throughout the Header rows. For example:

`1

"header-row#3-desktop": {

2

 "children": [

3

 "vtex.menu@2.x:menu#websites",

4

 "header-spacer",

5

 "vtex.menu@2.x:menu#institutional"

6

 ],

7

 "props": {

8

 "blockClass": "menu-link",

9

 "inverted": "true"

10

 }

11

},

`

In practice, it will make all blocks declared before it position themselves to the left on the screen, whereas blocks that are declared after will be positioned to the right. Considering that the Menus were properly declared and configured in the theme code, we would have the following:

![{"base64":"  ","img":{"width":2854,"height":1578,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":1341286,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-header-4.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-store-header-4.png)

### Advanced configuration

Automatic behind the scenes Header reproduction in every store template is only possible because it is defined as default store interface elements in the `interfaces.json` file from Store Theme.

This definition in `interfaces.json` enables Store Framework to identify the Header block declared just once in a `blocks.jsonc` file and reproduce it as default for all other templates.

To overwrite this automatic duplication in `interfaces.json` and use new configurations in different templates, refer to the step-by-step of the following recipe: [Customizing the Header and Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-customizing-the-header-and-footer-blocks-by-page).

## Customization

In order to apply CSS customizations in these and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).

| CSS Handles               |
| ------------------------- |
| container                 |
| leanMode                  |
| topMenuContainer          |
| topMenuLogo               |
| topMenuSearchBar          |
| topMenuIcons              |
| topMenuCollapsible        |
| forceCenter               |
| forceCenterInnerContainer |
| headerBorder              |
| headerSpacer              |
| headerStickyRow           |
| headerRowContentContainer |

Contributors

1

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Store-Framework-Apps/basic-components/vtex-store-header.md)

Contributors

1

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

ON THIS PAGE

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

[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-header/docs/guides/vtex-store-header%23advanced-configuration)

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

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/vtex-io/Store-Framework-Apps/basic-components/vtex-store-header.md)

Copy page

On this page

ON THIS PAGE

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

[Advanced configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-header/docs/guides/vtex-store-header%23advanced-configuration)

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

On this page

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


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

[User] Provide a guide on guides marketplace overview 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/marketplace-overview/docs/guides)

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

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

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

Guides

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

---

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

---

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

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

[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview)

[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/orders-overview)

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

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

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/fulfillment)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/search-overview)

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

[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/promotions-overview)

[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/subscriptions)

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

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

[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview)

[Orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/orders-overview)

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

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

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/fulfillment)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/search-overview)

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

[Promotions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/promotions-overview)

[Subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/subscriptions)

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

[Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview)

Marketplace

Integration guide for VTEX or external Marketplaces and Sellers

> Help us improve our documentation! Tell us about your experience with this article by filling out [this form](https://read.calvincode.net/reader?url=https://forms.gle/fQoELRA1yfKDqmAb8).

We define marketplace as the environment where sellers expose their products and also where consumers make purchases and pay for an order. Sellers in turn are commonly the owners of the products and responsible for delivering the products to shoppers. Because VTEX promotes digital collaboration in different settings, in addition to selling their products in other marketplaces, sellers can become marketplaces themselves. Learn more about partners and growth opportunities in [Marketplace Strategies at VTEX](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/estrategias-de-marketplace-na-vtex--tutorials%5F402).

## Understanding the marketplace architecture

The architecture of a VTEX store allows merchants to become marketplaces or sellers in other VTEX stores without the need for any additional development, that is, every VTEX store is a seller in its own marketplace environment and can also be a seller in other environments like VTEX marketplaces (native marketplaces) or external (certified marketplaces or partners).

![{"base64":"  ","img":{"width":1000,"height":400,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":33173,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Getting-Started/quick-start-guide-marketplace-integracao-vtex-vtex.jpg"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Getting-Started/quick-start-guide-marketplace-integracao-vtex-vtex.jpg)

* **VTEX Marketplace:** Store environment hosted on the VTEX platform responsible for product sales, checkout, and payment.
* **External Marketplace:** Showcase store hosted on platforms external to VTEX and responsible for product sales, checkout, and payment.
* **VTEX Seller**: Store hosted on the VTEX platform that owns the products and is usually responsible for fulfilling orders to the consumer.
* **External Seller:** Store hosted on another platform, or that is not yet hosted on any platform, which owns the products and is usually responsible for fulfilling orders to the consumer. A VTEX marketplace may be interested in integrating with this external store, in order to offer its products.

## Configuring VTEX Marketplace

To operate as a marketplace, it is necessary to configure your store according to the steps described in [Configuring VTEX Marketplace](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configuring-vtex-marketplace--7splyp5MqIyt2Iyz5jsNzb).

The actions that can be performed via API are the following:

* [Adding seller](#1-marketplace-adding-sellers)
* [Configuring seller selection at checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checkout-overview)
* [Configure storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/getting-started-3)
* [Configure payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-integration-guide)

## Integrating External Marketplaces or External Sellers

The Marketplace Protocol is a set of API requests and definitions to help you integrate external sellers into a VTEX marketplace, as well as external marketplaces into VTEX sellers.

* **External seller protocol:** If you are a VTEX marketplace and want to integrate offers from an external seller into your catalog, see our [External Seller Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide).
* **External marketplace protocol:** If you are an external marketplace that wants to integrate with a VTEX seller, see [External Marketplace Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide) to learn how to develop a custom connector to integrate with the architecture and catalog of VTEX sellers.

## 1\. Marketplace: Adding Sellers

VTEX marketplaces that want to make products from sellers available in their store must go over some processes. The first step is to find out if the seller you want to connect to is a VTEX seller or an external seller. For _external sellers_, verify the [External Seller Integration Guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-seller-integration-guide) and for _VTEX sellers_, follow the steps below.

### Marketplace: Adding a seller to the Seller Portal

The [Seller Portal](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/seller-portal-primeiros-passos-para-o-marketplace--6ccErY3mCcfoW0qGXf167) is an edition of the VTEX platform with essential functionalities available, so that external or VTEX sellers can quickly integrate into VTEX marketplaces.

> The Seller Portal has default version developed by VTEX and if the marketplace wants its own customized version, it can develop from the VTEX version following the [Seller Portal Edition App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/seller-portal-edition-app) guide.

To integrate a partner's products to your marketplace using the Seller Portal as a solution, there is a flow of actions to be performed by marketplace and seller, see the image below.

![{"base64":"  ","img":{"width":3751,"height":2501,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":143193,"url":"https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Getting-Started/quick-start-guide-marketplace-seller-portal-steps.png"}}](https://read.calvincode.net/reader?url=https://raw.githubusercontent.com/vtexdocs/dev-portal-content/main/docs/guides/Getting-Started/quick-start-guide-marketplace-seller-portal-steps.png)

The marketplace is responsible for onboarding new sellers. In other words, it is the role of the marketplace to support the seller's experience in the Seller Portal. For information about seller actions, see [Seller Portal: First Steps for the Seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/seller-portal-primeiros-passos--6w1vBdRH2uuBGmUqgNQjwK).

To invite and activate sellers, the marketplace must follow the endpoints listed below in the order represented. For the action of approving offers, see the section [Cataloging offers](#3-marketplace-cataloging-offers).

1. POST - [Invite Seller Lead](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23post-/seller-register/pvt/seller-leads)
2. PUT - [Accept Seller Lead](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23put-/seller-register/pvt/seller-leads/-sellerLeadId-)
3. PUT - [Create Seller from Lead](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23put-/seller-register/pvt/seller-leads/-sellerLeadId-/seller)

In the same category of Seller invite, you will also find the endpoints:

* GET - [List Seller Leads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23get-/seller-register/pvt/seller-leads): Returns a list of all sellers that have been invited by the marketplace.
* GET - [Get Seller Lead's Data by Id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23get-/seller-register/pvt/seller-leads/-sellerLeadId-): Marketplace gets a list of the sellers invited to its own environment.
* PUT - [Resend Seller Lead Invite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23put-/seller-register/pvt/seller-leads/-sellerLeadId-/status): Marketplace resends the invitation to the desired seller.
* DELETE - [Delete Seller Lead](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23delete-/seller-register/pvt/seller-leads/-sellerLeadId-): Allows the marketplace to delete a seller previously invited to its environment, if the seller has not yet accepted the invitation.

### Sellers: Configuring your Seller Portal environment

To learn how to configure your brand new Seller Portal environment and other seller actions, see [Seller Portal: First Steps for the Seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-set-up-your-store-on-seller-portal--6w1vBdRH2uuBGmUqgNQjwK). To integrate with your ERP, check out our [ERP integration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/erp-integration-guide).

Catalog integration must be done manually through the Seller Portal interface or massively through REST API, using [Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api-seller-portal). It is not possible to integrate Catalog via spreadsheet nor via SOAP API (Webservice).

### Marketplace: Adding and configuring a seller's account to VTEX Commerce

To add and configure a registered seller account and update accounts that are not hosted on the Seller Portal, the marketplace will use the following endpoints.

* POST - [Configure Seller Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23post-/seller-register/pvt/sellers): Configure a specific seller's account, ultimately adding a seller to a marketplace's environment.
* PATCH - [Update Seller by Seller ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23patch-/seller-register/pvt/sellers/-sellerId-): for when the marketplace needs to make updates to the settings of a specific seller.
* PUT - [Upsert Sales Channel Mapping](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23put-/seller-register/pvt/sellers/-sellerId-/sales-channel/mapping): when the seller has two affiliates pointing to the same marketplace, the account settings will be done through this endpoint.

After configuring the account, the marketplace will be able to verify the settings made.

* GET - [List Sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23get-/seller-register/pvt/sellers): Retrieve a list of sellers registered in the marketplace, and this list can be filtered by the configured [trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV).
* GET - [Get Seller data by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23get-/seller-register/pvt/sellers/-sellerId-): Retrieve information on a specific seller, it is also possible to filter by trade policy.
* GET - [Get Sales Channel Mapping Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23get-/seller-register/pvt/sellers/-sellerId-/sales-channel/mapping): Retrieve information about mapping between your sales channels and a specific seller.

### Configuring seller's commission

The marketplace will configure the seller's commissions after the initial configurations. To perform this action, one of the following endpoints can be used.

* PUT - [Upsert Seller Commissions in Bulk](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23put-/seller-register/pvt/sellers/-sellerId-/commissions/categories): To apply the same commission rule to all categories of a seller already registered in the marketplace.
* PUT - [Upsert Seller Commissions by Category ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23put-/seller-register/pvt/sellers/-sellerId-/commissions/-categoryId-): To apply a commission rule to only one category of the respective seller.

The query and management of applied commission rules will be performed through the following endpoints.

* GET - [List Seller Commissions by seller ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23get-/seller-register/pvt/sellers/-sellerId-/commissions): Retrieve the list of commissions defined for a seller.
* GET- [Get Seller Commissions by Category ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23get-/seller-register/pvt/sellers/-sellerId-/commissions/-categoryId-): Retrieve the commission list defined for a specific category of a specific seller.
* DELETE - [Remove Seller Commission by Category ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23delete-/seller-register/pvt/sellers/-sellerId-/commissions/-categoryId-): Removes a previously defined commission for a category of a seller.

When completing the steps listed above, the marketplace will have completed the integration of a seller into its store.

## 2\. Sending and managing suggestions

When the seller is integrated into a marketplace, it will begin to suggest products from its catalog to the marketplace. The APIs mentioned in this section refer to the [Received SKUs](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/manual-sku-cataloging--tutorials%5F396) page of VTEX Admin.

### Sellers: Sending Suggestions

When the seller wants to suggest that one of their SKUs be sold on the marketplace, we say that the seller is sending a suggestion.
Before sending suggestions, the seller can check if the SKU already exists in the marketplace. If it does not exist, the **Get SKU bindings by SKU ID** call should be made after sending the suggestion to notify the marketplace that the SKU in question is a new suggestion.

* GET - [Get SKU Bindings by SKU ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/sku-bindings-api%23get-/catalog/pvt/skusellers/-skuId-)
* PUT - [Send SKU Suggestion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23put-/suggestions/-sellerId-/-sellerSkuId-)

### Marketplace: Deleting Suggestions

If the marketplace wants to remove a submitted suggestion, they should use this call to delete the suggestion of a specific SKU.

* DELETE - [Delete SKU Suggestion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23delete-/suggestions/-sellerId-/-sellerSkuId-)

## 3\. Marketplace: Cataloging offers

When the seller sends a product suggestion to the marketplace with configured price and inventory information, after approval by the marketplace, this suggestion becomes an offer. However, before approving a seller's suggestion, it is important to ensure that the product information sent corresponds to the business strategy of the marketplace. When cataloging offers, consider the quality of information sent by the seller, such as price, product description and image.

Cataloging can be performed [manually](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/manual-sku-cataloging--tutorials%5F396) or automatically by [VTEX Matcher](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/understanding-vtex-matcher-scoring--tutorials%5F424) and/or by external matchers. VTEX Matcher is a default tool used by marketplaces to analyze offers submitted by sellers and accelerate their cataloging process.

### Matching

When matching received suggestions, the marketplace can perform this action either in bulk or individually.

* PUT - [Match Received SKUs individually](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23put-/suggestions/-sellerId-/-sellerskuid-/versions/-version-/matches/-matchid-)
* PUT - [Match Multiple Received SKUs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23put-/suggestions/matches/action/-actionName-)

### autoApprove

Received SKUs will be approved automatically, regardless of their [Matcher score](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/entendendo-a-pontuacao-do-vtex-matcher--tutorials%5F424), if the autoApprove feature is activated.

* PUT - [Activate autoApprove in the Marketplace's Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions/%23put-/suggestions/configuration/autoapproval/toggle): Will be used by the marketplace to activate the autoApprove feature with the default parameters for all received SKU modules, so that all sent SKUs are automatically approved.
* GET - [Get Account's Approval Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23get-/suggestions/configuration): After activating the autoApprove feature, the marketplace can use this endpoint to check the current settings of automatic approval acting in its store.
* PUT - [Save Account's Approval Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23put-/suggestions/configuration): Updates the VTEX Matcher's approval parameters in the [Received SKU page](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/manual-sku-cataloging--tutorials%5F396).
* GET - [Get autoApprove Status in Account Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23get-/suggestions/configuration/autoapproval/toggle): Checks the autoApprove's status for a specific seller.
* PUT - [Activate autoApprove Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23put-/suggestions/configuration/autoapproval/toggle/seller/-sellerId-): The marketplace will use this to activate the autoApprove with the default parameters for a specific seller identified by sellerId.
* GET - [Get Seller's Approval Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23get-/suggestions/configuration/seller/-sellerId-): Checks the current automatic approval configuration for a specific seller identified by sellerId.
* PUT - [Save Seller's Approval Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23put-/suggestions/configuration/seller/-sellerId-): Updates the matcher's approval parameters for a specific seller identified by `sellerId`.

## 4\. Managing Catalog

There are several actions that a marketplace or a VTEX seller can perform in catalog management. In the following sections, you will find the main actions for a marketplace and a seller.

### For Marketplaces

The following endpoints will be used by the marketplace to query information about sellers in a store.

**Suggestions**

* GET - [Get all SKU Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions%23get-/suggestions): Retrieves information about all suggestions sent by a seller.
* GET - [Get SKU Suggestion by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions/%23get-/suggestions/-sellerId-/-sellerSkuId-): Retrieves the matcher status and score information of a specific suggestion.

**Versions**

* GET - [Get all Versions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions/%23get-/suggestions/-sellerId-/-sellerskuid-/versions): Retrieves information about the versions of a suggestion sent by the seller.
* GET - [Get Version by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis-suggestions/%23get-/suggestions/-sellerId-/-sellerskuid-/versions/-version-): Retrieves information about a specific version of the suggestion.
* GET - [Get Matched Offers List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23get-/offer-manager/pvt/offers): Retrieves the available offers in the marketplace.
* GET - [Get Matched Offer's Data by SKU ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23get-/offer-manager/pvt/product/-productId-/sku/-skuId-): Retrieves the list of offers available for a specific SKU ID in the marketplace catalog.
* GET - [Get Matched Offer's Data by Product ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23get-/offer-manager/pvt/product/-productId-): Retrieves a list of all offers available for a specific product ID in the marketplace catalog.

### For Sellers

The endpoints presented will be used by sellers already connected to a marketplace to notify external marketplaces or VTEX whenever there is a price or inventory update to their SKUs.

* POST - [Notify Marketplace of Price Update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23post-/notificator/-sellerId-/changenotification/-skuId-/price)
* POST - [Notify Marketplace of Inventory Update](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis/%23post-/notificator/-sellerId-/changenotification/-skuId-/inventory)

## 5\. Sellers: Offer Management

[Offer Management](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/offer-management--7MRb9S78aBdZjFGpbuffpE) is the VTEX feature that provides sellers with more visibility into the process of sending a product to external channels, such as marketplaces. Offer Management helps sellers identify updates and resolve errors in their offers during the sending process, ensuring that they can be sent to the marketplace and synchronized correctly.

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

Contributors

1

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

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/Getting-Started/marketplace-overview.md)

[Catalog« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview//docs/guides/catalog-overview)[OrdersNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview//docs/guides/orders-overview)

Contributors

1

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

ON THIS PAGE

[Understanding the marketplace architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23understanding-the-marketplace-architecture)

[Configuring VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23configuring-vtex-marketplace)

[Integrating External Marketplaces or External Sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23integrating-external-marketplaces-or-external-sellers)

[1\. Marketplace: Adding Sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%231-marketplace-adding-sellers)

[Marketplace: Adding a seller to the Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23marketplace-adding-a-seller-to-the-seller-portal)[Sellers: Configuring your Seller Portal environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23sellers-configuring-your-seller-portal-environment)[Marketplace: Adding and configuring a seller's account to VTEX Commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23marketplace-adding-and-configuring-a-sellers-account-to-vtex-commerce)[Configuring seller's commission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23configuring-sellers-commission)

[2\. Sending and managing suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%232-sending-and-managing-suggestions)

[Sellers: Sending Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23sellers-sending-suggestions)[Marketplace: Deleting Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23marketplace-deleting-suggestions)

[3\. Marketplace: Cataloging offers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%233-marketplace-cataloging-offers)

[Matching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23matching)[autoApprove](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23autoapprove)

[4\. Managing Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%234-managing-catalog)

[For Marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23for-marketplaces)[For Sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23for-sellers)

[5\. Sellers: Offer Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%235-sellers-offer-management)

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/Getting-Started/marketplace-overview.md)

Copy page

On this page

ON THIS PAGE

[Understanding the marketplace architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23understanding-the-marketplace-architecture)

[Configuring VTEX Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23configuring-vtex-marketplace)

[Integrating External Marketplaces or External Sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23integrating-external-marketplaces-or-external-sellers)

[1\. Marketplace: Adding Sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%231-marketplace-adding-sellers)

[Marketplace: Adding a seller to the Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23marketplace-adding-a-seller-to-the-seller-portal)[Sellers: Configuring your Seller Portal environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23sellers-configuring-your-seller-portal-environment)[Marketplace: Adding and configuring a seller's account to VTEX Commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23marketplace-adding-and-configuring-a-sellers-account-to-vtex-commerce)[Configuring seller's commission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23configuring-sellers-commission)

[2\. Sending and managing suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%232-sending-and-managing-suggestions)

[Sellers: Sending Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23sellers-sending-suggestions)[Marketplace: Deleting Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23marketplace-deleting-suggestions)

[3\. Marketplace: Cataloging offers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%233-marketplace-cataloging-offers)

[Matching](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23matching)[autoApprove](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23autoapprove)

[4\. Managing Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%234-managing-catalog)

[For Marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23for-marketplaces)[For Sellers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%23for-sellers)

[5\. Sellers: Offer Management](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/marketplace-overview/docs/guides/marketplace-overview%235-sellers-offer-management)

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=)