[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 can i order my product as i want 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/can-i-order-my-product-as-i-want/docs/guides)

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

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

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/store-framework)

---

(Legacy) CMS Portal

[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)

[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/can-i-order-my-product-as-i-want)

[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/list-of-controls-for-templates)

[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/setting-up-the-zoom)

[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/creating-gift-lists)

[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/validating-a-layout-before-moving-it-to-production)

[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/how-to-use-the-page-title-control)

[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/how-product-name-control-works)

[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/configure-the-price-history-control)

[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/shelf-template-controls)

[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/control-to-disable-the-canonical-tag)

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/store-framework)

---

(Legacy) CMS Portal

[Migrating your storefront from Legacy CMS Portal to Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)

[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/can-i-order-my-product-as-i-want)

[List of controls for templates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/list-of-controls-for-templates)

[Setting up the zoom](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/setting-up-the-zoom)

[Creating gift lists](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/creating-gift-lists)

[Validating a layout before moving it to production](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/validating-a-layout-before-moving-it-to-production)

[How to use the page title control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/how-to-use-the-page-title-control)

[How product name control works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/how-product-name-control-works)

[Configure the price history control](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/configure-the-price-history-control)

[Shelf template controls](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/shelf-template-controls)

[Control to disable the canonical tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/control-to-disable-the-canonical-tag)

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/storefront-best-practices)

---

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/storefront-development)

(Legacy) CMS Portal

[Can I order my product as I want?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/docs/guides/can-i-order-my-product-as-i-want)

Can I order my product as I want?

By default, VTEX system orders products according to their relevance on the site, i.e. by most sold and most viewed.

However, there are ways to change this order: either through the Score field or by using Querystring. How the Score field works is explained in [this article](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-the-score-field-works--1BUZC0mBYEEIUgeQYAKcae).

The Querystring process is simpler: simply incert the parameter into the URL to change the order in which products are displayed.

The parameters are as follows:

* **Lowest price**: `?O=OrderByPriceASC`
* **Highest price**: `?O=OrderByPriceDESC`
* **Best sellers**: `?O=OrderByTopSaleDESC`
* **Best rated**: `?O=OrderByReviewRateDESC`
* **Alphabetical order A-Z**: `?O=OrderByNameASC`
* **Alphabetical order Z-A**: `?O=OrderByNameDESC`
* **Release date (associated with the product)**: `?O=OrderByReleaseDateDESC`
* **Highest discount**: `?O=OrderByBestDiscountDESC`
* **Lowest discount**: `?O=OrderByBestDiscountASC`For example: `http://www.{AccountName}.com/{departament}/{category}?O=OrderByPriceASC`

> You can only use one product order parameter at a time. Therefore, you have to choose the one that best suits your store's needs (remember that parameters can be changed at will).

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/_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/can-i-order-my-product-as-i-want/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F101814716%3Fv%3D4%26w=64%26q=75)](https://github.com/acnmello)

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

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/legacy-cms/can-i-order-my-product-as-i-want.md)

[Migrating your storefront from Legacy CMS Portal to Store Framework« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want//docs/guides/vtex-io-documentation-migrating-storefront-from-legacy-to-io)[List of controls for templatesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want//docs/guides/list-of-controls-for-templates)

Contributors

3

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/can-i-order-my-product-as-i-want/_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/can-i-order-my-product-as-i-want/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F101814716%3Fv%3D4%26w=64%26q=75)](https://github.com/acnmello)

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

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/legacy-cms/can-i-order-my-product-as-i-want.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 vtex io documentation vtex io cli installation and command reference 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-vtex-io-cli-installation-and-command-reference/docs/guides)

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

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

[Installing 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/docs/guides/vtex-io-documentation-vtex-io-cli-install)

[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-update)

[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-usage)

[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)

[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)

[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-frequently-asked-questions)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/storefront-development)

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/updates/release-notes)

App Development

[What is VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/docs/guides/code-samples)

---

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

[Installing 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/docs/guides/vtex-io-documentation-vtex-io-cli-install)

[Updating VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-update)

[Using VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-usage)

[Managing plugins](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)

[Command reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)

