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

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

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

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

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

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

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

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

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

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

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

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

---

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

FastStore API

FastStore API is an interface between your ecommerce platform and your store's frontend. It uses **[GraphQL](https://read.calvincode.net/reader?url=https://graphql.org/)**, a query language for APIs and a runtime for fulfilling queries, to deliver structured data from everyday ecommerce tasks to frontend components.

The FastStore API allows you to obtain all the information you need for a given page, and customize your query to get exactly the data you need. With the FastStore API, you can:

* Retrieve product information.
* Add items to the cart.
* Apply promotions to products.
* Filter search results.

Also, thanks to a type-safe GraphQL protocol, the FastStore API allows developers to retrieve only the strongly typed data needed for building robust and responsive solutions. In practice, developers can integrate the FastStore API with the [Next.js](https://read.calvincode.net/reader?url=https://nextjs.org/) data layers and consume it on frontend components to create stores.

Data Layer

Data Source

Source data

Source data

Source data

Query data

FastStore Core

CMS API
 Headless CMS

FastStore API
 Ecommerce Platform

Static Data
 YAML, JSON, CSV

React Components

> To learn more about GraphQL and its main concepts, visit the official [GraphQL website](https://read.calvincode.net/reader?url=https://graphql.org/).

## Going beyond

For advanced use cases, it is also possible to use the [API extension](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-overview) feature to enhance your GraphQL schema, accommodating custom data requirements and retrieving data not natively available. Following these best practices helps to maintain your site's performance at optimal levels.

* **[Extending API schemas](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-api-schema):** Extend VTEX and third-party APIs to customize how your store manages and processes data.
* **[Extending queries using fragments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-extending-queries-using-fragments):** Extend GraphQL queries using fragments in FastStore API extension to add custom fields to predefined queries.
* **[Consuming FastStore API extension with custom components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/api-extensions-consuming-api-extensions):** Consume FastStore API extension data with custom components, such as [Sections](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-creating-a-new-section) and [Override components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/building-sections-overriding-components-and-props%23override-native-components-props).

Contributors

1

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

Was this helpful?

Yes

No

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

[Implementing Live Shopping for FastStore previous versions« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/storefront-features-implementing-live-shopping-for-faststore-previous-versions)[QueriesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/schema-queries)

Contributors

1

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

ON THIS PAGE

[Going beyond](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/faststore-api-overview%23going-beyond)

Was this helpful?

 Send feedback

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

Copy page

On this page

ON THIS PAGE

[Going beyond](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview/docs/guides/faststore/faststore-api-overview%23going-beyond)

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 master data introduction 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/master-data-introduction/docs/guides)

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

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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-best-practices)

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

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

---

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/master-data-introduction/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-best-practices)

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

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

---

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/master-data-introduction/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

Master Data

Master Data is a native key-document database with a powerful search engine to enable users to store, search, expand and personalize their data. Master Data is a distributed database solution with low latency access, which enables the implementation of stores all around the world. To enable this level of access and other features, Master Data has some requirements on how it works, which are explained by some of the articles of this section.

## What you will find in this section?

The table below shows each subsection with a small description of their respective contents.

| Subsection                                            | Description                                              |
| ----------------------------------------------------- | -------------------------------------------------------- |
| [How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-how-it-works) | Fundamentals of Master Data.                             |
| [Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data-v2-guides)          | Master Data tutorials for different purposes.            |
| [Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/getting-started-1)     | Basic how-to guides to get you started with Master Data. |

Contributors

1

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data.md)

[Checkout error codes« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction//docs/guides/checkout-error-codes)[Understanding Master DataNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction//docs/guides/understanding-master-data)

Contributors

1

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

ON THIS PAGE

[What you will find in this section?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data%23what-you-will-find-in-this-section)

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/Master-Data/master-data.md)

Copy page

On this page

ON THIS PAGE

