[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 policies from license manager 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-policies-from-license-manager/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/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-policies-from-license-manager/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies)

[Accessing external resources within a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/accessing-external-resources-within-a-vtex-io-app)

[Controlling access to app resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/controlling-access-to-app-resources)

[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-roles)

[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-vrn)

[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies-from-license-manager)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/storefront-development)

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-what-is-vtex-io)

---

[What is a VTEX App](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-what-is-a-vtex-app)

---

[Governance and shared security in VTEX IO apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/governance-and-shared-security-in-vtex-io-apps)

---

[Code samples and templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-getting-started)

---

Project structure

---

[VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-workspace)

---

Managing apps

---

Development guides

---

[Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies)

[Accessing external resources within a VTEX IO app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/accessing-external-resources-within-a-vtex-io-app)

[Controlling access to app resources](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/controlling-access-to-app-resources)

[Roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-roles)

[VTEX Resource Name (VRN)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-vrn)

[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies-from-license-manager)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-making-your-new-app-version-publicly-available)

---

[VTEX App Store](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/app-development)

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies)

[Policies from License Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/docs/guides/vtex-io-documentation-policies-from-license-manager)

Policies from License Manager

Discover the policies a VTEX IO app can use from License Manager resources.

In order for a VTEX IO app to access external resources, it requires authorization through policies declared in its [manifest.json file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-manifest). One type of external resource available is the [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3), which can be authorized to access by declaring the resource’s **Key** in the `policies` list of the app. For instance, by adding `Sku.aspx` to the `policies` list, your app gains permission to read SKUs from the Catalog.

`1

{

2

 "$schema": "https://raw.githubusercontent.com/vtex/node-vtex-api/master/gen/manifest.schema",

3

 "name": "app-name",

4

 "vendor": "vendor",

5

 "version": "0.0.0",

6

 "title": "VTEX IO App",

7

 "description": "",

8

 "dependencies": {},

9

 "builders": {...},

10

 "scripts": {...},

11

 "policies": [

12

 {

13

 "name": "Sku.aspx"

14

 },

15

 {

16

 "name": "outbound-access",

17

 "attrs": {

18

 "host": "{{account}}.vtexcommercestable.com.br",

19

 "path": "/arquivos/favicon.ico"

20

 }

21

 }

22

 ]

23

}

`

> Note that License Manager policies are declared in a different way than outbound-access policies. While outbound-access policies require the explicit host and path for each resource, License Manager policies operate based on predefined roles.

Below is a table listing the role-based VTEX IO policies for the License Manager resources. The table indicates which [Client](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients) the policy is associated with.

