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

[User] Explain troubleshooting i am getting errors with my service configuration app 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/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/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/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/updates/release-notes)

Troubleshooting

API

---

Development

[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/unable-to-access-headless-cms)

[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/updates/release-notes)

Troubleshooting

API

---

Development

[I am getting 500 errors in VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

[I am getting errors with my service configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[Issues during extending the FastStore API schema](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

[I can’t access the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/unable-to-access-headless-cms)

[I can’t install the Headless CMS plugins in my account](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-install-the-headless-cms-plugins-in-my-account)

[I can't install VTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-install-vtex-io-cli)

[I can’t integrate my external Search Provider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-integrate-my-external-search-provider)

[My multi-language store is not functioning in the development workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/my-multi-language-store-is-not-working-in-the-development-workspace)

[My store catalog does not display the price range filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/my-store-catalog-does-not-show-the-price-range-filter)

[My pages are taking too long to be published on Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/my-pages-are-taking-too-long-to-be-published-on-headless-cms)

[My store does not reflect the overrides I created](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/my-store-does-not-reflect-the-overrides-i-created)

[Modal Layout closes when I click a SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/modal-layout-closes-when-i-click-a-sku)

[The Price in the shelf or in the search results is different from the product page](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/the-price-in-the-shelf-or-in-the-search-results-is-different-from-the-product-page)

[The promotion highlight flag does not appear on the product](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/the-promotion-highlight-flag-does-not-appear-on-the-product)

[vtex release CLI command returns an EBADF message](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/vtex-release-cli-command-returns-ebadf-message)

[I can't create a new workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-create-a-new-workspace)

[I can't install an app with a major other than 0.x](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-cant-install-an-app-with-a-major-other-than-0x)

[I don't see my Store Theme changes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-dont-see-my-store-theme-changes)

---

Store performance

---

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting)

Development

I am getting errors with my service configuration app

Errors with the service configuration app occur depending on your workspace configuration

If you are [developing a configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-developing-service-configuration-apps), you may be getting errors because the service your app is configuring is installed or linked to a different workspace. This happens because, when creating a new configuration app, the configuration builder first looks for that configuration schema in all the apps installed in your current workspace. Consequently, linking your app may fail if the configuration builder cannot find this specific configuration.

## Solution

Below, we outline solutions for addressing errors with your service configuration app:

1. [Avoid errors when installing or linking your configuration app](#avoiding-errors-when-installing-or-linking-your-configuration-app).
2. [Publish your configuration app in an alternative workspace](#publishing-your-configuration-app-in-an-alternative-workspace).

### Avoiding errors when installing or linking your configuration app

To avoid errors, link or install the configuration app in the same workspace the service app is linked or installed. Follow the instructions below:

1. In a terminal, go to the desired workspace using the following VTEX IO CLI command:
`1
vtex use workspace {desiredWorkspace}
`
> Replace {desiredWorkspace} with the workspace you want to work in.
2. If your service app is not yet linked or installed, [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) or [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) your service app.
3. [Link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) or [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) your configuration app.

### Publishing your configuration app in an alternative workspace

To publish your configuration app without installing the service in the master workspace, follow the instructions below:

1. In a terminal, go to the desired workspace using the following VTEX IO CLI command:
`1
vtex use workspace {desiredWorkspace}
`
Replace `{desiredWorkspace}` with the workspace you want to work in.
2. If your service app is not yet linked or installed, [link](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-linking-an-app) or [install](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-an-app) your service app.
3. Create a new version of your configuration app by following the instructions in [Releasing a new app version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-releasing-a-new-app-version).
4. [Publish](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-publishing-an-app) your configuration app using the following command:
`1
vtex publish -w {desiredWorkspace}
`
The `-w` flag allows you to choose the workspace of the app you are publishing.

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/_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/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md)

[I am getting 500 errors in VTEX IO CLI« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)[Issues during extending the FastStore API schemaNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/issues-during-extending-the-faststore-api-schema)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/_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/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F7026595%3Fv%3D4%26w=64%26q=75)](https://github.com/henriquessb)

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23solution)

[Avoiding errors when installing or linking your configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23avoiding-errors-when-installing-or-linking-your-configuration-app)[Publishing your configuration app in an alternative workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23publishing-your-configuration-app-in-an-alternative-workspace)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/development/i-am-getting-errors-with-my-service-configuration-app.md)

Copy page

On this page

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23solution)

[Avoiding errors when installing or linking your configuration app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23avoiding-errors-when-installing-or-linking-your-configuration-app)[Publishing your configuration app in an alternative workspace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app%23publishing-your-configuration-app-in-an-alternative-workspace)

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

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

App Development

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

---

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

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients)

[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-how-to-create-and-use-clients)

[Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)

[Using Clients in Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/using-node-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/node-builder-7x-migration-guide)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

App Development

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

---

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

[Services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-service)

[Calling commerce APIs on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/calling-commerce-apis-on-vtex-io)

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients)

[Developing custom Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-how-to-create-and-use-clients)

[Connecting to VTEX Core Commerce APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/how-to-connect-with-vtex-core-commerce-apis-using-vtex-io)

[Using Clients in Node apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/using-node-clients)

Handling events

[Path patterns](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/service-path-patterns)

[Configuring dynamic routes in VTEX IO services](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/configuring-dynamic-routes-in-vtex-io-services)

[Developing service configuration apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-developing-service-configuration-apps)

[Node builder 7.x migration guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/node-builder-7x-migration-guide)

---

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

---

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

---

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

---

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

---

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

---

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

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

[Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients)

Clients

Learn more about VTEX IO Clients and their advantages.

Clients serve as intermediaries that initiate and maintain interactions with both external and internal services. Whether interfacing with VTEX IO Services, VTEX Core Commerce APIs, or external APIs, Clients are crucial in enabling seamless communication and data exchange. This guide will explore the concept of Clients and provide a list of native Clients available in VTEX IO.

## Understanding Clients

Clients are essentially configurations implemented within the VTEX IO platform to abstract and streamline communication with various services. They simplify the process of sending requests and receiving responses, acting as intermediaries between an app and the other services it relies on.

In simpler terms, think of Clients as the messengers of an app, responsible for reaching out to other services, gathering information, and returning it to your application.

## Advantages of using Clients

Clients offer various advantages when it comes to managing interactions and data exchange between your app and other services. They ensure that your app functions effectively by handling the complexity of communication with other services.

When developing VTEX IO apps, using Clients can help you manage and streamline complexity. Clients centralize communication logic, making it easier to maintain and scale your codebase. VTEX IO Clients come equipped with several built-in features that enhance the functionality and performance of your applications:

* **Cache:** Clients incorporate caching mechanisms to store and retrieve data efficiently, reducing the load on services and improving response times.
* **Native metrics support:** Clients integrate with performance monitoring and analytics tools, providing insights into service usage and performance.
* **Retry and timeout options:** Clients offer configurable retry and timeout settings, ensuring robustness and resilience in the face of network issues or service unavailability.
* **Billing tracking:** Clients can track usage and resource consumption, aiding in billing and cost optimization.

## List of native Clients

VTEX offers some native Clients, allowing developers to save time and effort when interacting with services such as VTEX Core Commerce APIs and other internal services.

### `@vtex/clients`

The [@vtex/clients](https://read.calvincode.net/reader?url=https://github.com/vtex/io-clients) package provides the following clients for IO apps using the `node` Builder:

| Client           | Description                                                                   | Methods                                                                                |
| ---------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- |
| affiliate        | Handles affiliate-related operations.                                         | registerAffiliate, changeNotification, createSeller, getSellerList                                                                           |
| catalog          | Handles catalog-related tasks such as retrieving product and SKU information. | getProductsAndSkus, getSkuById, changeNotification, createSeller, getSellerList, getSellerById, getSkuContext, getCategoryById, getBrandById |
| checkout         | Deals with order form configurations and custom Checkout data.                | getOrderFormConfiguration, setOrderFormConfiguration, setSingleCustomData                                                                    |
| logistics        | Manages logistics and inventory-related tasks.                                | getDockById, pickupById, listPickupPoints, nearPickupPoints, shipping, listInventoryBySku                                                    |
| OMS              | Handles order management operations.                                          | listOrders, userLastOrder, order, orderNotification, cancelOrder                                                                             |
| omsApiProxy      | Acts as a proxy for OMS API operations.                                       | orders, orderFormId, customData, register                                                                                |
| ratesAndBenefits | Handles Rates and Benefits data.                                              | getAllBenefits, getPromotionById, createOrUpdatePromotion, createMultipleSkuPromotion, updateMultipleSkuPromotion                            |
| suggestions      | Handles product suggestions and versions.                                     | getAllSuggestions, getSuggestionById, sendSkuSuggestion, deleteSkuSuggestion, getAllVersions, getVersionById                                 |

| Factory    | Description                          | Methods                                                                                |
| ---------- | ------------------------------------ | --------------------------------------------------------------------------------------- |
| masterData | Interacts with Master Data services. | get, save, update, saveOrUpdate, saveOrUpdatePartial, delete, search, searchRaw, scroll |
| vbase      | Interacts with VBase services.       | get, getRaw, getWithMetadata, save, trySaveIfhashMatches                                |

### `@vtex/api`

The [@vtex/api](https://read.calvincode.net/reader?url=https://github.com/vtex/node-vtex-api/blob/master/src/clients/IOClients.ts%23L15) package provides the following clients for IO apps using the `node` Builder:

| Name            | Description                                                 | Methods                                                                                |
| --------------- | ----------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| id              | Handles identity management and authentication.             | getTemporaryToken, sendCodeToEmail, getEmailCodeAuthenticationToken, getPasswordAuthenticationToken                                                                                |
| licenseManager  | Interacts with License Manager services.                    | getAccountData, getTopbarData, canAccessResource                                                                                |
| masterdata      | Interacts with Master Data services.                        | getSchema, createOrUpdateSchema, getPublicSchema, getDocument, createDocument, createOrUpdateEntireDocument, createOrUpdatePartialDocument, updateEntireDocument, updatePartialDocument, searchDocuments, searchDocumentsWithPaginationInfo, scrollDocuments, deleteDocument |
| messagesGraphQL | Handles internationalization messages.                      | translateV2, translate, translateWithDependencies, saveV2, userTranslations                                                                                |
| catalogGraphQL  | Interacts with the catalog management system using GraphQL. | sku, category, brand, product                                                                                |
| paymentProvider | Interacts with payment service providers.                   | callback, inbound                                                                                |

## Developing Clients

Consider developing your own clients if you require integration with other services not covered by VTEX native clients. Custom clients extend VTEX IO native Clients, leveraging caching and versioning functionalities.

> Note that direct communication with APIs is generally discouraged in favor of implementing a dedicated Client.

Learn how to create Clients of your own by accessing the [Developing Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-how-to-create-and-use-clients) guide.

Contributors

1

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

[Calling Commerce APIs - Conclusion« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients//docs/guides/calling-commerce-apis-conclusion)[Developing custom ClientsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients//docs/guides/vtex-io-documentation-how-to-create-and-use-clients)

Contributors

1

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

ON THIS PAGE

[Understanding Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23understanding-clients)

[Advantages of using Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23advantages-of-using-clients)

[List of native Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23list-of-native-clients)

[@vtex/clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23vtexclients)[@vtex/api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23vtexapi)

[Developing Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23developing-clients)

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-clients.md)

Copy page

On this page

ON THIS PAGE

[Understanding Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23understanding-clients)

[Advantages of using Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23advantages-of-using-clients)

[List of native Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23list-of-native-clients)

[@vtex/clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23vtexclients)[@vtex/api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23vtexapi)

[Developing Clients](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-clients/docs/guides/vtex-io-documentation-clients%23developing-clients)

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 store components productname in VTEX.

[Assistant]
Documentation

[Feedback](https://read.calvincode.net/reader?url=https://docs.google.com/forms/d/e/1FAIpQLSfmnotPvPjw-SjiE7lt2Nt3RQgNUe10ixXZmuO2v9enOJReoQ/viewform?entry.1972292648=developers.vtex.com%26entry.1799503232=)

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/guides)

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

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

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

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

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

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

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

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

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

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

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

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

---

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

Product Name

The `product-name` block is responsible for displaying a product name along with other information about the product, such as the **SKU** or **brand**.

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

## Configuration

1. Import the `vtex.store-components` app to your theme's dependencies in the `manifest.json` file, as in the following example:

`1

 "dependencies": {

2

 "vtex.store-components": "3.x"

3

 }

`

1. Add the `product-name` block to any child of the `store.product` template (Product Details Page template). For example:

`1

 "store.product": {

2

 "children": [

3

 "flex-layout.row#product",

4

 ]

5

 },

6

 "flex-layout.row#product": {

7

 "children": [

8

+ "product-name"

9

 ]

10

 },

`

1. Then, declare the `product-name` block using the props stated in the [Props](#props) table. For example:

`1

 "product-name": {

2

 "props": {

3

 "showSku": true,

4

 "showBrandName": true

5

 }

6

 },

`

### Props

| Prop name            | Type             | Description                                                                                | Default value |
| -------------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| classes              | CustomCSSClasses | Overrides default CSS handles. For further information, please refer to [this document](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/css-handles%23usecustomclasses). Note that this is only helpful if you're using this block as a React component. | undefined     |
| displayMode          | enum             | Displays the product name (plainText) or the link to the product page (linkToProductPage).                                                                                | plainText     |
| showBrandName        | boolean          | Displays the brand name.                                                                                | false         |
| showProductReference | boolean          | Displays the product reference code.                                                                                | false         |
| showSku              | boolean          | Displays the SKU value.                                                                                | false         |
| tag                  | string           | Defines the HTML tag of the product container. Possible values are: div, h1, h2, h3.                                                                                | div           |

## Customization

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

| CSS Handles            |
| ---------------------- |
| productBrand           |
| productNameBrandLoader |
| productNameContainer   |
| productNameLoader      |
| productNameSkuLoader   |
| productReference       |
| productSku             |

Contributors

1

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

Was this helpful?

Yes

No

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

Contributors

1

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

ON THIS PAGE

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

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/guides/vtex-store-components-productname%23props)

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

Was this helpful?

 Send feedback

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

Copy page

On this page

ON THIS PAGE

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

[Props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-store-components-productname/docs/guides/vtex-store-components-productname%23props)

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

On this page

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


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

[User] Provide a guide on guides how to keep attachments from original orders in subscriptions 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/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/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/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/vtex-io-apps)

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

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/master-data)

---

Payments

---

Orders

[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/orders-feed)

[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/order-modifications)

[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/change-seller)

[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/order-canceling-improvements)

[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/actions-orders)

Subscriptions

[Enabling Manual Prices for Subscriptions v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/enabling-manual-prices-for-subscriptions-v3)

[How to keep attachments from original orders in subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions)

---

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/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/master-data)

