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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Integration Guides

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

Punchout

Learn how punchout enables seamless integration between eprocurement systems and supplier ecommerce sites for efficient B2B purchasing.

B2B ecommerce refers to online transactions between businesses, such as a retailer purchasing inventory from a wholesaler. These transactions often involve negotiated pricing, approval workflows, and integration with eprocurement systems.

One common feature in B2B ecommerce is punchout, which allows companies to connect their eprocurement systems directly to a supplier’s ecommerce website in the B2B context.

An eprocurement system is a software that companies use to manage and automate the purchasing of goods and services. It typically includes tools for managing suppliers, generating and approving purchase orders (POs), and integrating with financial and inventory systems.

This real-time connection with supplier websites through punchout enables employees to access a supplier's storefront from within their eprocurement system without needing to log in or register manually, streamlining the B2B purchasing experience.

When an employee "punches out" to a supplier’s site, they're automatically authenticated and redirected to a personalized shopping experience tailored to their organization’s commercial agreement. This includes customized catalogs, pricing, and shipping terms.

> Not all purchases made through eprocurement systems use punchout. However, when punchout is available, it provides users with seamless access to a preferred supplier's store while preserving the internal procurement process for approvals and record-keeping.

## Punchout flow

Here's an overview of a typical punchout workflow:

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

1. **Login:** An employee logs in to their company’s eprocurement system and selects a supplier ecommerce website to "punch out" to (typically by clicking the supplier’s logo).
2. **Browsing and adding items:** The employee is redirected to the supplier’s ecommerce website and automatically logged in using the credentials provided by the eprocurement system.
The supplier’s ecommerce website may be customized for the employee’s company, with a unique homepage, product selection, and pricing based on the applicable trade policy.
The employee can browse or search the supplier’s catalog and add items to their shopping cart.
3. **Checkout:** The employee clicks the checkout button on the supplier's site and is redirected to their eprocurement system. Rather than going through the regular checkout flow on the supplier's site, the shopping cart is sent back to the eprocurement system.
4. **Purchase order:** The employee can create a purchase order from the cart in their eprocurement system and submit it for approval.

## Benefits of punchout

Punchout integration in eprocurement systems offers multiple benefits, as highlighted below:

* **Improved efficiency:** Punchout simplifies the buying process, allowing procurement teams to work within their existing systems while accessing real-time, accurate supplier catalogs.
* **Enhanced user experience:** Unlike traditional eprocurement systems, which often have limited interfaces, punchout leverages the supplier’s ecommerce storefront to offer a richer, more intuitive shopping experience.
* **Dynamic, customized content:** Suppliers can present personalized catalogs, pricing, and content based on individual agreements with each buyer. This is especially useful for large or frequently changing inventories.
* **Seamless integration:** Punchout supports a smooth transition between the eprocurement system and the ecommerce platform, ensuring consistent record-keeping and reducing manual steps in the purchasing process.

Contributors

1

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

[Webstore (OAuth 2.0)« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout//docs/guides/login-integration-guide-webstore-oauth2)[Punchout login integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout//docs/guides/punchout-login-integration)

Contributors

1

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

[Punchout flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout%23punchout-flow)

[Benefits of punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout%23benefits-of-punchout)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/punchout/punchout.md)

Copy page

On this page

ON THIS PAGE

[Punchout flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout%23punchout-flow)

[Benefits of punchout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/punchout/docs/guides/punchout%23benefits-of-punchout)

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] Explain troubleshooting i cant update the ean of my skus via api in VTEX.

[Assistant]
Documentation

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

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/storefront-development)

[VTEX IO AppsFind pre-built solutions to grow your business.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/vtex-io-apps)

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting)

[Release NotesStay up to date with our latest releases and bug fixes.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/updates/release-notes)

Troubleshooting

API

[I can't update the EAN of my SKUs via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api)

---

Development

---

Store performance

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/updates/release-notes)

Troubleshooting

API

[I can't update the EAN of my SKUs via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api)

---

Development

---

Store performance

---

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting)

API

I can't update the EAN of my SKUs via API

Updating EANs in VTEX can lead to catalog sync issues affecting inventory.

**Keywords:** SKU, product, EAN, catalog

When trying to update the EAN (European Article Number), which contains the barcode information for a SKU, you may face issues with catalog synchronization between the VTEX Admin and API. This can impact inventory management and customer experience.

## Solution

