[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 revoking ssl private certificates when using mtls 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/revoking-ssl-private-certificates-when-using-mtls/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/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/revoking-ssl-private-certificates-when-using-mtls/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

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

[Implementing Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/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/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls)

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/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/revoking-ssl-private-certificates-when-using-mtls/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

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

[Implementing Mutual Transport Layer Security (mTLS)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/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/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls)

---

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

---

Weni by VTEX

---

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

VTEX Shield

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

Revoking SSL private certificates when using Mutual Transport Layer Security (mTLS)

Learn how to revoke SSL private certificates in VTEX when using mTLS, including how to extract the serial number and use the API to revoke compromised or unused certificates.

> 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 already a VTEX client and would like to adopt VTEX Shield for your business, contact our [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 yet a VTEX client but are interested in this solution, complete our [contact form](https://read.calvincode.net/reader?url=https://vtex.com/us-en/contact/).

For security reasons, when using [mTLS](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/mutual-transport-layer-security-mtls--6YR3SoynJMfeEKGlY1Cqlo), you may need to revoke previously issued certificates if they're compromised or no longer needed. VTEX provides a `DELETE` [Revoke certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/mtls-api%23delete-/api/edge/private-certificates/-serialNumber-) endpoint, which allows you to revoke a certificate using its serial number.

This guide provides step-by-step instructions for revoking certificates using this endpoint.

## Step 1 - Getting the certificate serial number

To revoke a certificate, you first need to retrieve its serial number, which uniquely identifies the certificate issued by VTEX’s Certificate Authority. This information is embedded in the certificate (`.crt`) file and can be extracted using OpenSSL.

There are two ways to extract the serial number, depending on how you intend to format the value in the revocation request. The VTEX API accepts both formats.

### Method 1 - Hex string without colons

Open a terminal and use the command below to extract the serial number in a plain hexadecimal format:

`1

openssl x509 -noout -serial -in yourcertificate.crt | sed 's/serial=//'

`

Example output:

`1

4D0A0A39360B2E1254DDB6CE57DBC940

`

### Method 2 – Colon-separated hexadecimal format

Alternatively, you can use the command below to extract the serial number with colon separators:

`1

openssl x509 -in yourcertificate.crt -noout -text | grep "Serial Number" -A1 | tail -n 1

`

Example output:

`1

4d:0a:0a:39:36:0b:2e:12:54:dd:b6:ce:57:db:c9:40

`

## Step 2 - Revoking the certificate

Send a revocation request to the `DELETE` [Revoke certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/mtls-api%23delete-/api/edge/private-certificates/-serialNumber-) endpoint, including the certificate's serial number in the URL. Both serial number formats shown in the [Step 1 - Getting the certificate serial number](#step-1-getting-the-certificate-serial-number) section are accepted.

### Required permission

The user or application must have the following License Manager resource to make this call. Otherwise, a 403 status code error will be returned.

| Product | Category               | Resource           |
| ------- | ---------------------- | ------------------ |
| CDN API | Certificate management | Update certificate |

There are no predefined roles for these resources. To use this endpoint, you must create a custom role and add the above resource. Learn more about platform resources and roles in the [Roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc) documentation.

### Request example

Using an authentication cookie:

`1

curl --location --request DELETE 'https://{{account}}.vtexcommercestable.com.br/api/edge/private-certificates/{{serialNumber}}' \

2

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

`

Using API keys:

`1

curl --location --request DELETE 'https://mystore.vtexcommercestable.com.br/api/edge/private-certificates/4D0A0A39360B2E1254DDB6CE57DBC940' \

2

--header 'X-VTEX-API-AppKey: appKey' \

3

--header 'X-VTEX-API-AppToken: appToken'

`

> Learn more in the `DELETE` [Revoke certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/mtls-api%23delete-/api/edge/private-certificates/-serialNumber-) API reference.

Contributors

1

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

[Implementing Mutual Transport Layer Security (mTLS)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls//docs/guides/implementing-mtls)[Data Protection PlusNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls//docs/guides/data-protection-plus)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/_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

[Step 1 - Getting the certificate serial number](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23step-1-getting-the-certificate-serial-number)

[Method 1 - Hex string without colons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23method-1-hex-string-without-colons)[Method 2 – Colon-separated hexadecimal format](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23method-2--colon-separated-hexadecimal-format)

[Step 2 - Revoking the certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23step-2-revoking-the-certificate)

[Required permission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23required-permission)[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23request-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/revoking-ssl-private-certificates-when-using-mtls.md)

Copy page

On this page

ON THIS PAGE

[Step 1 - Getting the certificate serial number](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23step-1-getting-the-certificate-serial-number)

[Method 1 - Hex string without colons](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23method-1-hex-string-without-colons)[Method 2 – Colon-separated hexadecimal format](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23method-2--colon-separated-hexadecimal-format)

[Step 2 - Revoking the certificate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23step-2-revoking-the-certificate)

[Required permission](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23required-permission)[Request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/revoking-ssl-private-certificates-when-using-mtls/docs/guides/revoking-ssl-private-certificates-when-using-mtls%23request-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=)


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

[User] How do I use the VTEX store image app? Provide documentation and configuration details.

[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/apps/vtex.store-image/docs/guides)

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

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

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

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

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

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/basic-components)

[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.add-to-cart-button)

[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search/Autocomplete)

[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search/banner)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.breadcrumb)

[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.store-footer)

[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/google-one-tap-login)

[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.store-header)

[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.locale-switcher)

[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.login)

[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.menu)

[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.minicart)

[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.order-placed)

[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-customizer)

[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-highlights)

[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-identifier)

[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-list)

[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-price)

[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-quantity)

[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-specifications)

[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary)

[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryattachmentlist)

[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummarybuybutton)

[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummarydescription)

[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryimage)

[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummarylist)

[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryname)

[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryshelf)

[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryskuselector)

[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryskuname)

[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.rich-text)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search)

[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search/suggestions)

[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search/didyoumean)

[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search-result)

[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.store-image)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.my-account)

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/basic-components)

