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

[User] Provide a guide on guides faststore seo overview in VTEX.

[Assistant]
Documentation

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

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

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

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

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

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

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

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[Configuring SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp)

[Optimizing SEO by managing lazy loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp)

[Validating UTM tracking in FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-validating-utm-tracking-in-faststore)

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

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

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

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

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

---

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[Configuring SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp)

[Optimizing SEO by managing lazy loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp)

[Validating UTM tracking in FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-validating-utm-tracking-in-faststore)

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

SEO

Search Engine Optimization (SEO) is one of the most essential strategies for improving your site's visibility in organic search engine results. Well-optimized pages are more likely to appear in prominent positions on search engines, leading to higher traffic and better conversion rates.

> Learn about best practices for improving your store SEO in the [SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/storefront-seo) guide.

FastStore provides configuration options, such as editable meta tags (title, description, author, and templates), which help search engines understand and index your content. You can define these settings during the [project onboarding](#setting-seo-during-the-project-onboarding) or [updated later](#managing-seo-for-plps-and-pdps) in the `discovery.config.js` file.

## Setting SEO during the project onboarding

When [starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/1-onboarding-starting-the-project), you should configure your website's SEO tags by setting values for the **Title Tag**, **Description Tag**, **Title Template**, and **Site Author**. These tags are part of your site's optimization strategy.

![{"base64":"  ","img":{"width":1618,"height":525,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":33717,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/seo-onboarding-fs___62053a279d984f508761d22b56c03ac7.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/seo-onboarding-fs___62053a279d984f508761d22b56c03ac7.png)

### Default SEO settings

The default SEO values are defined in the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) file of your store. When you configure these settings in WebOps during the onboarding process, this file is automatically updated. Example:

`1

 seo: {

2

 title: 'FastStore Starter',

3

 description: 'Fast Demo Store',

4

 titleTemplate: '%s | FastStore',

5

 author: 'Store Framework',

6

 },

`

## Managing SEO for PLPs and PDPs

After completing the onboarding process, you can update the SEO settings using the [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options). In this file, you can update the title and description templates for both Product Listing Pages (PLPs) and Product Detail Pages (PDPs). For detailed instructions, see the [Configuring SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp) guide.

Additionally, you can improve performance and SEO by controlling lazy loading for custom sections. Learn more in [Optimizing SEO by managing lazy loading on PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-optimizing-seo-by-managing-lazy-loading-on-plp-and-pdp).

Contributors

1

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

Was this helpful?

Yes

No

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

[Improving store performance with Preact« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/managing-performance-improving-store-performance-with-preact)[Configuring SEO for PLPs and PDPsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-configuring-seo-for-plp-and-pdp)

Contributors

1

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

ON THIS PAGE

[Setting SEO during the project onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23setting-seo-during-the-project-onboarding)

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

[Managing SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23managing-seo-for-plps-and-pdps)

Was this helpful?

 Send feedback

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

Copy page

On this page

ON THIS PAGE

[Setting SEO during the project onboarding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23setting-seo-during-the-project-onboarding)

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

[Managing SEO for PLPs and PDPs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/seo-overview/docs/guides/faststore/seo-overview%23managing-seo-for-plps-and-pdps)

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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-guide)

[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-catalog)

[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-prices)

[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-inventory)

[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/import-customer-data)

[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-order-integration)

[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-products)

[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-order-processing)

[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-updating-and-deleting-information)

[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/punchout)

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

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/recaptcha)

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-guide)

[Set up catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-catalog)

[Import prices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-prices)

[Import inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-inventory)

[Import customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/import-customer-data)

[Set up order integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-order-integration)

[Import products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-import-products)

[Set up order processing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-set-up-order-processing)

[Update or delete information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-updating-and-deleting-information)

[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration)

[Customer Credit](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/customer-credit-integration-guide)

[External Marketplace](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/external-marketplace-integration-guide)

[External Seller](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/external-seller-integration-guide)

[Gift Card](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/gift-card-integration-guide)

[Headless commerce](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/headless-commerce)

[Login (SSO)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/login-integration-guide)

[Punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/punchout)

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

[Payments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/payments-integration-guide)

[Search Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/search-integration-guide)

[Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/session-manager)