| Name                         | Key                          | Description                                                                                | Client         | Resources                                                                                |
| ---------------------------- | ---------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Product management           | ProdutoForm.aspx             | View the registration screen and product change.                                                                                | catalog        | {{account}}.vtexcommercestable.com.br/api/catalog\_system/pvt/products/\*                                                                              |
| Product and SKU Management   | ManterFormularioProdutoSku   | Change and inclusion of product and SKU.                                                                                | catalog        | {{account}}.vtexcommercestable.com.br/api/catalog\_system/pvt/products/\*                                                                              |
| Brands                       | Marca.aspx                   | List all registered brands.                                                                                | catalog        | {{account}}.vtexcommercestable.com.br/api/catalog\_system/pvt/brand/list                                                                               |
| SKUs                         | Sku.aspx                     | Lists all registered SKUs.                                                                                | catalog        | {{account}}.vtexcommercestable.com.br/api/catalog\_system/pvt/sku/\*                                                                                |
| Orders Full Access           | AcessaTodosPedidos           | Reading and writing for all requests via Checkout API. It does not allow access to requests for the flow of the order management module. | checkout       | {{account}}.vtexcommercestable.com.br/api/oms/pvt/orders/\*                                                                                |
| Order Cancellation           | CancelaPedidos               | Cancel orders.                                                                                | checkout       | /api/oms/pvt/orders/{{orderId}}/cancel                                                                                |
| Save OrderForm Configuration | SaveOrderFormConfiguration   | Save the configuration of shopping carts.                                                                                | checkout       | /api/checkout/pvt/configuration/orderform                                                                                |
| Read Shopping Cart           | GetOrderForm                 | Reading and listing all shopping carts. It does not allow access to non-masked cart data.                                                | checkout       | /api/checkout/pub/orderform/{{orderFormId}}                                                                                |
| Get account by identifier    | Get\_Account\_By\_Identifier | Consultation that returns accounts for the identifier, which may be the account ID, host, or name of the account application.            | licenseManager | /api/license-manager/account/api/license-manager/pvt/accounts/\*/api/pvt/accounts/\*/api/site/pvt/accounts/\*/api/license-manager/site/pvt/accounts/\* |
| Master Data administrator    | ADMIN\_DS                    | Manage Master Data.                                                                                | masterData     | {{account}}.vtexcommercestable.com.br/\*                                                                                |
| Vbase Read Only              | vbase-read-only              | Read-only access to VBase.                                                                                | vbase          | /buckets/\*                                                                                |
| Vbase Read Write             | vbase-read-write             | Read and write access to VBase.                                                                                | vbase          | /buckets/\*                                                                                |
| List Orders                  | ListOrders                   | List all orders from the given account.                                                                                | OMS            | /api/oms/pvt/orders                                                                                |

> If you know about a policy that needs to be described in the table and wants it to be documented, open a request using our [feedback form](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform).

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager/_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/Reference/concepts/vtex-io-documentation-policies/vtex-io-documentation-policies-from-license-manager.md)

[VTEX Resource Name (VRN)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager//docs/guides/vtex-io-documentation-vrn)[A/B testsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-policies-from-license-manager//docs/guides/ab-tests)

Contributors

1

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

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/Reference/concepts/vtex-io-documentation-policies/vtex-io-documentation-policies-from-license-manager.md)

Copy page

On this page

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 faststore session 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/session-overview/docs/guides)

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[Enabling refresh token on FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-enabling-refresh-token)

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

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

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

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

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

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

---

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[Enabling refresh token on FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-enabling-refresh-token)

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

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

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

Session

The Session module manages the state of session-related information in the customer's browser, including currency, channel, localization, and customer data. It ensures session validation and synchronization with the shopping cart, providing a consistent and up-to-date shopping experience.

## Session object structure

You can see details of the session data managed by the module below.

### Session