[Add To Cart Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.add-to-cart-button)

[Autocomplete](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search/Autocomplete)

[Banner](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search/banner)

[Breadcrumb](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.breadcrumb)

[Footer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.store-footer)

[Google One-Tap Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/google-one-tap-login)

[Header](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.store-header)

[Locale Switcher](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.locale-switcher)

[Login](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.login)

[Menu](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.menu)

[Minicart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.minicart)

[Order Placed](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.order-placed)

[Product Customizer](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-customizer)

[Product Highlights](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-highlights)

[Product Identifier](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-identifier)

[Product List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-list)

[Product Price](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-price)

[Product Quantity](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-quantity)

[Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-specifications)

[Product Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary)

[Product Summary Attachment List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryattachmentlist)

[Product Summary Buy Button](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummarybuybutton)

[Product Summary Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummarydescription)

[Product Summary Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryimage)

[Product Summary List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummarylist)

[Product Summary Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryname)

[Product Summary Shelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryshelf)

[Product Summary SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryskuselector)

[Product Summary SKU Name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.product-summary/productsummaryskuname)

[Rich Text](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.rich-text)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search)

[Suggestions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search/suggestions)

[DidYouMean](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search/didyoumean)

[Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search-result)

[Store Image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.store-image)

---

[Store Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/store-components)

---

[Advanced components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/advanced-components)

---

[B2B components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/b2b-components)

---

[B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.b2b-suite)

---

[Functional Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/functional-apps)

---

[Layout Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/layout-apps)

---

[Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/pixel-apps)

---

[My Account - StoreV2 version](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.my-account)

---

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

---

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

[Basic components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/basic-components)

Store Image

Official extension

Version: 0.23.1

Latest version: 0.23.1