[Tax Service](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/tax-service-integration-guide)

[Pricing Hub](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/pricing-hub)

[reCAPTCHA](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/recaptcha)

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Integration Guides

[Back office integration guide (ERP/PIM/WMS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/erp-integration-guide)

[FAQ: ERP Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration)

FAQ: ERP Integration

## 1\. How should you treat order cancelations in the integration?

When filtering Feed or Hook events by status, you can monitor events with the status `cancelation-request`. This way, whenever a customer requests cancelation the integration is notified and the store can check if the order is already on its way to the carrier or can still be canceled.

VTEX’s [order flow](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/order-flow-on-the-oms--tutorials%5F196%23) includes a `window-to-cancel`, which is a time period you can set during which the order has not yet gone to handling and the customer may cancel with minimal consequence to the store.

You can also set up your integration to check again and see if the order has been canceled before it goes to shipping. At this point, if it has not been canceled, the store can invoice and ship it.

## 2\. Why doesn't the feed always return all available messages in the queue?

This is because of VTEX’s distributed data structure which allows different processes to run in parallel providing a high-performance system. For performance reasons, we use [Standard Queues at AWS’s Simple Queue Services](https://read.calvincode.net/reader?url=https://aws.amazon.com/pt/sqs/features/).

## 3\. Why does the feed send out duplicate events?

This can happen because of VETX’s distributed data structure which allows different processes to run in parallel providing a high-performance system.

Also, there are cases in which an order can receive the same status twice in regards to different events. Consider, for instance, an order that is split between two sellers of a marketplace. Each seller is going to invoice part of the order, generating two different events with the status `invoiced`. In cases like this, the integration must be prepared to deal with this possibility.

## 4\. Feed or Hook, which should I use?

See our [Feed v3 API guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orders-feed).

## 5\. Order is locked in `Ready for Handling`. What do I do?

Access our this [article on how to solve orders locked in Ready for Handling](https://read.calvincode.net/reader?url=https://help.vtex.com/faq/meus-pedidos-estao-travados-em-pronto-para-manuseio--frequentlyAskedQuestions%5F771%23).

Contributors

1

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

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/Integration-Guides/erp-integration-guide/faq-erp-integration.md)

[Update or delete information« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration//docs/guides/erp-integration-updating-and-deleting-information)[Customer CreditNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration//docs/guides/customer-credit-integration-guide)

Contributors

1

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

ON THIS PAGE

[1\. How should you treat order cancelations in the integration?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%231-how-should-you-treat-order-cancelations-in-the-integration)

[2\. Why doesn't the feed always return all available messages in the queue?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%232-why-doesnt-the-feed-always-return-all-available-messages-in-the-queue)

[3\. Why does the feed send out duplicate events?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%233-why-does-the-feed-send-out-duplicate-events)

[4\. Feed or Hook, which should I use?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%234-feed-or-hook-which-should-i-use)

[5\. Order is locked in Ready for Handling. What do I do?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%235-order-is-locked-in-ready-for-handling-what-do-i-do)

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/Integration-Guides/erp-integration-guide/faq-erp-integration.md)

Copy page

On this page

ON THIS PAGE

[1\. How should you treat order cancelations in the integration?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%231-how-should-you-treat-order-cancelations-in-the-integration)

[2\. Why doesn't the feed always return all available messages in the queue?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%232-why-doesnt-the-feed-always-return-all-available-messages-in-the-queue)

[3\. Why does the feed send out duplicate events?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%233-why-does-the-feed-send-out-duplicate-events)

[4\. Feed or Hook, which should I use?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%234-feed-or-hook-which-should-i-use)

[5\. Order is locked in Ready for Handling. What do I do?](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faq-erp-integration/docs/guides/faq-erp-integration%235-order-is-locked-in-ready-for-handling-what-do-i-do)

On this page

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


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

[User] Provide a guide on guides faststore getting started 4 understanding the project structure in VTEX.

[Assistant]
Documentation

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

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/troubleshooting)

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

Storefront Development

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

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore)

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

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

[1\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-1-setting-up-your-environment)

[2\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-2-starting-the-project)

[3\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-3-running-the-project-locally)

[4\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure)

[5\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)

[6\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-6-next-steps)

[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-glossary)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/developing-and-overriding-components-overview)

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

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/updates/release-notes)