To solve this issue, consider [deleting the SKU EAN](#deleting-the-sku-ean) and then [adding a new EAN](#step-1---add-a-new-ean-to-the-sku).

### Deleting the SKU EAN

To update the current SKU EAN, you must first delete all the EAN values associated with the SKU.

* [Delete SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/ean/-ean-): Use the endpoint to delete a specific EAN.
* [Delete all SKU EAN values](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23delete-/api/catalog/pvt/stockkeepingunit/-skuId-/ean): Use the endpoint to delete all the EANs associated with the SKU.

#### Step 1 - Add a new EAN to the SKU

Only after all previous EANs have been deleted can you add a new EAN to the SKU. To do this, use the [Create SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23post-/api/catalog/pvt/stockkeepingunit/-skuId-/ean/-ean-) endpoint to create the new EAN value.

#### Step 2 - Check whether the SKU EAN has been updated

After adding the new EAN, use the [Get SKU by EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23get-/api/catalog%5Fsystem/pvt/sku/stockkeepingunitbyean/-ean-) endpoint to confirm it has been updated. The new EAN values will be displayed in the `AlternateIdValues` array.

`1

"AlternateIdValues":

2

[

3

"8781",

4

"878181"

5

]

`

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/_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/troubleshooting/api/i-cant-update-the-ean-of-my-skus-via-api.mdx)

[Getting started with Lighthouse« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/storefront-getting-started-with-lighthouse)[I am getting 500 errors in VTEX IO CLINext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F60782333%3Fv%3D4%26w=64%26q=75)](https://github.com/carolinamenezes)

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api%23solution)

[Deleting the SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api%23deleting-the-sku-ean)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/troubleshooting/api/i-cant-update-the-ean-of-my-skus-via-api.mdx)

Copy page

On this page

ON THIS PAGE

[Solution](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api%23solution)

[Deleting the SKU EAN](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api%23deleting-the-sku-ean)

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 sessions system overview in VTEX.

[Assistant]
Documentation

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

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

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

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

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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

[Sessions System Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview)

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

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

---

VTEX Session

[Sessions System Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview)

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

VTEX Session

[Sessions System Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview)

Sessions System Overview

VTEX’s Sessions System is an architecture that allows stores to handle complex B2B scenarios, regionalize customer experience and perform promotion segmentation by Campaign Audiences.

## How it works

The Sessions System operates using two cookies: `vtex_session` and `vtex_segment`. Learn how they work in the following sections.

### `vtex_session` cookie

Through the `vtex_session` cookie, the Sessions System identifies the information of a specific session of a user browsing in your store.

It is possible to see session properties by making a request to `GET` `https://{{accountname}}.{{environment}}.com.br/api/sessions?items={{namespace}}.{{value}},{{namespace}}.{{value2}}`.

The API returns several **namespaces**, which are the keys that group together certain types of information about the session.

Below, see a response example with basic data on a session:

`1

{

2

 "id": "840f8910-eb3b-4f25-8d51-a06445317906",

3

 "namespaces": {

4

 "account": {

5

 "id": {

6

 "value": "0e914df8-c516-45bc-a45a-0aab6482eaf7",

7

 "keepAlive": true

8

 },

9

 "accountName": {

10

 "value": "qamarketplace"

11

 }

12

 },

13

 "store": {

14

 "channel": {

15

 "value": "1"

16

 }

17

 },

18

 "impersonate": {

19

 "canImpersonate": {

20

 "value": "false"

21

 }

22

 },

23

 "profile": {

24

 "isAuthenticated": {

25

 "value": "false"

26

 }

27

 }

28

 },

29

 "version": 1,

30

 "active": true,

31

 "debug": false

32

}

`

Below you will find a list of possible namespaces that can be returned by the API:

* `account`: Namespace with account information where the session is happening.
* `checkout`: Namespace with information related to checkout, such as session cart ID (`cartId`) and region (`regionId`) that the checkout returns to identify the geographic location of the user browsing this session.
* `store`: Namespace with information about the current sales channel of the session.
* `cookie`: Namespace with information on the authentication cookies of the user.
* `impersonate`: Namespace that identifies if the logged in user has permission to impersonate another user and browse on that user’s behalf.
* `profile`: Namespace with information related to the customer’s profile logged into that session. Eligible price tables for that customer are listed in this namespace.
* `public`: Namespace with general information on a session, `utm_campaign`, `utm_source` and `utmi_campaign`. In this namespace, we also find `postalCode` or `geoCoordinates` and `country`, which are given to VTEX’s checkout so that it can return the `regionId`, require in the namespace `checkout`. These values follow the format defined in the [Checkout API reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/checkout-api%23get-/api/checkout/pub/regions/-regionId-).
* `authentication`: Namespace with user authentication data in the context of the session.
* `rnb`: Namespace that gives information related to applicable Campaign Audiences and promotions for that session.