| **Field**      | **Type** | **Description**                                                                                |
| -------------- | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| addressType    | string   | Specifies the type of address associated with the session. Possible values are: shipping (delivery addresses), billing (payment addresses), or null if not specified. |
| b2b            | object   | Contains B2B information. See \[B2B\] for more details.                                                                                |
| channel        | string   | Indicates the sales channel associated with the session.                                                                                |
| country        | string   | Indicates the country associated with the session in a three-letter ISO code (example: USA).                                                                          |
| currency       | object   | Contains currency details for the session. See [Currency](#currency) for more information.                                                                            |
| geoCoordinates | object   | Contains geographical coordinates for the user session. See [GeoCoordinates](#geocoordinates) for details.                                                            |
| locale         | string   | Indicates the locale of the session, including language and region (example: "en-US").                                                                                |
| person         | object   | Contains information about the customer. See \[Person\] for details.                                                                                |
| postalCode     | string   | Indicates the postal code associated with the session.                                                                                |

#### `b2b`

| **Field**  | **Type** | **Description**                                            |
| ---------- | -------- | ---------------------------------------------------------- |
| customerID | String   | Identifies the buyer organization the customer belongs to. |

#### `geoCoordinates`

| **Field** | **Type** | **Description**                                                  |
| --------- | -------- | ---------------------------------------------------------------- |
| latitude  | number   | Indicates the latitude coordinate of the geographical location.  |
| symbol    | number   | Indicates the longitude coordinate of the geographical location. |

#### `currency`

| **Field** | **Type** | **Description**                                                        |
| --------- | -------- | ---------------------------------------------------------------------- |
| code      | String   | Indicates the currency code in three-letter ISO format (example: USD). |
| symbol    | String   | Indicates the symbol associated with the currency (example: $).        |

#### `person`

| **Field**  | **Type** | **Description**                                                           |
| ---------- | -------- | ------------------------------------------------------------------------- |
| id         | String   | Provides the customer identifier, if available in the ecommerce platform. |
| email      | String   | Stores the email address provided by the customer.                        |
| givenName  | String   | Contains the customer’s first name.                                       |
| familyName | String   | Contains the customer’s last name.                                        |

## Import

The Session module exports a `createSessionStore` function and `Session` type, which you can import like this:

`1

import { createSessionStore } from '@faststore/sdk'

2

import type { Session } from '@faststore/sdk'

`

## Usage

The following example demonstrates how to manage a session using `createSessionStore`.

* The `createSessionStore` function initializes a session store with the provided default session and an optional validation function.
* The `validateSession` function sends the current session data to the [FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/faststore-api-overview) for validation and returns the validated session.

`` 1

2

import { gql } from '@faststore/graphql-utils'

3

import { createSessionStore } from '@faststore/sdk'

4

import { useMemo } from 'react'

5

import type { Session } from '@faststore/sdk'

6

7

import storeConfig from 'store.config'

8

9

import { cartStore } from '../cart'

10

import { request } from '../graphql/request'

11

import { createValidationStore, useStore } from '../useStore'

12

import type {

13

 ValidateSessionMutation,

14

 ValidateSessionMutationVariables,

15

} from '../../../@generated/graphql/index'

16

17

export const mutation = gql`

18

 mutation ValidateSession($session: IStoreSession!, $search: String!) {

19

 validateSession(session: $session, search: $search) {

20

 locale

21

 channel

22

 country

23

 postalCode

24

 currency {

25

 code

26

 symbol

27

 }

28

 person {

29

 id

30

 email

31

 givenName

32

 familyName

33

 }

34

 }

35

 }

36

`

37

38

export const validateSession = async (session: Session) => {

39

 const data = await request<

40

 ValidateSessionMutation,

41

 ValidateSessionMutationVariables

42

 >(mutation, { session, search: window.location.search })

43

44

 return data.validateSession

45

}

46

47

const [validationStore, onValidate] = createValidationStore(validateSession)

48

49

const defaultStore = createSessionStore(storeConfig.session, onValidate)

50

51

export const sessionStore = {

52

 ...defaultStore,

53

 set: (val: Session) => {

54

 defaultStore.set(val)

55

56

 // Trigger cart revalidation when session changes

57

 cartStore.set(cartStore.read())

58

 },

59

}

60

61

export const useSession = () => {

62

 const session = useStore(sessionStore)

63

 const isValidating = useStore(validationStore)

64

65

 return useMemo(

66

 () => ({

67

 ...session,

68

 isValidating,

69

 }),

70

 [isValidating, session]

71

 )

72

}

 ``

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/_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/faststore/docs/sdk/session/overview.mdx)

[useSearch« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/search-use-search)[Enabling refresh token on FastStoreNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/session-overview/docs/guides/faststore/session-enabling-refresh-token)

Contributors

1

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

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

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

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

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

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/sdk/session/overview.mdx)

Copy page

On this page

ON THIS PAGE

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

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

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

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

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 multilevel omnichannel inventory 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/multilevel-omnichannel-inventory/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-shipping-network)

[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-tracking)

[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-pick-and-pack)

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory)

[Multilevel omnichannel inventory API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory-api-integration)

[Change chain orders in external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)

[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/setting-up-white-label-seller-as-pickup-point)

[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/delivery-promise)

---

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/multilevel-omnichannel-inventory/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-shipping-network)