[![{"base64":"  ","img":{"width":110,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/all_contributors-0-orange.svg?style=flat-square)](#contributors-)

The Store Image app exports the `list-context.image-list` block, which is responsible for the image content in the store theme.

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

## Configuring the store image

1. Add the `store-image` app to your theme dependencies in the `manifest.json`. For example:

`1

 "dependencies ": {

2

+ "vtex.store-image": "0.x"

3

 }

`

You can now use the `list-context.image-list` block exported by the Store Image app. This block allows you to display images in your store with more composability since you can use it along with other `list-context` blocks to create a more flexible and customizable image slider.

1. In any desired theme template, add the `list-context.image-list` block, declaring the `slider-layout` as a child block. For example:

`1

 "list-context.image-list#demo": {

2

 "children": ["slider-layout#demo-images"],

3

 "props": {

4

 "preload": true,

5

 "height": 650,

6

 "images": [

7

 {

8

 "loading": "eager",

9

 "image": "https://storecomponents.vteximg.com.br/arquivos/banner-infocard2.png",

10

 "description": "something something"

11

 },

12

 {

13

 "loading": "lazy",

14

 "image": "https://storecomponents.vteximg.com.br/assets/vtex.file-manager-graphql/images/Group%207%20(1)%20(1)%20(1)%20(1)%20(1)___c6b3ed853fb16a08b265753b50e0c57a.png",

15

 "description": "something something"

16

 }

17

 ]

18

 }

19

 },

20

21

 "slider-layout#demo-images": {

22

 "props": {

23

 "itemsPerPage": {

24

 "desktop": 1,

25

 "tablet": 1,

26

 "phone": 1

27

 },

28

 "infinite": true

29

 }

30

 },

`

Note that the `slider-layout` block exported from the Slider Layout app is a child block of `list-context.image-list`. It defines which images will be displayed and their behavior when rendered.

### `list-context.image-list` props

| Prop name                         | Type    | Description                                                                                | Default value |
| --------------------------------- | ------- | ----------------------------------------------------------------------------------------------------------- | ------------- |
| images                            | array   | Array of objects that declares all the images to be rendered.                                               | undefined     |
| height                            | number  | Image height for all images declared in the image object (in px).                                           | undefined     |
| preload                           | boolean | Preloads the first image in a list, prioritizing the image display over other assets.                       | false         |
| experimentalSetExplicitDimensions | boolean | Sets explicit width and/or height attributes for an image, if width and/or height props are provided in px. |               |

### `image-list` props

| Prop name                      | Type    | Description                                                                                | Default value |
| ------------------------------ | ------- | --------------------------------------------------------------------------------------------------------------- | ------------- |
| images                         | array   | Array of objects that declares all the images to be rendered.                                                   | undefined     |
| height                         | number  | Image height for all images declared in the image object (in px).                                               | undefined     |
| experimentalPreventLayoutShift | boolean | Wraps the image in a <span> tag with a preset width and/or height to minimize layout shift during page loading. |               |

* **`images` array:**

| Prop name            | Type            | Description                                                                                | Default value |
| -------------------- | --------------- | ----------------------------------------------------------------------------------------------- | ------------- |
| image                | string          | Image URL.                                                                                | undefined     |
| mobileImage          | string          | Mobile image URL.                                                                               | undefined     |
| description          | string          | Image description.                                                                              | undefined     |
| link                 | object          | Links a URL to the image being rendered.                                                        | undefined     |
| width                | string / number | Image width (in % or px).                                                                       | 100%          |
| loading              | string          | Loading strategy, either when the page loads ('eager') or when closer to the viewport ('lazy'). | 'eager'       |
| fetchpriority        | string          | The fetch priority hint ('high', 'low', or 'auto').                                             | 'auto'        |
| analyticsProperties  | string          | Whether analytics props should be set ('provided') or not ('none').                             | 'none'        |
| promotionId          | string          | The ID of the promotion associated with the event.                                              | undefined     |
| promotionName        | string          | The name of the promotion associated with the event.                                            | undefined     |
| promotionPosition    | string          | The name of the promotional creative slot associated with the event.                            | undefined     |
| promotionProductId   | string          | The ID of the product associated with the event.                                                | undefined     |
| promotionProductName | string          | The name of the product associated with the event.                                              | undefined     |

* **`link` object:**

| Prop name  | Type    | Description                                                                                | Default value |
| ---------- | ------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| url        | string  | URL users will be redirected to when they click the image.                                                                                | undefined     |
| noFollow   | boolean | Whether the page owner endorses the linked URL the user was navigating on, i.e., if there is a business relationship between both pages (true) or (false). | false         |
| openNewTab | string  | Whether a new tab will be opened on the browser (true) or (false).                                                                                | undefined     |
| title      | string  | Text label used to identify the image in the Admin Site Editor.                                                                                | undefined     |

> Use the **Admin Site Editor** to manage all images declared in the `list-context.image-list` block.

## Customization

The block does not have CSS handles for specific customization.

All CSS handles available for the Image block are available for the `slider-layout` block. Take a look at the Customization section in the [**Slider Layout documentation**](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout). Note that the `image-slider` uses our `vtex.slider-layout` app, so all the CSS namespaces defined by it are also available for `image-slider`. Learn more in [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout).

[Search Result« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.search-result)[Store ComponentsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/guides/store-components)

See also

[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

[Configuring the store image](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.store-image%23configuring-the-store-image)

[list-context.image-list props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.store-image%23list-contextimage-list-props)[image-list props](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.store-image/docs/apps/vtex.store-image%23image-list-props)

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

Was this helpful?

[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 store framework setting up cross border stores 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/store-framework-setting-up-cross-border-stores/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/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/store-framework-setting-up-cross-border-stores/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/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/store-framework-setting-up-cross-border-stores/docs/vtex-io-apps)

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)

[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/checking-your-stores-binding-id)

[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)

[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/cross-border-custom-urls-1)

[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)

[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-managing-performance)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework)

[Store Theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-store-theme)

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-using-advanced-layouts)

[Working with Site Editor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-working-with-site-editor)

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-dealing-with-events)