Storefront Development

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

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore)

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

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

[1\. Setting up your environment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-1-setting-up-your-environment)

[2\. Starting a new FastStore project](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-2-starting-the-project)

[3\. Running the project locally](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-3-running-the-project-locally)

[4\. Understanding the project structure](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure)

[5\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)

[6\. Next steps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-6-next-steps)

[Glossary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-glossary)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/headless-cms-overview)

[Developer tools and references](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/developer-tools-overview)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/sdk-overview)

[Developing and overriding UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/developing-and-overriding-components-overview)

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

[Managing URLs with redirects and rewrite paths](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/routing-managing-urls-with-redirects-and-rewrite-paths)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore)

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

4\. Understanding the project structure

Learn how the FastStore project is organized, including its main directories, configurations, and code architecture.

In this step, you'll learn how a FastStore project is organized and why it matters. Understanding the folder layout and key files helps you navigate the codebase, make targeted changes, and avoid misconfigurations as you customize your store.

Here's the structure that represents the source code of a FastStore project:

`1

/

2

|-- /.faststore

3

|-- /src

4

 |-- /themes

5

 |-- custom-theme.scss

6

|-- cypress.config.ts

7

|-- discovery.config.js

8

|-- next-env.d.ts

9

|-- package.json

10

|-- README.md

11

|-- tsconfig.json

12

|-- vercel.json

13

|-- vtex.env

14

|-- yarn.lock

`

## Folders

* `/.faststore` \- Manages and coordinates the FastStore project to deliver a functional starter store. This folder, also known as [@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-overview%23packagejson), provides the core functionality of the FastStore starter.
* `/src` \- Contains all of your store's customizations, including your custom components and theme.
* [/themes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-overview%23available-themes) \- Keeps your store's theme, such as [midnight](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/themes-midnight).

## Files