### `vtex_segment` cookie

The Sessions System also creates the `vtex_segment` cookie, which contains the information of the commercial conditions to be applied to a session.

It is possible to see the properties of a segment by making a `GET` request to `https://{{accountName}}.{{environment}}.com.br/api/segments/{{segmentToken}}`.

Below you will find a response example with data from a segment:

`1

{

2

 "campaigns": "vip",

3

 "channel": "1",

4

 "priceTables": "gold",

5

 "regionId": "U1cj",

6

 "utm_campaign": "black friday",

7

 "utm_source": "google",

8

 "utmi_campaign": "banner"

9

}

`

> The session identified by the `vtex_session` cookie is individual. However, the `vtex_segment`cookie uses information that can be shared among different users. For example: the same price table can be available to different users in distinct sessions. This way, `vtex_segment` is used to control the cache key of the pages.

## Changing information from a session

It is possible to change a session’s information by making a `POST` request to the following route:

`https://{{account-name}}.{{environment}}.com.br/api/sessions/{{session_token}}`

Below you can see an example of a request body used to update the information of a session:

`1

{

2

 "public": {

3

 "utm_campaign": {

4

 "value": "Black Friday"

5

 },

6

 "country": {

7

 "value": "USA"

8

 },

9

 "postalCode": {

10

 "value": "05408000"

11

 }

12

 }

13

}

`

## Main features related to the Sessions System

### Price tables

Price tables are identified by the sessions system in the namespace `profile`. Each price table displays customized prices for that identified user that is browsing in the store. You can create price tables for specific customer groups. Price tables can by used to handle B2B scenarios.

Learn more about [Configuring price tables for specific users](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-price-tables-for-specific-users--5S9oDOMHNmY4K0kAewAiWY).

### Region

The Region feature is identified by the sessions system in the namespace `checkout`, with the `regionId` property, which is generated when a `postalCode` or `geoCoordinates` and a `country` are added to a session. The feature's goal is to regionalize the experience of the user in the store.

It allows, for example, sellers to configure their own prices and marketplaces to be displayed according to the customer's region.

To configure price and availability according to the customer’s region, access our article about [setting up SKU price and availability by Region](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/setting-up-price-and-availability-of-skus-by-region--12ne58BmvYsYuGsimmugoc).

### Campaign audiences

Campaign Audiences are clustering rules that allow promotions to be applied to customers that meet a set of criteria.

The campaign audiences feature works much like price tables. In the **Promotions & Taxes** module, you can create conditions that apply a promotion to a particular customer if campaign conditions are met.

Learn more about [Campaign Audiences](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/campaign-audiences--3o7lhpNseXY2WmjZO0gQ6m).

Contributors

2

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

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX-Session/sessions-system-overview.md)

[Conversion« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview//docs/guides/conversion)[Managing SSL CertificatesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview//docs/guides/managing-ssl-certificates)

Contributors

2

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

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

ON THIS PAGE

[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23how-it-works)

[vtex\_session cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23vtexsession-cookie)[vtex\_segment cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23vtexsegment-cookie)

[Changing information from a session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23changing-information-from-a-session)

[Main features related to the Sessions System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23main-features-related-to-the-sessions-system)

[Price tables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23price-tables)[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23region)[Campaign audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23campaign-audiences)

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-Session/sessions-system-overview.md)

Copy page

On this page

ON THIS PAGE

[How it works](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23how-it-works)

[vtex\_session cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23vtexsession-cookie)[vtex\_segment cookie](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23vtexsegment-cookie)

[Changing information from a session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23changing-information-from-a-session)

[Main features related to the Sessions System](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23main-features-related-to-the-sessions-system)

[Price tables](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23price-tables)[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23region)[Campaign audiences](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/sessions-system-overview/docs/guides/sessions-system-overview%23campaign-audiences)

On this page

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


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

[User] Provide a guide on guides vtex admin customers in VTEX.

[Assistant]
Documentation

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

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

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

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

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

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

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

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

Admin Customers

Official extension