[What you will find in this section?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-introduction/docs/guides/master-data%23what-you-will-find-in-this-section)

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 vtex b2b organizations 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-b2b-organizations/docs/guides)

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

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

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

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

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

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

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

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

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

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

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

---

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

B2B Organizations

>  The **B2B Organizations** app is part of the VTEX [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-suite) solution: a collection of apps that allow stores to manage organizations, storefront roles and permissions, and checkout settings for B2B commerce relationships. We recommend using it alongside the other apps in this suite to ensure that all features work as expected.

In the B2B model, sales goals go beyond achieving a high conversion rate. They include simplifying the relationship between companies, reducing costs, and increasing performance by delivering the best possible shopping experience to customers.

B2B commerce relations are usually complex and often require a customized service. In this scenario, it is common to group various users from the same company under an organization and define custom payment methods, product selections, and prices for each customer. These tasks are part of the daily routine in B2B commerce.

The **B2B Organizations** app enables you to group B2B users into organizations. You can assign specific payment methods, price tables, and product collections to each organization, allowing all organization users to share the same commercial conditions. Additionally, each organization can be further segmented into one or more cost centers, each with its own shipping addresses.

## Before you begin

First, make sure you have the [VTEX IO CLI (Command Line Interface)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install) installed in your computer.

Please note that when you install the B2B Organizations app, the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions) will also be installed as a dependency app. This is because Storefront Permissions allows you to assign specific storefront roles to B2B users within an organization. This is particularly useful for organizations with multiple users who have different responsibilities, such as placing orders, approving orders, or managing organization users. Read the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions) app documentation to learn more about the available roles and how to customize their permissions.

If you want to manage roles and permissions in the VTEX Admin, you must install [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui) as well.

## Installation

You can install the **B2B Organizations** app by running the command `vtex install vtex.b2b-organizations` in your terminal, using [VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference).

## User widget configuration