[Configuring Analytics (Google Tag Manager)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-configuring-analytics-google-tag-manager)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)

[Checking your store's binding ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/checking-your-stores-binding-id)

[Creating robots files for cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)

[Cross-border store content internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/cross-border-custom-urls-1)

[Managing landing pages in cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)

[Indicating alternate versions of localized pages in cross border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-managing-performance)

[Improving store accessibility with semantic HTML migration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-semantic-html-migration)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/vtex-io-documentation-go-live)

[Updating live stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-updating-live-stores)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/storefront-best-practices)

---

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/storefront-development)

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework)

[Setting up cross-border stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores)

Setting up cross-border stores

Cross-border stores are a specialized type of [multistore](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/creating-multi-store-multi-domain--tutorials%5F510?locale=en), where a single VTEX account manages multiple stores across different countries or regions.

This setup is ideal for stores with different brands and business models that require multiple operational environments. In a multistore setup — also known as a subaccount or multidomain — each store can be configured independently, which means that layouts, products, prices, and logistics can be tailored to each region and domain.

In a cross-border context, a multistore setup allows a single VTEX account to manage multiple stores, such as:

* `http://{storeName}.com/en` (English store)
* `http://{storeName}.com/pt` (Portuguese store)

> To become a cross-border store, open a [VTEX support ticket](https://read.calvincode.net/reader?url=https://help-tickets.vtex.com/smartlink/sso/login/zendesk) and request the setup of a multistore environment.

## Before you begin

### Define your operation

Before implementing your cross-border store, make sure you have the following information ready:

* **Target regions:** Identify the countries/regions where your store will operate.
* **Currencies and Languages:** Determine accepted payment currencies and supported site languages.
* **Inventory management:** Decide if inventory will be managed from Brazil or locally in each country/region.
* **Tax and Export partner:** If using fulfillment from Brazil, choose a partner for handling export taxes and fees. To find your partner, check out the [Partners](https://read.calvincode.net/reader?url=https://vtex.com/en-us/partners/) page on the VTEX website.
* **Catalog translation:** Check if your catalog is translated or needs localization for each country/region.
* **Promotions:** Plan the types of promotions for each store. Learn about the types available in [Promotions](https://read.calvincode.net/reader?url=https://help.vtex.com/subcategory/benefits--1yTYB5p4b6iwMsUg8uieyq) guides.
* **Operations:** Consider any existing physical stores, sellers, or other operations abroad. Learn more in [VTEX account types](https://read.calvincode.net/reader?url=https://help.vtex.com/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/4yPqZQyj0t675QpcG7H6yl%23vtex-account-types)
* **Teams:** Identify if different teams will manage each country/region’s ecommerce operations.
* **ERP Systems:** Confirm if each country/region has its own ERP or a centralized system.
* **Payment gateway:** Ensure you have a gateway that supports multiple currencies.
* **Domains:** Define the primary and secondary domains for your stores. Learn more in [Rules for main hosts](https://read.calvincode.net/reader?url=https://help.vtex.com/pt/tutorial/configuring-the-store-domain--tutorials%5F2450%23rules-for-main-host).

This information will help you to choose the most suitable architecture for your cross-border store.

### Choose your store architecture

After defining your operation based on the topics above, choose the architecture for your cross-border store following the section [Multi-language and multi-currency](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-architecture%23multi-language-and-multi-currency) within the Store Architecture guide.

## Essential concepts

To better understand how a VTEX cross-border multistore works, it's essential to understand the key concepts of bindings and trade policies.

### Binding

In VTEX, **binding** is the process of linking a website, store name, and trade policy to create a unique identifier for each store. This is essential for managing multiple stores within a single VTEX account.

Each store has a unique binding value, which is crucial for routing and configuring store-specific settings.

> To check the `binding` value of your stores, follow the [Checking your store's binding id](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-your-stores-binding-id) guide.

### Trade Policies

A **trade policy** is a set of configurations that define a store's catalog, pricing, and logistics strategy. Each store can have its own trade policy, allowing for different setups depending on the market. For example, if the pricing structure differs between your stores in Spain and France, you'll need separate trade policies.

However, if two stores share the same logistics, catalog, and prices, they can use a common trade policy.

> To learn more, see the guide [How trade policies work](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-trade-policies-work--6Xef8PZiFm40kg2STrMkMV).

## Guides in this section

[Checking your store's binding idUnderstand how to identify the unique binding ID for each store in your cross-border setup.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/checking-your-stores-binding-id)[Creating robots files for cross-border storesLearn how to configure \`robots.txt\` files to manage search engine indexing for cross-border stores.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-creating-robots-files-for-cross-border-stores)[Cross-border store content internationalizationDiscover how to customize URLs and manage content localization for cross-border stores.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cross-border-custom-urls-1)[Managing landing pages in cross-border storesLearn how to manage landing pages tailored for different regions.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-managing-landing-pages-in-cross-border-stores)[Indicating alternate versions of localized pages in cross border storesDiscover how to set up alternate page versions in cross-border stores.See more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-indicating-alternate-pages-in-cross-border-stores)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/_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/guides/vtex-io/Storefront-Guides/store-framework-setting-up-cross-border-stores.md)

[Setting up Google Tag Manager events and triggers« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores//docs/guides/vtex-io-documentation-setting-up-google-tag-manager)[Checking your store's binding IDNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores//docs/guides/checking-your-stores-binding-id)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/_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

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23before-you-begin)

[Define your operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23define-your-operation)[Choose your store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23choose-your-store-architecture)

[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23essential-concepts)

[Binding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23binding)[Trade Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23trade-policies)

[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23guides-in-this-section)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/vtex-io/Storefront-Guides/store-framework-setting-up-cross-border-stores.md)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23before-you-begin)

[Define your operation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23define-your-operation)[Choose your store architecture](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23choose-your-store-architecture)

[Essential concepts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23essential-concepts)

[Binding](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23binding)[Trade Policies](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23trade-policies)

[Guides in this section](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/store-framework-setting-up-cross-border-stores/docs/guides/store-framework-setting-up-cross-border-stores%23guides-in-this-section)

On this page

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


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

[User] Provide a guide on guides ignore profile data 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/ignore-profile-data/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/shopping-cart-section-api-quick-start-guides)

[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/simulate-a-shopping-cart)

[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/create-a-new-cart)

[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/get-cart-information-by-id)

[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/remove-all-items-from-cart)

[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/remove-all-personal-data)

[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/add-cart-items)

[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/update-cart-items)

[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/change-price)

[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data)

[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/get-cart-installments-information)

[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/add-coupons-to-the-cart)

[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/add-service-to-the-cart)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/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/ignore-profile-data/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/custom-data-1)

[Customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/customization)

[Discounts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/discounts)

[Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/features)

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/checkout-security)

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/shopping-cart-section-api-quick-start-guides)

[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/simulate-a-shopping-cart)

[Get current or create a new cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/create-a-new-cart)

[Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/get-cart-information-by-id)

[Remove all items from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/remove-all-items-from-cart)

[Remove all personal data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/remove-all-personal-data)

[Add cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/add-cart-items)

[Update cart items](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/update-cart-items)

[Change the price of an SKU in a cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/change-price)

[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data)

[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/get-cart-installments-information)

[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/add-coupons-to-the-cart)

[Add a service (offering) to a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/add-service-to-the-cart)

[Cart Attachments](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/cart-attachments-section-api-quick-start-guides)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/checkout-error-codes)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/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/ignore-profile-data/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