* `custom-theme.scss` \- Holds the styling information for your store, controlling the graphic elements such as typography, colors, borders, and spacing that give your store with a unique look and feel.
* `cypress.config.ts` \- Configures the options and preferences required for running tests with Cypress.
* [discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options) \- Configures aspects of the project such as SEO preferences, VTEX account options, and theme. Note that these configurations are set during the [onboarding process](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-2-starting-the-project), reducing the need for changes to this file. For more information on configuration options for this file, refer to [Configuration options for discovery.config.js](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/project-structure-config-options).
* `next-env.d.ts` \- Generates a TypeScript definition file for Next.js.
* `tsconfig.json` \- Configures the compiler options and project settings for TypeScript, including target version, module resolution, and source file locations.
* `vtex.env` \- Stores public environment variables that your application can access during runtime. These include flags like `SITE_HOST` (specifying the store's domain in production) and other publicly accessible values, including feature flags, URLs, and Analytics public tracking IDs. For private environment variables such as API keys and database credentials, use [VTEX secrets](https://read.calvincode.net/reader?url=https://v1.faststore.dev/how-to-guides/webops/security/setting-up-secrets).
* `yarn.lock` \- Locks down the exact versions of your project's dependencies, including transitive dependencies, to ensure consistent builds across different machines and environments. This file is automatically generated based on the dependencies in your `package.json` file.

## `package.json`

Defines the project metadata and manages dependencies and scripts with [Yarn](https://read.calvincode.net/reader?url=https://yarnpkg.com/migration/overview). Key packages include:

### `@faststore/core`

Bundles FastStore source code, including the starter store. It contains four sub-packages: `components`, `sdk`, `ui`, and `api`.

### `@faststore/sdk`

Handles all meaningful states an ecommerce store might have, such as:

| SDK states    | Description                                                                    |
| ------------- | ------------------------------------------------------------------------------ |
| **Session**   | Handles auth, region, locale, and currency data.                               |
| **Cart**      | Handles a store cart's addition, remotion, update, and current state.          |
| **Component** | Handles the state of the components of a store (e.g., display/hide mini cart). |
| **Search**    | Handles the state of the faceted search (e.g., apply filters and sort).        |

The SDKs also provide GA4-compatible analytics functions to help you create powerful analytics capabilities in your ecommerce.

### `@faststore/ui`

Provides the design system used by FastStore components, using [Sass](https://read.calvincode.net/reader?url=https://sass-lang.com/) for styling. For more information, refer to the [FastStore UI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/components-index) guide.

> Although the components use [Sass](https://read.calvincode.net/reader?url=https://sass-lang.com/), you can style them using the desired tool for styling.

### `@faststore/api`

Connects your project to your favorite ecommerce provider by creating interfaces for querying products, collections, and handling carts.

### `@faststore/cli`

Provides scripts for building, running, debugging, and deploying your FastStore project. This package helps with debugging and differentiating between VTEX code and customizations. To learn more, refer to the [FastStore CLI documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-3-faststore-cli).

---

## Next step

Now that you understand your project structure, connect it to Headless CMS for content management: [5\. Integrating your project with the Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-5-integrating-with-the-headless-cms)

Contributors

2

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

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

[3\. Running the project locally« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-3-running-the-project-locally)[5\. Integrating your project with the Headless CMSNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-5-integrating-your-project-with-the-headless-cms)

Contributors

2

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

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

ON THIS PAGE

[Folders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23folders)

[Files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23files)

[package.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23packagejson)

[@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststorecore)[@faststore/sdk](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoresdk)[@faststore/ui](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoreui)[@faststore/api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoreapi)[@faststore/cli](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststorecli)

[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23next-step)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/getting-started/4-understanding-the-project-structure.mdx)

Copy page

On this page

ON THIS PAGE

[Folders](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23folders)

[Files](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23files)

[package.json](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23packagejson)

[@faststore/core](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststorecore)[@faststore/sdk](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoresdk)[@faststore/ui](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoreui)[@faststore/api](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststoreapi)[@faststore/cli](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23faststorecli)

[Next step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/getting-started-4-understanding-the-project-structure/docs/guides/faststore/getting-started-4-understanding-the-project-structure%23next-step)

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 managing ssl certificates 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/managing-ssl-certificates/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

[Managing SSL Certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates)

[Implementing Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/implementing-mtls)

[Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/revoking-ssl-private-certificates-when-using-mtls)

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

[Managing SSL Certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates)

[Implementing Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/implementing-mtls)

[Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/revoking-ssl-private-certificates-when-using-mtls)

---

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

---

Weni by VTEX

---

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

VTEX Shield

[Managing SSL Certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates)

Managing SSL certificates

Learn how to manage custom SSL certificates with VTEX Shield.

> This feature is part of [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh). If you're a current VTEX customer and want to adopt VTEX Shield for your business, please contact [Commercial Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/support-at-vtex--4AXsGdGHqExp9ZkiNq9eMy/3KQWGgkPOwbFTPfBxL7YwZ). Additional fees may apply. If you're not a customer yet but are interested in this solution, please complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/en-us/contact/).

VTEX automatically manages SSL certificates for stores by default, but merchants may need to use their own certificates for specific compliance reasons, internal security requirements, or certification entities that offer additional warranties.

To give them a flexible and secure way to upload their certificates to our infrastructure, we offer the [SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api) and the [SSL certificates](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/custom-ssl-certificates--1hoaDEbU50PDZSe6AYep9q) page in the Admin.

This guide explains how to use the API for managing certificates.

The SSL Certificates API allows users to list their custom SSL certificates, get a specific certificate by ID, and install or renew a certificate.

## Before you begin

Make sure you meet the following prerequisites to manage SSL certificates:

* You must have the [Custom SSL certificates](https://read.calvincode.net/reader?url=https://help.vtex.com/tutorial/custom-ssl-certificates--1hoaDEbU50PDZSe6AYep9q) feature from [VTEX Shield](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/vtex-shield--2CVk6H9eY2CBtHjtDI7BFh).
* You must have a user or API key associated with a [role](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) that contains the following [License Manager resources](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/license-manager-resources--3q6ztrC8YynQf6rdc6euk3):
   * **Product:** _CDN API_
   * **Category:** _Certificate management_
   * **Resources:** _Update certificate_ and _View certificate_

## Installing or renewing an SSL certificate

To install a certificate, you can send its information through an [Install or renew SSL certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23put-/api/edge/certificates) `PUT` request, using _multipart/form-data_ or _application/json_. The process of renewing a certificate is the same as the process of installing one.

#### Request example - multipart/form-data

`1

curl --request PUT 'https://{{accountName}}.vtexcommercestable.com.br/api/edge/certificates' \

2

--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \

3

--form 'Hosts="{{MY_HOST}}"' \

4

--form 'Certificate=@"{{CERTIFICATE_PATH}}"' \

5

--form 'PrivateKey=@"{{PRIVATE_KEY_PATH}}"'

`

For the example account `myaccountname` and host `mystore.com`, the request should look like this:

`1

curl --request PUT 'https://myaccountname.vtexcommercestable.com.br/api/edge/certificates' \

2

--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \

3

--form 'Hosts="mystore.com"' \

4

--form 'Certificate=@"/path/to/certificate.crt"' \

5

--form 'PrivateKey=@"/path/to/private.key"'

`

#### Request example - application/json

`1

curl --request PUT 'https://{{accountName}}.vtexcommercestable.com.br/api/edge/certificates' \

2

--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \

3

--header 'Content-Type: application/json' \

4

--data '{

5

 "hosts": ["{{MY_HOST}}"],

6

 "certificate": "{{BASE64_ENCODED_CERTIFICATE}}",

7

 "privateKey": "{{BASE64_ENCODED_PRIVATE_KEY}}"

8

}'

`

For the example account `myaccountname` and host `mystore.com`, the request should look like this:

`1

curl --request PUT 'https://myaccountname.vtexcommercestable.com.br/api/edge/certificates' \

2

--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}' \

3

--header 'Content-Type: application/json' \

4

--data '{

5

 "hosts": ["mystore.com"],

6

 "certificate": "LS0tLS1CRUd...S0tLS0K",

7

 "privateKey": "LS0tLS1CRUd...LS0NCg=="

8

}'

`

### Response example

In both cases, whether installing or renewing a certificate, the response should look like this:

`1

[

2

 {

3

 "id": "3421b2ea-94b1-55ac-67ea-e517018fbatc",

4

 "account": "myaccountname",

5

 "host": "mystore.com",

6

 "serialNumber": "99C468B5853EF5549E40A44526720C71GT",

7

 "subjectDistinguishedName": "CN=mystore.com",

8

 "subjectCommonName": "mystore.com",

9

 "subjectOrganization": null,

10

 "issuerDistinguishedName": "CN=ZeroSSL RSA Domain Secure Site CA, O=ZeroSSL, C=AT",

11

 "issuerCommonName": "ZeroSSL RSA Domain Secure Site CA",

12

 "issuerOrganization": "ZeroSSL",

13

 "installDate": "2025-04-24T20:15:51.7903622Z",

14

 "startDate": "2025-03-20T00:00:00Z",

15

 "expiryDate": "2025-06-18T23:59:59Z",

16

 "signatureAlgorithm": "sha384RSA",

17

 "x509Version": "3",

18

 "installedBy": "22b312e1-f863-43t7-8c59-5n2f9ll0d09x",

19

 "createdAt": "2025-03-20T13:20:34.40938Z",

20

 "updatedAt": "2025-04-24T20:15:51.7903892Z",

21

 "status": "Installing"

22

 }

23

]

`

> Find more details about each field in the [Install or renew SSL certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23put-/api/edge/certificates) `PUT` reference.

## Listing SSL certificates

You can list your certificates with the [List SSL certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23get-/api/edge/certificates) `GET` endpoint, as shown below. Remember to replace the `accountName` and `VtexIdclientAutCookie` placeholders.

### Request example

`1

curl 'https://{{accountName}}.vtexcommercestable.com.br/api/edge/certificates' \

2

--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}'

`

For the example account `myaccountname`, the request should look like this:

`1

curl 'https://myaccountname.vtexcommercestable.com.br/api/edge/certificates' \

2

--header 'VtexIdclientAutCookie: 1234'

`

### Response example

`1

[

2

 {

3

 "id": "8c66122e-85cd-4bff-885d-aa9846e97541",

4

 "account": "myaccountname",

5

 "host": "mystore.com",

6

 "serialNumber": "05C51F848EDBAC18E91D9AE43D8F6728D4F8",

7

 "subjectDistinguishedName": "CN=mystore.com",

8

 "subjectCommonName": "mystore.com",

9

 "subjectOrganization": null,

10

 "issuerDistinguishedName": "CN=R10, O=Let's Encrypt, C=US",

11

 "issuerCommonName": "R10",

12

 "issuerOrganization": "Let's Encrypt",

13

 "installDate": "2025-04-22T16:24:58.768939Z",

14

 "startDate": "2024-08-29T01:43:25Z",

15

 "expiryDate": "2024-11-27T01:43:24Z",

16

 "signatureAlgorithm": "sha256RSA",

17

 "x509Version": "3",

18

 "installedBy": "22b312e1-f863-43t7-8c59-5n2f9ll0d09x",

19

 "createdAt": "2024-10-25T17:51:51.222052Z",

20

 "updatedAt": "2025-04-22T16:24:58.768939Z",

21

 "status": "Active"

22

 }

23

]

`

> Find more details about each field in the [List SSL certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23get-/api/edge/certificates) `GET` reference.

## Getting an SSL certificate by its ID

To get a specific certificate, you can use the [Get SSL certificate by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23get-/api/edge/certificates/-certificateId-) `GET` request. Remember to replace the `accountName` and `VtexIdclientAutCookie` placeholders.

### Request example

`1

curl 'https://{{accountName}}.vtexcommercestable.com.br/api/edge/certificates/{{certificateId}}' \

2

--header 'VtexIdclientAutCookie: {{VtexIdclientAutCookie}}'

`

For the example account `myaccountname` and certificate ID `8c66122e-85cd-4bff-885d-aa9846e97541`, the request should look like this:

`1

curl 'https://myaccountname.vtexcommercestable.com.br/api/edge/certificates/8c66122e-85cd-4bff-885d-aa9846e97541' \

2

--header 'VtexIdclientAutCookie: 1234'

`

### Response example

`1

{

2

 "id": "8c66122e-85cd-4bff-885d-aa9846e97541",

3

 "account": "myaccountname",

4

 "host": "mystore.com",

5

 "serialNumber": "05C51F848EDBAC18E91D9AE43D8F6728D4F8",

6

 "subjectDistinguishedName": "CN=mystore.com",

7

 "subjectCommonName": "mystore.com",

8

 "subjectOrganization": null,

9

 "issuerDistinguishedName": "CN=R10, O=Let's Encrypt, C=US",

10

 "issuerCommonName": "R10",

11

 "issuerOrganization": "Let's Encrypt",

12

 "installDate": "2025-04-22T16:24:58.768939Z",

13

 "startDate": "2024-08-29T01:43:25Z",

14

 "expiryDate": "2024-11-27T01:43:24Z",

15

 "signatureAlgorithm": "sha256RSA",

16

 "x509Version": "3",

17

 "installedBy": "22b312e1-f863-43t7-8c59-5n2f9ll0d09x",

18

 "createdAt": "2024-10-25T17:51:51.222052Z",

19

 "updatedAt": "2025-04-22T16:24:58.768939Z",

20

 "status": "Active"

21

}

`

> Find more details about each field in the [Get SSL certificate by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/ssl-certificates-api%23get-/api/edge/certificates/-certificateId-) `GET` reference.

Contributors

2

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

[Sessions System Overview« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates//docs/guides/sessions-system-overview)[Implementing Mutual Transport Layer Security (mTLS)Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates//docs/guides/implementing-mtls)

Contributors

2

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/_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/managing-ssl-certificates/_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/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23before-you-begin)

[Installing or renewing an SSL certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23installing-or-renewing-an-ssl-certificate)

[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)

[Listing SSL certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23listing-ssl-certificates)

[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)

[Getting an SSL certificate by its ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23getting-an-ssl-certificate-by-its-id)

[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)

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 Shield/managing-ssl-certificates.md)

Copy page

On this page

ON THIS PAGE

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

[Installing or renewing an SSL certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23installing-or-renewing-an-ssl-certificate)

[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)

[Listing SSL certificates](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23listing-ssl-certificates)

[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)

[Getting an SSL certificate by its ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23getting-an-ssl-certificate-by-its-id)

[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23request-example)[Response example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/managing-ssl-certificates/docs/guides/managing-ssl-certificates%23response-example)

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