To enable the [user widget](#user-widget) in your storefront, this app provides a `b2b-user-widget` block that you can add to the account store theme. We recommend adding it to the store header, as shown below.

![](https://user-images.githubusercontent.com/77292838/159766647-a8d22a55-61da-4169-a1be-1072a4ca8d73.png)

Follow the instructions below to display the user widget.

1. Open your store theme app repository in your local files.
2. In the `manifest.json` file, under `dependencies`, add `"vtex.b2b-organizations": "1.x"`:
`1
"dependencies": {
2
 "vtex.b2b-organizations": "1.x"
3
 },
`
3. Within your store's theme `store` \> `blocks` \> `header` folder, edit the `header.jsonc` file, placing the `b2b-user-widget` block in the desired location, as exemplified below.
We recommend placing it on the top row of the store header. Note that the `b2b-user-widget` block does not accept any props.
`1
"header-layout.desktop": {
2
 "children": [
3
 "flex-layout.row#0-desktop",
4
 "flex-layout.row#1-desktop",
5
 "flex-layout.row#2-desktop",
6
 "flex-layout.row#3-desktop",
7
 "sticky-layout#4-desktop"
8
 ]
9
 },
10

11
 "flex-layout.row#0-desktop": {
12
 "children": ["b2b-user-widget"],
13
 "props": {
14
 "fullWidth": true
15
 }
16
 },
`
4. Publish and install the modified store theme. Read our documentation on [Making your theme content public](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-making-your-theme-content-public) for more information.

## Configuration

This is the store header for only one associated organization: ![](https://i.imgur.com/5yXFU6y.png)

This is the store header for more than one associated organization:

![](https://i.imgur.com/ScQtfIz.png)

### `b2b-user-widget`

| Prop name    | Type    | Description                                                                                | Default value |
| ------------ | ------- | ----------------------------------------------------------------------------------------------------------------------- | ------------- |
| showDropdown | boolean | Controls whether the dropdown menu is displayed when multiple organizations are associated with the same email address. | true          |

## Customization

To apply CSS customizations to this and other apps, follow the instructions in [Using CSS handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-using-css-handles-for-store-customization).

CSS handles are available for the **Organization Request Form** component and the **User Widget** component.

| **CSS handles**                 |
| ------------------------------- |
| newOrganizationContainer        |
| newOrganizationInput            |
| newOrganizationAddressForm      |
| newOrganizationButtonsContainer |
| newOrganizationButtonSubmit     |
| userWidgetContainer             |
| userWidgetRow                   |
| userWidgetItem                  |
| userWidgetButton                |
| userWidgetImpersonationItem     |
| userWidgetImpersonationButton   |
| userWidgetImpersonationError    |

## How the app works

The **B2B Organizations** app adds the following functionalities and components to your VTEX store, which are divided into three categories: VTEX Admin, Master Data v2, and Storefront features.

| Public                                                     | Category                                                                                | Location                   | Feature                                                                                |
| ---------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | -------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
| B2B store admin                                            | [VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23vtex-admin)         | Organization Requests page | Reviews organization requests.                                                                                |
| Organizations page                                         | Manages organizations.                                                                          |                            |                                                                                |
| Organization Details page                                  | Manages cost centers associated with organizations.                                             |                            |                                                                                |
| Manages collections associated with organizations.         |                                                                                |                            |                                                                                |
| Manages payment terms associated with organizations.       |                                                                                |                            |                                                                                |
| Manages price tables associated with organizations.        |                                                                                |                            |                                                                                |
| Manages organization users.                                |                                                                                |                            |                                                                                |
| Message Center Templates page                              | Manages email templates for the B2B Organizations app.                                          |                            |                                                                                |
| B2B store admin or developers                              | [Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23master-data-v2) | Master Data API v2         | Retrieves and edits information related to organization requests, organizations, and cost centers stored in Master Data v2. |
| B2B customer (organization user) with required permissions | [Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations%23storefront)         | Storefront form            | Requests a new organization.                                                                                |
| My Organization                                            | Manages organizations.                                                                          |                            |                                                                                |
| Manages cost centers                                       |                                                                                |                            |                                                                                |
| Manages users.                                             |                                                                                |                            |                                                                                |
| Impersonates users.                                        |                                                                                |                            |                                                                                |
| Storefront navigation                                      | User widget                                                                                |                            |                                                                                |

> This app can also be used together with [B2B Quotes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-orderquote), allowing order quotes to be managed at the organization level. Please read our B2B Quotes documentation for more details.

### VTEX Admin

After installing and configuring the **B2B Organizations** app, you can find its VTEX Admin capabilities accessing **Account Settings > B2B Organizations & Cost Centers**.

#### Organization Requests

To request the creation of an organization, B2B customers must complete the [Request New Organization form](#request-new-organization).

Once the customer completes this step, B2B store admins can review the organization request by navigating to **VTEX Admin** \> **Account Settings** \> **B2B Organizations & Cost Centers** \> **Organization Requests** (or by accessing `/admin/b2b-organizations/requests`).

On this page, admins can view a list of all the organization requests placed in their store.

![02-organization-requests](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766650-d989a5bc-a33b-4fee-9e60-76f26567b067.png)

Each organization within the system can be assigned one of the following statuses: **pending**, **approved** or **declined**. Pending requests are the ones awaiting review.

To review a request, follow these steps:

1. Click a request from the table or click ![](https://user-images.githubusercontent.com/77292838/159766633-dfcb818f-6bd7-4cd0-92dc-9c682fb50d04.png) \> `View`.
2. Leave a comment in the **Add note** field, if necessary.
3. Click `Approve` or `Decline`.
![03-manage-organization-request](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766653-ba4f6d4b-4bda-4856-86a3-0080f8d22e1e.png)

Upon approval, the request status will change to **Approved**, and the organization will be created. Notifications will be sent via email to both the [Organization Admin and the Sales Admins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions%23available-storefront-roles) to inform them of the approval. You can learn more about this notification in the [Email templates](#email-templates) section. In addition, the user designated as the Organization Admin will be granted access to the [My Organization](#my-organization) tab on the **My Account** page of your storefront.

If the organization request is declined, the request status will be changed to **Declined**, and the organization will not be created. The user assigned as the Organization Admin will receive an email notification informing this outcome. For further information about this notification, please refer to the [Email templates](#email-templates) section.

#### Organizations

The **Organizations** page displays a list of all the organizations created in your store and their respective statuses. It also allows store admins to:

* [Add organizations](#add-organization).
* Access the [Organization details](#organization-details) page, which includes organization data, cost centers, collections, payment terms, price tables, and users.

To access the page, go to **Account Settings** \> **B2B Organizations & Cost Centers** \> **Organizations** in the VTEX Admin (or access `/admin/b2b-organizations/organizations`).

![04-organizations](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766661-63f7191a-51c4-49d7-a34d-d909456f2692.png)

You can click `Refetch` to refresh the organization list on this page and retrieve information about recently created organizations.

To find a specific organization, you can use the search bar to search by name or apply filters based on the organization status.

Each organization can have one of the following statuses:

* **Active**: The organization has been approved by the store admins and is currently active.
* **On hold**: The organization is currently paused, which means its users are temporarily unable to complete purchases.
* **Inactive**: The organization has been deactivated by the store admins, so users will not be able to log in.

##### Adding organization

To manually create a new organization on the **Organizations** page, please follow these steps:

1. Click the `New` button.
2. Fill in the required information about the new organization, as illustrated in the image below.
   * **Name of organization:** Name of the organization you want to create.
   * **Name of cost center:** Name of the initial cost center associated with the organization.
   * **Country:** Country where the cost center is located.
   * **Postal code:** Postal code of the cost center address.
   * **Address Line 1:** Main address information, including the street number and street name where the cost center is located.
   * **Address Line 2:** Optional field for additional address information.
   * **City:** City where the cost center is located. This field will be completed automatically based on the postal code informed.
   * **State:** State where the cost center is located. This field will be completed automatically based on the postal code informed.
   * **Receiver:** Name of the person who will receive the orders at the specified address.
3. Click `Add`.
![05-add-organization](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766663-e1b2005a-0c2d-4bec-84ad-612007f17d64.gif)

> After creating the organization, you can add additional cost centers and addresses. The process for doing so is explained in the next section of this documentation.

#### Organization Details

On the **Organizations Details** page, you can view and edit the following information of an existing organization:

* [Organization name and status](#organization-name-and-status)
* [Cost centers](#cost-centers)
* [Collections](#collections)
* [Payment terms](#payment-terms)
* [Price tables](#price-tables)
* [Users](#users)

You can access this page by going to **Account Settings** \> **B2B Organizations & Cost Centers** \> **Organizations** in the VTEX Admin and clicking the organization whose details you want to view, or ![](https://user-images.githubusercontent.com/77292838/159766633-dfcb818f-6bd7-4cd0-92dc-9c682fb50d04.png) \> `View`.

> Note that assigning collections, payment terms, and price tables to an organization is optional. If these are not assigned, users belonging to the organization will see the store default catalog, have access to all payment methods, and view the store default pricing.

##### Organization name and status

In the top section of the page, you will find the following information:

* **Organization Name:** Name of the organization. You can edit this information.
* **Status:** Status of the organization. You can set it to **Active**, **On Hold** or **Inactive** by selecting from a list.
* **Created:** Date when the organization was created.
![06-organization-name-status](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766675-bd899388-7537-427d-af37-fc048aaf8636.png)

##### Cost Centers

In the **Cost Centers** section, you can view all cost centers associated with the organization. VTEX Admin users can view and manage cost centers for any organization.

![07-cost-centers](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766678-0fd6c361-e1e6-470b-a9fc-c98b530c05e9.png)

> Each organization must have at least one cost center.

By default, each cost center allows the [payment terms](#payment-terms) that have been assigned to the parent organization. However, **Organization Admin** users can enable or disable individual payment terms at the cost center level. For more information on managing cost centers, please refer to the [Managing Cost Centers](#manage-cost-centers) section.

To create a new cost center, follow the steps below.

1. Click the `New` button.
2. Enter the required information about the new cost center, as illustrated in the image below.
   * **Name:** Name of the cost center.
   * **Country:** Country where the cost center is located.
   * **Postal code:** Postal code of the cost center address.
   * **Address Line 1:** Main address information, including the street number and street name where the cost center is located.
   * **Address Line 2:** Optional field for additional address information.
   * **City:** City where the cost center is located. This field will be completed automatically based on the postal code informed.
   * **State:** State where the cost center is located. This field will be completed automatically based on the postal code informed.
   * **Receiver:** Name of the person who will receive the orders at the specified address.
3. Click `Add`.
![08-add-cost-center](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766680-5eb39381-a7da-4278-b8da-8cc7efe3e90a.gif)

##### Cost Center Details

You can view or edit the details of an existing cost center by clicking on it on the **Organization Details** page.

This will lead you to the **Cost Center Details** page, where you can:

* View or edit the cost center **Name** and **Addresses**.
* View or edit the cost center **Business Document**.
* Add a new shipping address associated with the cost center.
* Delete the cost center.
![09-cost-center-details](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766691-4557a032-a38c-4abb-a5a1-29019b833ad2.png)

The **Business Document field** is optional and can be utilized to store business identifiers such as Tax ID, VAT ID, CNPJ, or similar identification numbers. If a Business Document is specified in a user's cost center, it will be automatically applied as the `corporateDocument` in the user's profile. Additionally, this business document will be attached to any orders placed by the user.

> Please note that the shipping addresses assigned to a cost center will only be accessible to users belonging to that specific cost center during the checkout process if you have installed [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings). Other addresses will not be available. Therefore, each cost center must have at least one shipping address.

To edit or delete an existing address, click ![](https://user-images.githubusercontent.com/77292838/159766633-dfcb818f-6bd7-4cd0-92dc-9c682fb50d04.png) next to it and select **Edit** or **Delete**.

To add a new shipping address for a cost center, follow these instructions:

1. Click `Add new address`.
2. Enter the required information for the new address.
   * **Country:** Country where the cost center is located.
   * **Postal code:** Postal code of the cost center's address.
   * **Address Line 1:** Main address information, including the street number and street name where the cost center is located.
   * **Address Line 2:** Optional field for additional address information.
   * **City:** City where the cost center is located. This field will be completed automatically based on the postal code informed.
   * **State:** State where the cost center is located. This field will be completed automatically based on the postal code informed.
   * **Receiver:** Name of the person who will receive the orders at the specified address.
3. Click `Add`.

Make sure to click `Save` in the top right of the **Cost Center Details** page to save any changes made.

If you want to delete the cost center, click `Delete` instead.

##### Collections

> You must use the **Collections Beta** solution to be able to associate collections with organizations using **B2B Organizations**. Read our article on [Creating Collections Beta](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye) for more information.

This section allows you to manage the [product collections](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/creating-collections-beta--yJBHqNMViOAnnnq4fyOye) assigned to the organization, which determines the assortment of products visible to organization users in the storefront.

To add a collection, select the collection you want to add from the **Available** list and click `Add to org`.

To remove a collection, select the collection you want to remove from the **Assigned to organization** list and click `Remove from org`.

![10-collections](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766692-aec018f6-d09b-4290-a180-a0e2b7040295.gif)

##### Payment Terms

In this section, you can choose which [payment conditions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-to-configure-payment-conditions--tutorials%5F455?%26utm%5Fsource=autocomplete) are assigned to the organization, which determines which payment options are available to organization users during checkout.

Note that the available payment options can be further customized per cost center by the **Organization Admin**. See the [Managing Cost Centers](#manage-cost-centers) section for more information.

To add a payment term, select the option you want to add from the **Available** list and click `Add to org`.

To remove a payment term, select the option you want to remove from the **Assigned to organization** list and click `Remove from org`.

![11-payment-terms](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766697-27de2f5b-18b3-4067-a4f1-81da8fb61bc0.gif)

> To customize the checkout according to each organization user role, you need to install and configure [B2B Checkout Settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-checkout-settings).

##### Price Tables

This section allows you to choose which [price tables](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-price-tables--58YmY2Iwggyw4WeSCGg24S) are assigned to the organization. The prices displayed to organization users in the storefront are determined by the selected price tables.

To add a price table, select the option you want to add from the **Available** list and click `Add to org`.

To remove a price table, select the option you want to remove from the **Assigned to organization** list and click `Remove from org`.

![12-price-tables](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766700-34ebfaaf-f6fa-42b6-85a9-a83dca5505ef.gif)

##### Users

This section displays a list of users associated with the organization, showing their **Email**, **Role** in the organization, and the **Cost Center** they are associated with.

![13-users-list](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766707-572dd167-e948-4300-b259-1c9cd0b8a341.png)

To add a new user to the organization, follow these steps:

1. In the **Users** list, click the `New` button.
2. Enter the user information, as illustrated below.
   * **Name:** Full name of the user.
   * **Email:** Email address of the user.
   * **Cost Center:** Cost center the user will be associated with.
   * **Role:** Role the user will have in the storefront. See more details on the available roles in the [Storefront Permissions documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions%23available-storefront-roles).
3. Click `Add`.
![14-add-new-user](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766710-4e35973c-880d-4e98-8f93-4a6c87d3f4e8.png)

Once you add a new user to the organization, a customer account will be created if an account does not already exist in your store for the provided email address.

To edit or remove an existing user, follow these steps:

1. Click the user you want to edit or delete in the **Users** list.
2. Edit the desired information.
You can change the user's **Cost Center** and their **Role**.
If you want to remove the user from the organization, click `Remove user` and skip the next step.
3. To apply your changes, click `Save`.
![15-edit-user](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766713-03778c4a-370a-4c13-be4a-8f507cee0a73.png)

If a user is removed from an organization, their account will continue to exist in the store, but they will no longer be associated with an organization, cost center, or B2B role. Thus, they will lose access to the details of their organization on the **My Organization** page. Instead, they will have the option to [request the creation of a new organization](#request-new-organization), if necessary.

> As an optional feature, you can install the [Admin Customers](https://read.calvincode.net/reader?url=https://github.com/vtex/admin-customers) app for additional customer management capabilities on the VTEX Admin.

#### Email templates

The **B2B Organizations** app provides a set of four email templates to be sent to B2B organization users, which are triggered automatically based on specific changes:

| **Template name**               | **Recipient**                          | **Trigger**                                 |
| ------------------------------- | -------------------------------------- | ------------------------------------------- |
| **Organization Approved**       | Users with the Organization Admin role | The organization request has been approved. |
| **Organization Created**        | Users with a Sales Admin role          | The organization has been created.          |
| **Organization Declined**       | Users with the Organization Admin role | The organization request has been declined. |
| **Organization Status Changed** | Users with the Organization Admin role | The organization status has changed.        |

If you want to view or edit these templates, follow the steps below.

1. In the VTEX Admin, go to **Customer > Message center > Templates**.
2. Type `organization` in the search bar.
3. Click the template you want to view or edit.
4. Make the desired changes in the template. For detailed instructions on editing **Message Center** templates, refer to our documentation on [How to Create and Edit Transactional Email Templates.](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/transactional-emails--6IkJwttMw5T84mlY9RifRP/335JZKUYgvYlGOJgvJYxRO)
5. Click `Save`.
![16-templates](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766714-6b5feaaf-3d81-472e-a713-55d952a1e556.gif)

### Master Data v2

The **B2B Organizations** app stores information about organization requests, organizations, and cost centers in [Master Data v2](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/master-data-v2--3JJ1mlzuo88w22gO0gy0QS).

This means that store admins or developers can retrieve this information via the [Master Data API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23overview) by using their **data entity name** as the value for the `data_entity_name` parameter.

You can see the data entity names in the table below.

| **Data entity names**  |
| ---------------------- |
| organization\_requests |
| organizations          |
| cost\_centers          |

### Storefront

Storefront capabilities, in turn, are accessible to B2B customers who visit a supplier store, provided that they are logged in and have the required permissions.

The following sections describe what your customer can do in your storefront after you have finished setting up the B2B Organizations app.

#### Requesting a new organization

If a B2B user is not currently associated with any organization, they have the option to request the creation of a new buyer organization in your store by completing the **Request New Organization** form. They can follow the steps below to do so.

1. Access the store website.
2. Click **My Account** \> **My Organization**.
3. Provide the required information, as shown in the image below.
   * **Organization Name:** Name of the organization.
   * **User to become Organization Admin:** Section where you must provide information about the first user of the organization, who will be assigned as the Organization Admin.
         * **First Name:** First name of the Organization Admin user.
         * **Last Name:** Last name of the Organization Admin user.
         * **Email Address:** Email address of the Organization Admin user.
   * **Default Cost Center:** Section where you must provide information about the first cost center associated with the organization.
         * **Cost Center Name:** Name of the cost center.
         * **Business Document:** Optional field for a business document such as a Tax ID, Company registration number, etc.
         * **Country:** Country where the cost center is located.
         * **Postal code:** Postal code of the cost center's address.
         * **Address Line 1:** Main address information, including the street number and street name where the cost center is located.
         * **Address Line 2:** Optional field for additional address information.
         * **City:** City where the cost center is located. This field will be completed automatically based on the postal code informed.
         * **State:** State where the cost center is located. This field will be completed automatically based on the postal code informed.
         * **Receiver:** Name of the person who will receive the orders at the specified address.
4. Click `Submit`.
![17-organization-request](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766733-14da23e9-55d6-44e8-8cfc-95d62e3b4ade.gif)

After submitting the form, the request will be sent to a queue for review by the B2B store administrator. See the [Organization Requests](#organization-requests) section for more information.

The user designated as the **Organization Admin** for the new organization will receive an email notification when the request has been approved or declined by the store admin. Learn more about this notification in the [Email templates](#email-templates) section.

#### My Organization

Users designated as the **Organization Admin** or **Sales Admin** can manage their organization's details in the storefront on the **My Organization** page.

Users with the **Organization Buyer** or **Organization Approver** roles can also view a read-only version of this page.

To access **My Organization**, follow the instructions below.

1. Access the storefront and log in.
2. Click `Hello, {name}`.
3. Click **My Account**.
4. Go to **My Organization** on the sidebar. You will see the page below.
![18-my-organization](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766773-4d62c3ed-4282-45a9-bf36-d0041684cc50.png)

On this page, the user with the **Organization Admin** or **Sales Admin** roles can do the following:

* [Manage Cost Centers](#manage-cost-centers)
* [Manage Users](#manage-users)

##### Managing cost centers

Storefront users who have the **Organization Admin** or **Sales Admin** role can navigate to the Cost Centers section on the My Organization page to view the cost centers associated with their organization.

To add a new cost center, they should go to **My Account > My Organization**, where they will have access to the same options as described in the [Cost Centers](#cost-centers) section. They can view or edit the details of an existing cost center by clicking on it, similar to the process described in the [Cost Center Details](#cost-center-details) section.

**Organization Admins** can also view and/or edit the **Business Document** associated with each cost center, as described in [Cost Center Details](#cost-center-details).

In addition, **Organization Admins** can enable specific payment terms for a cost center by using the switch button to activate or deactivate the payment terms assigned to the organization, as shown below.

> This section will only be available on the **My Organization** page if [payment terms](#payment-terms) have been previously assigned to the organization by the VTEX Admin users.

![19-payment-terms-cost-center](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766775-dd0a17bd-8418-401b-a377-7d4c9ed0cf11.png)

##### Managing users

**Organization Admin** or **Sales Admin** storefront users can also view and manage the users of their organization in the **Users** section of the **My Organization**. To access this section, they can go to **My Account > My Organization**, where they will have access to the same options described in the [Users](#users) section of this documentation.

Users with the **Organization Admin** role can add, edit, or remove users with any of the following roles: **Organization Admin**, **Organization Approver**, and **Organization Buyer**.

Users with the **Sales Admin** role may add, edit, or remove users with any of the following roles: **Sales Admin**, **Sales Manager**, and **Sales Representative**.

###### Impersonating users

In telesales, assisted sales, or customer support scenarios where the B2B customer needs help from a salesperson to navigate the store or place orders, it is common to use impersonation.

In the **B2B Organizations** app, users with a profile with at least one of the permissions **impersonate-users-all**, **impersonate-users-organization**, or **impersonate-users-costcenter** will be able to impersonate another user. These permissions are available in the [Storefront Permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.storefront-permissions) and can be added to the user's profile using the [Storefront Permissions UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-storefront-permissions-ui).

When impersonation is activated, it temporarily applies the email, organization, and cost center of the impersonated user to the storefront session. This allows impersonating users to do the following:

* Browse the store and view prices, products, shipping addresses, and payment methods as the impersonated user would see them.
* Take actions on behalf of the impersonated user, such as placing orders.
* Use the regular permissions of the impersonated user.

To use impersonation, users with **Sales** roles or the **Organization Admin** role must follow the steps below.

1. In the **Users** section of [My Organization](#my-organization), click ![](https://user-images.githubusercontent.com/77292838/159766633-dfcb818f-6bd7-4cd0-92dc-9c682fb50d04.png) in the row of the user they want to impersonate.
2. Click **Impersonate User**.
![20-users](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766777-1ff83458-cad0-46de-82e4-1e3c3e4bb144.png)

> It is not possible to impersonate emails with Sales roles.

#### User widget

To give storefront users visibility into their currently assigned organization, cost center, and role, this app provides a user widget that can be added to the account store theme:

![21-user-widget](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766781-8edabb7e-292c-4c8e-a88e-ae937ec7db86.png)

> To display the user widget, you must follow the instructions in the [User widget configuration](#user-widget-configuration) section.

If users click `Manage organization`, they can access the **My Organization** page directly.

In case impersonation is currently active, this block will also show the email of the user being impersonated, as well as the `Stop impersonation` button:

![22-user-widget-impersonation](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/77292838/159766784-6bce63af-9cc6-4ac4-bc59-460b74722dbe.png)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/_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/vtex-b2b-suite/vtex-b2b-organizations.md)

Contributors

1

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

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23before-you-begin)

[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23installation)

[User widget configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23user-widget-configuration)

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

[b2b-user-widget](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23b2b-user-widget)

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

[How the app works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23how-the-app-works)

[VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23vtex-admin)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23master-data-v2)[Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23storefront)

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/vtex-b2b-suite/vtex-b2b-organizations.md)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23before-you-begin)

[Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23installation)

[User widget configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23user-widget-configuration)

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

[b2b-user-widget](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23b2b-user-widget)

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

[How the app works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23how-the-app-works)

[VTEX Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23vtex-admin)[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23master-data-v2)[Storefront](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-b2b-organizations/docs/guides/vtex-b2b-organizations%23storefront)

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