[Shopping Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/shopping-cart-section-api-quick-start-guides)

[Ignore profile data from cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data)

Ignore profile data from cart

The shopping cart is where the information on the products chosen by the customer while browsing a store is gathered. This data may include item prices, shipping value, payment, and delivery methods, among others.

All VTEX store user profile information is stored in the [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw). Through this information, it is possible to automatically fill in the customer's data in the cart using the registered email ([SmartCheckout](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-customer-information-automatic-fill-in--2Nuu3xAFzdhIzJIldAdtan)).

This guide will describe how to disable the automatic inclusion of user profile data through the email registered in a shopping cart.

## Getting and accessing shopping cart information

The first step is to get the `orderFormId` and access the shopping cart information that you want to ignore profile data. For more information, access the [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/get-cart-information-by-id) guide.

When accessing shopping cart information, make sure that the `clientProfileData` has not been sent to the cart, which is indicated in the example below:

`1

...

2

"clientProfileData": null

3

...

`

> The request [Ignore profile data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/ignoreprofiledata) will only work if the `clientProfileData` information has not been sent to the cart yet (as shown above). If the cart already has a `clientProfileData` information, the response status will be `403 Forbidden error`, with an `Access Denied` message.

Example of a cart containing customer profile data, and in which the request [Ignore profile data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/ignoreprofiledata) cannot be applied:

`1

...

2

"clientProfileData": {

3

 "email": "clark.kent@examplemail.com",

4

 "firstName": "Clark",

5

 "lastName": "Kent",

6

 "document": "44444444444",

7

 "documentType": "cpf",

8

 "phone": "+5511123456789",

9

 "corporateName": null,

10

 "tradeName": null,

11

 "corporateDocument": null,

12

 "stateInscription": null,

13

 "corporatePhone": null,

14

 "isCorporate": false,

15

 "profileCompleteOnLoading": false,

16

 "profileErrorOnLoading": false,

17

 "customerClass": null

18

},

19

...

`

## Disabling profile data from the shopping cart

The `orderFormId` information of the shopping cart must be sent through the URL request, as shown by the URL example below:

`https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/9620cbb7ebc34ca68a86621428816c5a/profile`

Additionally, you need to send the request body containing the parameter `ignoreProfileData` set as `false` or `true` to define whether profile data should be ignored.

See below an example of the request body:

`1

{

2

 "ignoreProfileData": false

3

}

`

After sending the request, the endpoint will return the response body with all fields of the object `clientProfileData` shown as `null`.

`1

...

2

"clientProfileData": {

3

 "email": null,

4

 "firstName": null,

5

 "lastName": null,

6

 "document": null,

7

 "documentType": null,

8

 "phone": null,

9

 "corporateName": null,

10

 "tradeName": null,

11

 "corporateDocument": null,

12

 "stateInscription": null,

13

 "corporatePhone": null,

14

 "isCorporate": false,

15

 "profileCompleteOnLoading": null,

16

 "profileErrorOnLoading": null,

17

 "customerClass": null

18

},

19

...

`

## Error codes

The following errors may appear as a message in the response body.

### 400 - Bad Request

* **Message error example (code ORD002)**: `"Invalid order form"`. The `orderFormId` information is not valid.

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD002",

5

 "message": "Invalid order form",

6

 "exception": null

7

 },

8

 "operationId": "4ae9e8e4-0fd1-469a-99b1-71705cbe036f"

9

}

`

### 403 - Forbidden

* **Message error example (code CHK003)**: `"Access Denied"`. The request was sent to a cart that already has `clientProfileData` information. Before processing this request, please delete all client information via the [Remove all personal data](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/remove-all-personal-data) endpoint.

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "CHK003",

5

 "message": "Access Denied",

6

 "exception": null

7

 },

8

 "operationId": "4ae9e8e4-0fd1-469a-99b1-71705cbe036f"

9

}

`

### 404 - Not Found

* **Message error example**: `"The requested URL was not found on the server"`. Check that the URL data is correct.

`1

2

404 Not Found

3

The requested URL was not found on this server.

4

`

Contributors

1

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Checkout/shopping-cart-section-api-quick-start-guides/ignore-profile-data.md)

[Change the price of an SKU in a cart« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data//docs/guides/change-price)[Get cart installments informationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data//docs/guides/get-cart-installments-information)

Contributors

1

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

ON THIS PAGE

[Getting and accessing shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23getting-and-accessing-shopping-cart-information)

[Disabling profile data from the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23disabling-profile-data-from-the-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23400-bad-request)[403 - Forbidden](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23403-forbidden)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23404-not-found)

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/Checkout/shopping-cart-section-api-quick-start-guides/ignore-profile-data.md)

Copy page

On this page

ON THIS PAGE

[Getting and accessing shopping cart information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23getting-and-accessing-shopping-cart-information)

[Disabling profile data from the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23disabling-profile-data-from-the-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23400-bad-request)[403 - Forbidden](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23403-forbidden)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/ignore-profile-data/docs/guides/ignore-profile-data%23404-not-found)

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