---

Payments

---

Orders

[Feed v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/orders-feed)

[Order modifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/order-modifications)

[Change seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/change-seller)

[Cancel order](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/order-canceling-improvements)

[Actions in orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/actions-orders)

Subscriptions

[Enabling Manual Prices for Subscriptions v3](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/enabling-manual-prices-for-subscriptions-v3)

[How to keep attachments from original orders in subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions)

---

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/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides)

Orders

Subscriptions

[How to keep attachments from original orders in subscriptions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions)

How to keep attachments from original orders in subscriptions

[Subscriptions](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-subscriptions-work--frequentlyAskedQuestions%5F4453) is the VTEX solution for customers who want to make recurring purchases at the store on a regular schedule. When customers subscribe, they define what products they want to acquire regularly and at the frequency they want these automatic orders to be created.

When a new subscription is created from an order containing SKUs with [attachments](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-an-attachment--aGICk0RVbqKg6GYmQcWUm), the platform default behavior is to discard the attachments in future subscription orders. However, you can configure the store to incorporate SKU attachments from the original order into recurring orders.

## Configuring the store to keep attachments from original orders

To allow a VTEX store to keep SKU attachments for subscription orders, use the [Edit subscriptions settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/settings) endpoint. Within the request body, in the `attachmentPreferences` object, set the `enableAttachments` field as `true`, as shown below:

`1

"attachmentPreferences": {

2

 "enableAttachments": true

3

 }

`

> Whether an order contains the [same SKU with or without attachments](#original-orders-containing-the-same-skus-with-different-attachments), keep in mind that the platform's default behavior is to group these SKUs. You can configure the platform to [split the same SKUs with attachments](#configuring-to-split-the-same-skus-with-different-attachments) instead.

## Original orders containing the same SKUs with different attachments

The platform’s default behavior when keeping attachments from original orders is to group the same SKUs, regardless of whether they have attachments.

The table below shows how the SKU grouping works:

| **Original order**                                                                                | **Subscription order grouping different attachments for the same SKU**                                                                                | **Behavior**                                                                                |
| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------- |
| Total: 8 items\[1\] SKU X - Attachment A: Type IQuantity: 2\[2\] SKU X - Attachment A: Type IIQuantity: 3\[3\] SKU X - No attachmentQuantity: 1\[4\] SKU X - No attachmentQuantity: 1\[5\] SKU Y - No attachmentQuantity: 1 | Total: 8 items\[1\] SKU X - Attachment A: Type I + SKU X - Attachment A: Type II + SKU X - No attachmentQuantity: 7\[2\] SKU Y - No attachmentQuantity: 1 | When the original order has the same SKUs, with and without attachments, the subscription order groups them together. |

You can change this behavior so that subscription orders created from original orders containing the same SKUs with different attachments are not grouped together but kept separate.

The table below shows how that works:

| **Original order**                                                                                | **Subscription orders splitting the same SKUs with different attachments**                                                                                | **Behavior**                                                                                |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Total: 8 items\[1\] SKU X - Attachment A: Type IQuantity: 2\[2\] SKU X - Attachment A: Type IIQuantity: 3\[3\] SKU X - No attachmentQuantity: 1\[4\] SKU X - No attachmentQuantity: 1\[5\] SKU YQuantity: 1 | Total: 8 items\[1\] SKU X - Attachment A: Type IQuantity: 2\[2\] SKU X - Attachment A: Type IIQuantity: 3\[3\] SKU X - No attachmentQuantity: 2\[4\] SKU Y - No attachmentQuantity: 1 | The organization from the original order is kept for subscription orders, and the same SKUs with attachments are no longer grouped, not even if they have the same type of attachment. Only SKUs that do not have attachments will be grouped. |

## Configuring to split the same SKUs with different attachments

To allow a VTEX store to keep SKU attachments for new subscriptions, use the [Edit subscriptions settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/subscriptions-api-v3%23post-/api/rns/settings) endpoint. In the request body, inside the property `attachmentPreferences`, set the `enableAttachments` field to `true`, as shown below:

`1

"attachmentPreferences": {

2

 "enableAttachments": true,

3

 "splitSameSkuWithDifferentAttachments": true

4

 }

`

> The `splitSameSkuWithDifferentAttachments` field can only be set to `true` if the `enableAttachments` field is also set to `true`.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/_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/Subscriptions/how-to-keep-attachments-from-original-orders-in-subscriptions.md)

[Enabling Manual Prices for Subscriptions v3« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions//docs/guides/enabling-manual-prices-for-subscriptions-v3)[VTEX Shipping NetworkNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions//docs/guides/vtex-shipping-network)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/_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

[Configuring the store to keep attachments from original orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23configuring-the-store-to-keep-attachments-from-original-orders)

[Original orders containing the same SKUs with different attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23original-orders-containing-the-same-skus-with-different-attachments)

[Configuring to split the same SKUs with different attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23configuring-to-split-the-same-skus-with-different-attachments)

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/Subscriptions/how-to-keep-attachments-from-original-orders-in-subscriptions.md)

Copy page

On this page

ON THIS PAGE

[Configuring the store to keep attachments from original orders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23configuring-the-store-to-keep-attachments-from-original-orders)

[Original orders containing the same SKUs with different attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23original-orders-containing-the-same-skus-with-different-attachments)

[Configuring to split the same SKUs with different attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions/docs/guides/how-to-keep-attachments-from-original-orders-in-subscriptions%23configuring-to-split-the-same-skus-with-different-attachments)

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