[Uninstalling VTEX IO's CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)

---

[Workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/docs/guides/app-development-guides)

---

[GraphQL in VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/graphql-in-vtex-io)

---

[Policies and permissions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-io-documentation-policies)

---

[A/B tests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/ab-tests)

---

[Deployment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/docs/guides/vtex-app-store)

---

[Edition Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/docs/guides/managing-edition-apps)

---

[Frequently asked questions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/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-vtex-io-cli-installation-and-command-reference/docs/app-development)

[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/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference)

VTEX IO CLI

Learn more about VTEX IO CLI: a powerful and essential command-line tool for developers to interact with the VTEX platform

The VTEX IO CLI (Command Line Interface) is the starting and ending point for any development on the VTEX platform. It provides developers with the ability to perform a wide range of actions essential to the development process, including linking local files to the VTEX platform, managing workspaces, and releasing new app versions.

> Different from the previous version, VTEX IO CLI 3.x has a plugin-based architecture. See [what changed](https://read.calvincode.net/reader?url=https://developers.vtex.com/updates/release-notes/new-version-of-vtex-io-cli-released), or access [this link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins) to learn more about VTEX IO CLI plugins.

[Installing VTEX IO CLILearn how to install VTEX IO CLI according to your operating system.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-install)[Using VTEX IO CLIDiscover the most commonly used VTEX IO CLI commands and how to utilize them.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-usage)[Managing pluginsList, update, install or remove VTEX IO CLI plugins.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-plugins)[Command referenceCheck this comprehensive list of all available VTEX IO CLI commands, their functions, examples, and syntax.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-command-reference)[Updating VTEX IO CLILearn how to update the VTEX IO CLI to its latest version.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-update)[Uninstalling VTEX IO CLILearn how to completely uninstall VTEX IO CLI from your machine.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-uninstall)[ChangelogCheck the latest changes in the VTEX IO CLI repository.See more](https://read.calvincode.net/reader?url=https://github.com/vtex/toolbelt/blob/main/CHANGELOG.md)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/_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/vtex-io-documentation-vtex-io-cli-installation-and-command-reference.md)

[Peer Dependencies« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference//docs/guides/vtex-io-documentation-peerdependencies)[Installing VTEX IO CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference//docs/guides/vtex-io-documentation-vtex-io-cli-install)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-vtex-io-cli-installation-and-command-reference/_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/vtex-io-documentation-vtex-io-cli-installation-and-command-reference.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 implementing newsletter opt in with master data v1 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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides)

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

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

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

Guides

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

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/checkout-api-overview)

---

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

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-v2)

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

[Querying documents in Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/querying-documents-in-master-data-v1)

[Implementing newletter opt-in with Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1)

[Uploading files to Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/uploading-files-to-master-data-v1)

[Interacting with Master Data v1 through VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/interacting-with-master-data-v1-through-vtex-io-services)

---

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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/storefront-development)

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

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/troubleshooting)

---

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

Guides

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

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/checkout-api-overview)

---

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

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/master-data-v2)

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

[Querying documents in Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/querying-documents-in-master-data-v1)

[Implementing newletter opt-in with Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1)

[Uploading files to Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/uploading-files-to-master-data-v1)

[Interacting with Master Data v1 through VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/interacting-with-master-data-v1-through-vtex-io-services)

---

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/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides)

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

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

[Implementing newletter opt-in with Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1)

Setting up Newsletter opt-in with Master Data v1

Learn how to configure newsletter subscriptions with Master Data v1.

In this article, we will guide you through configuring **Master Data** to collect the email addresses of customers who wish to subscribe to your newsletter.

Newsletter inclusion is a form that can be integrated into any page of your store website (except checkout), allowing you to capture the email addresses of customers who express an interest in receiving updates about your store. This registration is usually associated with a store promotion.

Integrating newsletter subscriptions with **Master Data** streamlines customer management since all the store's registered customers are already stored in Master Data.

## Before you begin

* Install the SafeData app in your VTEX account. SafeData provides a middleware for retrieving and storing Master Data (v1 e v2) information directly from the frontend. For more information, please refer to the [SafeData documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.safedata).

## Instructions

Below, we provide a step-by-step guide to assist you in setting up this configuration:

1. Create the necessary fields in the CRM. This step is only necessary if you want an extra field in addition to those already in your CRM. If this is the case, please refer to the [Creating a field in Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/how-can-i-create-field-in-master-data) guide.
2. Implement the fields in the HTML of the page determined by the store.