[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-tracking)

[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/vtex-pick-and-pack)

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory)

[Multilevel omnichannel inventory API integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory-api-integration)

[Change chain orders in external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)

[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/setting-up-white-label-seller-as-pickup-point)

[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/delivery-promise)

---

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/multilevel-omnichannel-inventory/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Logistics

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory)

Multilevel Omnichannel Inventory

A [marketplace](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/estrategias-de-marketplace-na-vtex--tutorials%5F402) is the environment where the product is sold, or the storefront. The [seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/estrategias-de-marketplace-na-vtex--tutorials%5F402%23selling-on-marketplaces) owns the product and is responsible for fulfillment. [VTEX promotes digital collaboration](https://read.calvincode.net/reader?url=https://vtex.com/us-en/ecommerce-marketplace/) by allowing multiple combinations of architecture between these two entities. One of these combinations is called [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4).

_Multilevel Omnichannel Inventory_ is the VTEX setting that allows [franchises](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/o-que-e-conta-franquia--kWQC6RkFSCUFGgY5gSjdl) or [white label sellers](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/white-label-seller--5orlGHyDHGAYciQ64oEgKa)' inventory to be sold in marketplaces to which the main account is connected.

For VTEX sellers, this means being able to sell products from its franchises or white label sellers in a marketplace, without the need to set up the integration with the desired marketplace for all franchise stores, and white label sellers.

For marketplaces, this means selling products from its direct sellers and also physical stores and white label sellers associated with those sellers in a scalable way.

This article covers the account architecture details, chain order flows and necessary settings for VTEX marketplaces to implement this feature via API.

> To know how to implement this feature via VTEX Admin, along with benefits and restrictions around the use of Multilevel Omnichannel Inventory, check out our [Multilevel Omnichannel Inventory Help article](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4).

## Account architecture

When a store sells its products in a marketplace, we have a one-level relationship between seller and marketplace. However, VTEX's architecture allows stores to act as both sellers and marketplaces, expanding the number of possible combinations.

Stores that have white label sellers and franchises are marketplaces to those accounts. But they can also be connected to other VTEX marketplaces, becoming sellers themselves. In this case, we have a three level architecture, as illustrated in the image below.

![{"base64":"  ","img":{"width":1460,"height":1048,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":227543,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/multilevel-omnichannel-inventory-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/multilevel-omnichannel-inventory-0.png)

* **Marketplace (level 1):** storefront where the product is sold and order is placed.
* **Direct seller (level 2):** main account, integrated to the marketplace level 1\. Serves as a marketplace for white label sellers, franchise accounts and physical stores connected to it.
* **Franchise accounts/physical stores (level 3):** owns the product, and is responsible for fulfillment. Connected as white label sellers to the main account.

With the Multilevel Omnichannel Inventory setting, all franchise accounts and white label sellers (level 3) are already fully integrated to a store's main account (level 2). This means that when the main account sets up an integration with an other marketplace (level 1), the franchise accounts can be integrated as well, no longer being necessary to manage each franchise individually in order to set up its integration with the marketplace (level 1).

> This feature is valid just for [VTEX marketplaces](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/marketplace-strategies-at-vtex--tutorials%5F402%23ser-um-marketplace-vtex).

## Order flow

The Multilevel Omnichannel Inventory also affects an order's flow. The order flow describes the status, possibilities, and actions throughout the life cycle of an order. With the flow, retailers can also track the mapped order status on the platform. The table below summarizes all types of order flows that VTEX supports.

| **Order source and destination**                            | **Order type and workflow**                                                                                |
| ----------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------- |
| VTEX store is the **source** of an order →                  | [Marketplace order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-e-status-de-pedidos--tutorials%5F196%23marketplace-flow)with Checkout Workflow.   |
| VTEX store is **intermediate** in the order flow →          | [Chain order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-e-status-de-pedidos--tutorials%5F196%23chain-flow)with Chain Workflow.                  |
| VTEX store is the **destination** of an order →             | [Seller order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-e-status-de-pedidos--tutorials%5F196%23seller-flow)with Fulfillment Workflow.          |
| VTEX store is both the **source** and the **destination** → | [Complete order](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/fluxo-e-status-de-pedidos--tutorials%5F196%23complete-flow)flow with Fulfillment workflow. |

The Multilevel Omnichannel Inventory setting allows the entire inventory from a physical store network to be integrated into marketplaces, creating **chain orders**.

Let's break down how chain orders are applied in Multilevel Omnichannel Inventory architecture:

* Order originates in the marketplace (level 1).
* Order goes through an intermediate agent, in this case, the direct sellers (level 2).
* Order reaches its destination, to be fulfilled by the white label sellers (level 3).

Therefore, chain orders in direct seller have characteristics that come from both _marketplaces_, because they take the role of a seller's marketplace, and _sellers_, since they are also sellers of a marketplace.

Check out the order flow for chain orders in the image below:

![{"base64":"  ","img":{"width":1758,"height":832,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":190028,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/multilevel-omnichannel-inventory-1.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/multilevel-omnichannel-inventory-1.png)

The order flow seen by the level 2 store in a Multilevel Omnichannel Inventory is similar to the marketplace order flow, except for receiving the payment for orders. In the Payment pending stage, instead of the chain receiving payment directly from the gateway, the marketplace informs the chain it has received the payment confirmation.

> VTEX stores cannot use the [change order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-order) feature for chain orders made on VTEX marketplaces.

## Setup for VTEX marketplaces

The setup for Multilevel Omnichannel Inventory must be made by the marketplace [through their VTEX Admin](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4) or REST API. This setup can be made in sellers that are already integrated, or sellers being added for the first time.

To configure Multilevel Omnichannel Inventory via REST API:

1. The marketplace must call the endpoint [Configure Seller Account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/marketplace-apis%23post-/seller-register/pvt/sellers).
2. Fill the `fulfillmentEndpoint` field with the seller's checkout endpoint, following the example below:
`1
https://{{sellerAccount}}.vtexcommercestable.com.br/api/checkout?affiliateid={{affiliateId}}&sc={{salesChannel}}
`
3. Replace the placeholders with the following values:
   * **sellerAccount**: [Account name](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/o-que-e-account-name--i0mIGLcg3QyEy8OCicEoC) of the seller in VTEX.
   * **affiliateId**: 3-digit [afiliate](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/o-que-e-afiliado--4bN3e1YarSEammk2yOeMc0) identification code created by the seller. The seller must inform this ID to the marketplace so that the marketplace can complete the configuration process.
   * **salesChannel**: Sales channel (or [trade policy](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/como-funciona-uma-politica-comercial--6Xef8PZiFm40kg2STrMkMV%23master-data) associated to the seller account created. The seller must inform this ID to the marketplace so that the marketplace can complete the configuration process.

Contributors

5

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

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

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

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

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

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/Fulfillment/multilevel-omnichannel-inventory/multilevel-omnichannel-inventory.md)

[VTEX Pick and Pack Carrriers Integration Protocol« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory//docs/guides/vtex-pick-and-pack-carriers-integration-protocol)[Multilevel omnichannel inventory API integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory//docs/guides/multilevel-omnichannel-inventory-api-integration)

Contributors

5

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

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

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

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

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

ON THIS PAGE

[Account architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23account-architecture)

[Order flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23order-flow)

[Setup for VTEX marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23setup-for-vtex-marketplaces)

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/Fulfillment/multilevel-omnichannel-inventory/multilevel-omnichannel-inventory.md)

Copy page

On this page

ON THIS PAGE

[Account architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23account-architecture)

[Order flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23order-flow)

[Setup for VTEX marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory/docs/guides/multilevel-omnichannel-inventory%23setup-for-vtex-marketplaces)

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