Version: 2.18.2

Latest version: 2.18.2

> This app is no longer maintained by VTEX. This means support and maintenance are no longer provided.

> To continue using the B2B Suite, it is important to install the [VTEX B2B Admin Customers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-admin-customers).

# Customers Admin

A VTEX admin app that helps manage your customer data. This application allows users to create, edit, and search for customers. It's an alternative to MasterData when it comes to managing the documents from the CL entity.

The [vtex.admin-customers-graphql](https://read.calvincode.net/reader?url=https://github.com/vtex/admin-customers-graphql) depends on this application. Its responsibility is to group all the GraphQL queries and mutations needed to manage MasterData data.

## 🚀 Installation

Using the [VTEX IO CLI](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/development/vtex-io-cli-installation-and-command-reference/%23command-reference), log into the VTEX account you are working on and install the latest version:

`1

vtex install vtex.admin-customers

`

After installing the app, you can find it in the Admin at **Customers > Customers**.

## ✅ Features

The list below presents every feature of this application, where the checked ones have already been implemented. The features that are yet to come are unchecked.

> Please, whenever a new feature from the list below is implemented, mind-marking the checkbox and create a feature demo.

* [Listing](#listing)
* [Memorize visibility fields](#memorize-visibility-fields)
* [Search](#search)
* [Filters](#filters)
* [Creation](#creation)
* [Details view](#details-view)
* [Edition](#edition)
* Deletion of profile (GDPR/LGPD)
* Address association listing
* Schema viewing with user-level configuration
* Counters

## 🎥 Demonstration

**Listing**

![{"base64":"  ","img":{"width":1912,"height":935,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":3299212,"url":"https://user-images.githubusercontent.com/17439470/127700770-fedd9c66-5112-4bc7-9f85-c43117e8c355.gif"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/17439470/127700770-fedd9c66-5112-4bc7-9f85-c43117e8c355.gif)

**Memorize visibility fields**

The visibility fields is a feature to toggle visibility of table columns.

Here we have an additional feature that saves the preferred column visibility configuration of the end user, maintaining your configurations even after a page refresh and future visits to this page.

![{"base64":"  ","img":{"width":1912,"height":937,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":1358706,"url":"https://user-images.githubusercontent.com/17439470/127700866-92656fe0-1f8a-4b4d-8e3c-2d4a2a736778.gif"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/17439470/127700866-92656fe0-1f8a-4b4d-8e3c-2d4a2a736778.gif)

**Search**

The search input uses the fields: **E-mail**, **First Name** or **Last Name** to filter the results that matches the terms searched while also displaying the results on the table.

![{"base64":"  ","img":{"width":1912,"height":938,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":389613,"url":"https://user-images.githubusercontent.com/17439470/127700895-78509248-fc5b-4036-b45c-cee8fa7f0509.gif"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/17439470/127700895-78509248-fc5b-4036-b45c-cee8fa7f0509.gif)

**Filters**

With these filters, it is possible to refine your search. You can filter by: **E-mail**, **First Name**, **Last Name**, **Document ID**, **Document** or **Receive Newsletter**.

Every filter has conditionals for you to choose from; it could be **equal**, **not equal**, or **contains**.

![filters 1](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/17439470/127700913-dbb54e5c-4327-4df6-9e4d-022b6fa34c3f.png)![filters 2](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/17439470/127700917-a4d5dcac-56fb-491c-b7af-adaea10d2cc6.png) **Creation**

![{"base64":"  ","img":{"width":1903,"height":931,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":2315179,"url":"https://user-images.githubusercontent.com/17439470/127700937-27bde86b-7825-4a75-b32a-20bae727f41a.gif"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/17439470/127700937-27bde86b-7825-4a75-b32a-20bae727f41a.gif)

**Details view** ![detail](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/17439470/127700959-633b02c0-0eb8-4159-a81d-586cbf5ce65b.PNG) **Edition**

![{"base64":"  ","img":{"width":1912,"height":932,"type":"gif","mime":"image/gif","wUnits":"px","hUnits":"px","length":913163,"url":"https://user-images.githubusercontent.com/17439470/127700969-7b58c9f9-cb65-4fd3-b605-739e9576f020.gif"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/17439470/127700969-7b58c9f9-cb65-4fd3-b605-739e9576f020.gif)

## ☕ Developing

1. Clone this repo `git clone https://github.com/vtex/admin-customers`
2. `yarn --cwd react/` for code completion
3. `vtex link`
4. Navigate to `workspace--account.myvtex.com/admin/app/example`

See also

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

ON THIS PAGE

[Customers Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23customers-admin)

[🚀 Installation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23-installation)

[✅ Features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23-features)

[🎥 Demonstration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23-demonstration)

[☕ Developing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-admin-customers/docs/apps/vtex.admin-customers%23-developing)

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 import customer 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/import-customer-data/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Integration Guides

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

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

Import customer data

When implementing an ecommerce project, it may be necessary to import customer data from other systems, such as Customer Relationship Management (CRM) applications.

The **Checkout** module stores shopper data in [**Master Data v1**](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw) by default. Because of this, using the [**Master Data v1** API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api) is the best way to integrate your customer database into VTEX.

In this guide, you can learn how to import customer data to VTEX. Learn more about Master Data and its features in the [Master Data developers guide](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-how-it-works).

> Importing your customers' data will also enable automatic fill-in at checkout for those customers. Learn more about [SmartCheckout - Customer information automatic fill-in](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/smartcheckout-preenchimento-automatico-de-dados-do-cliente--2Nuu3xAFzdhIzJIldAdtan%23)

## Data entities

**Master Data v1** leverages the concept of [data entities](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw%23data-entities) to allow for highly customizable databases. These work as tables, where each document (profile or address) is saved as a row.

There are two native data entities you must use for this integration:

* `CL`: shopper profiles.
* `AD`: shopper addresses.

## Integration

The basic operations you will need to import customer data are:

* [creating new customer profiles](#create-new-customer-profile).
* [creating addresses](#create-new-address).

Depending on your project’s architecture, it may also be important to:

* [Retrieve customer data](#retrieve-customer-data).
* [Edit customer data](#edit-customer-data).

### Create new customer profile

To register a new customer profile, use the [Create new document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23post-/api/dataentities/-acronym-/documents) for the `CL` data entity.

> When creating a new document, you will receive an `Id` in the response. This identifies the customer in Master Data and will be used later to register addresses associated with that customer. Make sure you save this ID and associate it with the customer’s ID in your source database.

#### Creating customer profile request example

POST

`1

https://{accountName}.{environment}.com.br/api/dataentities/CL/documents

`

Request body

`1

{

2

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

3

 "firstName": "Clark",

4

 "lastName": "Kent",

5

 "phone": "+12025550195",

6

 "documentType": "CPF",

7

 "document": "12345678900",

8

 "isCorporate": false,

9

 "isNewsletterOptIn": false,

10

 "localeDefault": "en-US"

11

}

`

Response

`1

{

2

 "Id": "CL-b345cbda-e489-11e6-94f4-0ac138d2d42e",

3

 "Href": "http://api.vtex.com/my-store-name/dataentities/CL/documents/b345cbda-e489-11e6-94f4-0ac138d2d42e"

4

}

`

### Create new address

To register a new customer address, use the [Create new document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23post-/api/dataentities/-acronym-/documents) for the `AD` data entity.

> Note that the `userId` in the request body is the `Id` returned by the API when [creating a customer profile](#create-new-customer-profile). Make sure to send it to associate the address with the corresponding customer.

#### Creating new address request example

POST

`1

https://{accountName}.{environment}.com.br/api/dataentities/AD/documents

`

Request body

`1

{

2

 "addressName": "My House",

3

 "addressType": "residential",

4

 "city": "Metropolis",

5

 "complement": "",

6

 "country": "USA",

7

 "postalCode": "11375",

8

 "receiverName": "Clark Kent",

9

 "reference": null,

10

 "state": "MP",

11

 "street": "Baker Street",

12

 "neighborhood": "Upper east side",

13

 "number": "21",

14

 "userId": "7e03m794-a33a-11e9-84rt6-0adfa64s5a8e"

15

}

`

### Retrieve customer data

If you need to retrieve customer information after you have imported it to VTEX, you can use one of these endpoints:

* [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search): more direct solution for fetching a single document, while also being able to return multiple results.
* [Scroll documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/scroll): useful if you want to fetch multiple documents spread across multiple requests.

> These requests allow you to filter and sort data by any of the documents’ fields. You can also request that only certain pieces of information be returned, instead of the complete documents. See [Search documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/search) and [Scroll documents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23get-/api/dataentities/-acronym-/scroll) to learn more.

## Edit customer data

Once your store is up and running, your customers can update their profile information in the [My Account](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/how-does-my-account-work--2BQ3GiqhqGJTXsWVuio3Xh%23) section and it will be automattically updated in the documents you have created with the Master Data v1 API. So many integrations will not have to deal with customer data maintenance.

However, if you need to implement such an integration, you can use the [Update partial document API endpoint](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23patch-/api/dataentities/-acronym-/documents/-id-).

### Updating customer profile request example

`1

PATCH

2

https://{accountName}.{environment}.com.br/api/dataentities/CL/documents/{id}

`

Request body

`1

{

2

 "phone": "+12025550195",

3

 "isNewsletterOptIn": false

4

}

`

### Updating address request example

`1

PATCH

2

https://{accountName}.{environment}.com.br/api/dataentities/AD/documents/{id}

`

Request body

`1

{

2

 "street": "Market Street",

3

 "neighborhood": "South side",

4

 "number": "27",

5

}

`

Contributors

2

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

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Integration-Guides/erp-integration-guide/import-customer-data.md)

[Import inventory« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data//docs/guides/erp-integration-import-inventory)[Set up order integrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data//docs/guides/erp-integration-set-up-order-integration)

Contributors

2

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

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

ON THIS PAGE

[Data entities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23data-entities)

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

[Create new customer profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23create-new-customer-profile)[Create new address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23create-new-address)[Retrieve customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23retrieve-customer-data)

[Edit customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23edit-customer-data)

[Updating customer profile request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23updating-customer-profile-request-example)[Updating address request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23updating-address-request-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/Integration-Guides/erp-integration-guide/import-customer-data.md)

Copy page

On this page

ON THIS PAGE

[Data entities](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23data-entities)

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

[Create new customer profile](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23create-new-customer-profile)[Create new address](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23create-new-address)[Retrieve customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23retrieve-customer-data)

[Edit customer data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23edit-customer-data)

[Updating customer profile request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23updating-customer-profile-request-example)[Updating address request example](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/import-customer-data/docs/guides/import-customer-data%23updating-address-request-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] Provide a guide on guides synchronizing the catalog with vtex ads 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/synchronizing-the-catalog-with-vtex-ads/docs/guides)

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

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

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

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/getting-started)

---

Integration Guides

---

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

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/checkout-api-overview)

---

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

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-ads)

[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/getting-started-with-vtex-ads-api)

[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-the-catalog-with-vtex-ads)

[Synchronizing product information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-product-information)

[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-inventory-information)

[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/retrieving-ads)

[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/ads-events)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/getting-started)

---

Integration Guides

---

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

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/checkout-api-overview)

---

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

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-ads)

[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/getting-started-with-vtex-ads-api)

[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-the-catalog-with-vtex-ads)

[Synchronizing product information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-product-information)

[Synchronizing inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-inventory-information)

[Retrieving ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/retrieving-ads)

[Ads events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/ads-events)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides)

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/vtex-ads)

[Getting started with VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/getting-started-with-vtex-ads-api)

[Synchronizing the catalog with VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/docs/guides/synchronizing-the-catalog-with-vtex-ads)

Synchronizing the catalog with VTEX Ads

Synchronize your product catalog with VTEX Ads to keep product information and inventory data up to date.

To activate your VTEX Ads integration, the first step is to synchronize your product catalog. This ensures that product and inventory data is available for campaign creation and conversion tracking.

Catalog data is essential for:

* Enabling advertisers to select products for **Product Ads** campaigns.
* Supporting conversion attribution for both **Product Ads** and **Banner Ads**.

Catalog synchronization is divided into two stages:

1. [Product information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-product-information)
Send relevant product attributes such as name, image, brand, and price to VTEX Ads so they can be accurately represented in ads and used for targeting and reporting.
2. [Inventory information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-inventory-information)
Keep stock levels updated to ensure ads are only shown for available products and campaigns reflect real-time inventory.

Contributors

1

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads/_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 Ads/getting-started-with-vtex-ads-api/synchronizing-the-catalog-with-vtex-ads.md)

[Getting started with VTEX Ads API« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads//docs/guides/getting-started-with-vtex-ads-api)[Synchronizing product informationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/synchronizing-the-catalog-with-vtex-ads//docs/guides/synchronizing-product-information)

Contributors

1

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

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/VTEX Ads/getting-started-with-vtex-ads-api/synchronizing-the-catalog-with-vtex-ads.md)

Copy page

On this page

On this page

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