> Please note that the `vtex.cmc:newsletterOptIn` control has been discontinued and should no longer be employed. Instead, use the HTML code created by your development team to achieve this functionality on the store's designated page.

1. Send the information via SafeData API. The SafeData app provides endpoints similar to Master Data endpoints. Use the example request below to update a user profile and enable newsletter opt-in:

**Method:** `PATCH`

**Path:**

`1

https://{{accountName}}.vtexcommercestable.com.br/api/io/safedata/CL/documents/{{documentId}}

`

**Body:**

`1

{

2

 "firstName": "Jonh",

3

 "lastName": "Lennon",

4

 "email": "jonh.lennon@lennon.com.br",

5

 "isNewsletterOptIn": true

6

}

`

By following these steps and utilizing the SafeData API, you can efficiently manage and enhance your newsletter subscription process, keeping your customers engaged and informed. Your CRM will now reflect the email addresses of those who have opted to receive your newsletter.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/_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-v1/implementing-newsletter-opt-in-with-master-data-v1.md)

[Querying documents in Master Data v1« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1//docs/guides/querying-documents-in-master-data-v1)[Uploading files to Master Data v1Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1//docs/guides/uploading-files-to-master-data-v1)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/_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

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1%23instructions)

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-v1/implementing-newsletter-opt-in-with-master-data-v1.md)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1%23before-you-begin)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-newsletter-opt-in-with-master-data-v1/docs/guides/implementing-newsletter-opt-in-with-master-data-v1%23instructions)

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 api integration 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-api-integration/docs/guides)

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/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-api-integration/docs/guides/vtex-shipping-network)

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

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

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/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-api-integration/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-api-integration/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-api-integration/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-api-integration/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-api-integration/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/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-api-integration/docs/guides/data-protection-plus)

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/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-api-integration/docs/guides/vtex-shipping-network)

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

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

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/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-api-integration/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-api-integration/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-api-integration/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-api-integration/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-api-integration/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/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-api-integration/docs/guides/data-protection-plus)

---

Weni by VTEX

---

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

Logistics

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/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-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration)

Multilevel omnichannel inventory API integration

> The [Multilevel Omnichannel Inventory (MOI)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) feature has been discontinued for integrations with external marketplaces. Now, MOI is available only for integrations between VTEX marketplaces and sellers. We recommend reviewing your integration strategies to align with the currently supported functionalities. For more information, please contact [VTEX support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).

Marketplaces following the [External Marketplace protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/external-marketplace-integration-guide) can also make the [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) setting available for VTEX sellers connected to it. This allows for more fulfillment options by VTEX sellers, since they can connect their franchise accounts' inventories as fulfillment options. You can learn more about the benefits and restrictions of implementing this feature in our [Multilevel Omnichannel Inventory Help article](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/multilevel-omnichannel-inventory--7M1xyCZWUyCB7PcjNtOyw4).

External marketplaces and connectors should follow this article's instructions to configure Multilevel Omnichannel Inventory in their marketplace architecture with VTEX.

> Before you begin, make sure that the necessary [settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory%23setup-for-vtex-marketplaces) are made in the connected VTEX account, so the feature is fully operational.

## API integration overview

When using a [Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory) architecture, the endpoints used in the integration's architecture are the following:

* [Place Order](#place-multilevel-omnichannel-order): create the order in the seller responsible for fulfillment.
* [Marketplace Order Authorization](#marketplace-order-authorization): progressing the order, after the marketplace's authorization.
* [Cancel Order Notification](#cancel-order-notification): route to be notified of the seller's, or of the chain agent's (in this case seller level 2) cancellation.
* [Order Invoice Notification](#order-invoice-notification): route to receive invoice notification from the seller, or of the chain agent's (in this case seller level 2).

Therefore, the flow of the routes follows 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)

## Place Multilevel Omnichannel Order

Use the request example below to Place Order.

* Method: PUT
* URL: `{host}/api/checkout/pvt/orders?sc={sc}&affiliateId={affiliateId}`

Request example:

`1

{

2

 "items":[

3

 {

4

 "id":"8",

5

 "quantity":1,

6

 "seller":"1",

7

 "price":12

8

 },

9

 {

10

 "id":"36",

11

 "quantity":1,

12

 "seller":"1",

13

 "price":120

14

 }

15

 ],

16

 "clientProfileData":{

17

 "email":"sicrano@mailinator.com"

18

 },

19

 "shippingData":{

20

 "attachmentId":"shippingData",

21

 "logisticsInfo":[

22

 {

23

 "itemIndex":0,

24

 "selectedSla":"Retirada (14b25e5)",

25

 "selectedDeliveryChannel":"pickup-in-point",

26

 "price":0

27

 },

28

 {

29

 "itemIndex":1,

30

 "selectedSla":"Normal",

31

 "selectedDeliveryChannel":"delivery",

32

 "price":0

33

 }

34

 ],

35

 "selectedAddresses":[

36

 {

37

 "addressId":"-4581767308704"

38

 }

39

 ]

40

 },

41

 "marketplacePaymentValue":1550,

42

 "marketplaceOrderGroup":"externalMarketplace10",

43

 "marketplaceServicesEndpoint":"http://service.externalmarketplace.com/api/orders?parameter=value"

44

}

`

### Changes in the order's data

The Multilevel Omnichannel Inventory changes and adds fields to the order's data. You can know more about the fields in the [Retrieve user order details](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/userorderdetails) API Reference.

The table below describes the fields that were added or changed in the order's data.

| Field                       | New or Changed? | Description                                                                                |
| --------------------------- | --------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| sc                          | New             | Path parameter including the sales channel ID.                                                                                |
| marketplaceServicesEndpoint | New             | Field is added to the orderform. This field should be filled in with the information provided by the external marketplace that is placing an order in VTEX.                                                                                |
| marketplaceOrdergroup       | New             | Field is added to the orderform. This field should be filled in with the information provided by the external marketplace that is placing an order in VTEX.                                                                                |
| affiliateId                 | New             | The [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. |
| marketplacePaymentValue     | New             | Field is added to the orderform.                                                                                |
| transaction                 | Changed         | This field no longer is required in the orderform.                                                                                |
| origin                      | Changed         | The field 'origin' will come with chain as a value, and not fulfillment or marketplace like before.                                                                                |
| paymentData                 | Changed         | The field is no longer required in chained orders.                                                                                |

## Marketplace Order Authorization

The marketplace must implement the following endpoint to notify the chain order that its progress has been approved:

* Method: POST
* URL: `{host}/api/checkout/pvt/orders/{orderId}/receipts/marketplace-order-authorization`

Request example

`1

{

2

 "items":[

3

 {

4

 "id":"8",

5

 "quantity":1,

6

 "seller":"1",

7

 "price":12

8

 },

9

 ],

10

 "marketplaceOrderGroup": "847392476",

11

 "authorizationReceipt": {

12

 "date": "{date}",

13

 "receipt": "{receipt}"

14

 }

15

}

`

| Name                  | Type             | Mandatory | Description                                                                                |
| --------------------- | ---------------- | --------- | ------------------------------------------------------------------------------------------------------------------------------------- |
| orderId               | String           | Yes       | Path parameter with the Chain order ID.                                                                                |
| items                 | Array of objects | Yes       | Array containing the SKUs that are being invoiced.                                                                                |
| id                    | String           | Yes       | ID of the SKU being invoiced.                                                                                |
| price                 | Integer          | Yes       | Total price of the SKU being invoiced in cents. Do not use any decimal separator. For instance, $24.99 should be represented as 2499. |
| seller                | String           | Yes       | Account name of the seller responsible for fulfillment                                                                                |
| quantity              | Integer          | Yes       | Quantity currently in inventory of the SKU being invoiced.                                                                            |
| marketplaceOrderGroup | String           | Yes       | Marketplace order ID or order group                                                                                |
| authorizationReceipt  | Object           | Yes       | Object including date and receipt of authorization                                                                                |
| date                  | String           | Yes       | Date of authorization                                                                                |
| receipt               | String           | Yes       | Receipt number                                                                                |

## Cancel Order Notification

The marketplace must implement the endpoint below, to receive the cancel notification from the VTEX seller.

* Method: POST
* URL: `https://{baseUrldoParceiro}/pvt/orders/order-group/{orderGroup}/notifications/seller-cancellation`

### Request example

`1

{

2

 "id":"sellerOrderCancelled",

3

 "sellerOrderId": "7908010136043"

4

}

`

| Name          | Type   | Mandatory | Description                                                       |
| ------------- | ------ | --------- | ----------------------------------------------------------------- |
| orderGroup    | String | Yes       | Path parameter including the marketplace order ID or order group. |
| id            | String | Yes       | ID of the canceled order by the seller.                           |
| sellerOrderId | String | Yes       | Order ID in the VTEX system.                                      |

## Order Invoice Notification

The marketplace must implement this endpoint for the chain order to inform it about the order invoice. Check out our [Order Invoice Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/orders-api%23post-/api/oms/pvt/orders/-orderId-/invoice) to know more details.

* Method: POST
* URL: `{marketplaceServiceEndpoint}/api/oms/pvt/orders/{orderId}/invoice`

> Note that the path including `/pvt` is usually called if the notification is meant for an internal VTEX endpoint. If calling external agents, substitute the path for `/pub`.

Request example:

`1

{

2

 "invoiceNumber":"7999972",

3

 "invoiceValue":7450,

4

 "issuanceDate":"2019-02-07T02:00:00.000Z",

5

 "invoiceUrl":"http://www.invoiceu.rl",

6

 "invoiceKey":"799",

7

 "trackingNumber":"9997LUX",

8

 "trackingUrl":"http://www.trackingu.rl",

9

 "courier":"All postal codes",

10

 "items": [

11

 {

12

 "id": "1231",

13

 "price": 7450,

14

 "quantity": 1

15

 }

16

 ]

17

}

`

| Name           | Type             | Mandatory                                                                                | Description                                                                                |
| -------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| invoiceNumber  | String           | Yes                                                                                | Number that identifies the invoice.                                                                                |
| invoiceValue   | String           | Yes                                                                                | Total amount being invoiced in cents. Do not use any decimal separator. For instance, $24.99 should be represented as 2499.                                                                                |
| issuanceDate   | String           | Yes                                                                                | Issuance date of the invoice.                                                                                |
| invoiceUrl     | String           | URL of the invoice. Can be used to send the URL of an XML file, for example, which is useful for some integrations. |                                                                                |
| trackingNumber | String           | No                                                                                | The number code that identifies the order tracking. This field should only be used when sending the tracking information. When the request is used for sending the invoice, this field should be left empty.           |
| trackingUrl    | String           | No                                                                                | The URL used to track the order. This field should only be used when sending the tracking information. When the request is used for sending the invoice, this field should be left empty.                              |
| courier        | String           | No                                                                                | The name of the carrier responsible for delivering the order. This field should only be used when sending the tracking information. When the request is used for sending the invoice, this field should be left empty. |
| items          | Array of objects | Yes                                                                                | Array containing the SKUs that are being invoiced.                                                                                |
| id             | String           | Yes                                                                                | ID of the SKU being invoiced.                                                                                |
| price          | Integer          | Yes                                                                                | Total price of the SKU being invoiced in cents. Do not use any decimal separator. For instance, $24.99 should be represented as 2499.                                                                                |
| quantity       | Integer          | Yes                                                                                | Quantity currently in inventory of the SKU being invoiced.                                                                                |

Response example:

`1

{

2

 "date": "2018-11-21T11:50:09.9994509-02:00",

3

 "orderId": "876053333998-01",

4

 "receipt": "95233cf2078d418ba77155380c18f398"

5

}

`

## Next steps

Checkout the [Change chain orders in external marketplaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces) article to learn how to implement more complex change order scenarios.

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/_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-api-integration/_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/Fulfillment/multilevel-omnichannel-inventory/multilevel-omnichannel-inventory-api-integration.md)

[Multilevel Omnichannel Inventory« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration//docs/guides/multilevel-omnichannel-inventory)[Change chain orders in external marketplacesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration//docs/guides/change-orders-multilevel-omnichannel-inventory-external-marketplaces)

Contributors

2

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

ON THIS PAGE

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

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

[Changes in the order's data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23changes-in-the-orders-data)

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

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

[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23request-example)

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

[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23next-steps)

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-api-integration.md)

Copy page

On this page

ON THIS PAGE

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

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

[Changes in the order's data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23changes-in-the-orders-data)

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

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

[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23request-example)

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

[Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/multilevel-omnichannel-inventory-api-integration/docs/guides/multilevel-omnichannel-inventory-api-integration%23next-steps)

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