[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 tax service integration guide 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/tax-service-integration-guide/docs/guides)

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

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

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

Guides

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

---

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

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/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/tax-service-integration-guide/docs/guides/erp-integration-guide)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-protocol-graphql-api)

[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-reference-implementation)

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

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

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/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/tax-service-integration-guide/docs/guides/erp-integration-guide)

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

[Tax Protocol GraphQL API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-protocol-graphql-api)

[Reference Implementations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-services-reference-implementation)

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

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

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Integration Guides

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

Tax Service

Protocol that defines how to build an integration of an external tax provider to VTEX.

## Summary

[ Overview  A high-level explanation about how the Tax Protocol works ](tax-services-overview)

[ Specification  Understanding the protocol specification to better work with it ](tax-services-specification)

[ Recipe  Follow these steps to create your project using Tax Protocol ](tax-services-recipe)

[ Reference Implementations  Get to know best practices by checking these references. ](tax-services-reference-implementation)

Contributors

1

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

[Adding telesales impersonated email using the Session Manager« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide//docs/guides/adding-telesales-impersonated-email-using-the-session-manager)[OverviewNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide//docs/guides/tax-services-overview)

Contributors

1

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

ON THIS PAGE

[Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-service-integration-guide%23summary)

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/tax-service-integration-guide.md)

Copy page

On this page

ON THIS PAGE

[Summary](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tax-service-integration-guide/docs/guides/tax-service-integration-guide%23summary)

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 catalog integration in VTEX.

[Assistant]
Documentation

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

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

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

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

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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

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

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

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

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

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

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

[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/updating-sku-specifications-with-catalog-api)

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

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

[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/alternative-api-requests)

[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/how-to-implement-product-color-variation)

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

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

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

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

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

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

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

[Updating SKU Specifications with Catalog API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/updating-sku-specifications-with-catalog-api)

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

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

[Alternative API requests](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/alternative-api-requests)

[How to implement product color variation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/how-to-implement-product-color-variation)

---

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

---

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

Catalog

VTEX Catalog architecture is based on five fundamental concepts:

* [Category](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/categories)
* [Brand](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/brands)
* [Product](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/products)
* [SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/skus)
* [Specification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/specifications) ([product](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/product-specifications) and [SKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/sku-specifications) attributes)

Before uploading your entire catalog to VTEX it is very important to think carefully about your desired catalog structure. The way you structure your catalog and product specifications can have a great impact on site navigation, order integration and other aspects of your store.

In VTEX, the category tree is the backbone of the Catalog. Categories represent the way you organize your products so that the user can easily find the desired products.

When organized into categories, products can be classified hierarchically. Usually in up to three levels: department, category, and subcategory.

VTEX Intelligent Search doesn't have a limit of category levels. Category works as an attribute. On the other hand, running under Classic CMS, we strongly suggest using a maximum of three levels.

For a product to be made available in your store, it must:

* Be part of a brand, a category.
* Have at least one active SKU.

**Brands** are also an important aspect to consider, as it is very common for clients to search for products using them as a keyword. When brands are associated with products, you can use them as filters in your store navigation.

VTEX Catalog structure requires that an SKU can only be created after defining product information since the SKU itself is the product variation. Therefore, we can say that an SKU is the physical unit of a product in stock.

VTEX Catalog architecture also includes specifications, which are a category’s registered properties that attribute specific characteristics to products and SKUs linked to it.

Such specifications are, for example, SKU voltage, size, or color.

An example of a VTEX Catalog architecture blueprint is found below:

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

## Integration flow

Catalog integration must follow a specific workflow. The registers are related to each other, so following the correct order below is crucial:

1. Department and Categories
2. Specifications Fields
3. Brand
4. Products
5. SKUs
6. Product/SKU Specifications

## Registering products

VTEX provides three different ways to register products to a catalog:

1. **API Integration:** the collection with all methods can be found at the following link: [Catalog API Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/catalog-api%23overview).
2. **Spreadsheets:** there are two possible ways to import a spreadsheet with your Catalog information. They are: a. **Google Drive Import:** import the Catalog from a single Google Drive file. See the [google-import app details](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/google-import)b. **Classic Method:** import the Catalog using multiple files (product, SKU, specification, image)
3. **Manual input:** [Catalog data is loaded manually into VTEX Admin panel](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/catalog-101--5AF0XfnjfWeopIFBgs3LIQ/1ROhz3Y7mfSMmCO1I1GxEL), by filling out each field.

In order to import your products, it is possible that you have to use more than one method, depending on how the data is structured and what types of software are used in your operation.

Contributors

3

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

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

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

Was this helpful?

Yes

No

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

[Implementing reCAPTCHA in integrations« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration//docs/guides/implementing-recaptcha-in-integrations)[CategoriesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration//docs/guides/categories)

Contributors

3

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

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

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

ON THIS PAGE

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

[Registering products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/catalog-integration%23registering-products)

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

Copy page

On this page

ON THIS PAGE

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

[Registering products](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/catalog-integration/docs/guides/catalog-integration%23registering-products)

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

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

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

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

Troubleshooting

API

---

Development

---

Store performance

---

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

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

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

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

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

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

---

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

Troubleshooting

API

---

Development

---

Store performance

---

Troubleshooting

Find practical solutions to development issues in our troubleshooting guides.

![Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/_next/image?url=%2F_next%2Fstatic%2Fmedia%2Ftroubleshooting-image-header.391f4690.png%26w=3840%26q=75)

Filters

[I can't update the EAN of my SKUs via APIUpdating EANs in VTEX can lead to catalog sync issues affecting inventory.CatalogSKU](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/troubleshooting/i-cant-update-the-ean-of-my-skus-via-api)

[I am getting 500 errors in VTEX IO CLIRunning VTEX IO CLI commands returns a 500 internal server errorVTEX IOVTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/troubleshooting/i-am-getting-500-errors-in-vtex-io-cli)

[I am getting errors with my service configuration appErrors with the service configuration app occur depending on your workspace configurationVTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/troubleshooting/i-am-getting-errors-with-my-service-configuration-app)

[I can't install VTEX IO CLIWhen installing VTEX IO CLI, it returns "Error: Cannot find module vtex".Store FrameworkVTEX IOVTEX IO CLI](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/troubleshooting/docs/troubleshooting/i-cant-install-vtex-io-cli)

* 1
* 2
* 3
* ...
* 6
* 7

Still having trouble?

[Community](https://read.calvincode.net/reader?url=https://community.vtex.com/?%5Fga=2.198523433.743584735.1647618303-1974737580.1645714642)

The VTEX Community is an ecosystem where our clients and partners can interact, ask questions, and exchange information among themselves. It's the go-to place to find answers and talk about VTEX products.

[Help Center](https://read.calvincode.net/reader?url=https://help.vtex.com/category/troubleshooting--39pDkp8qxSll6mGj0tWViz)

The Help Center contains beginner tutorials, reference guides and troubleshooting articles about the VTEX Admin panel.

[Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support)

All clients have access to the services provided by our Technical Support team. These specialists are extensively prepared to give you the best experience possible when solving your tickets. To contact them, you need to open a ticket to VTEX support.

[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 bulk import buyer organizations spreadsheet 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/bulk-import-buyer-organizations-spreadsheet/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

B2B Organizations

[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet)

[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)

[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/enabling-an-access-control-list-acl-in-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/bulk-import-buyer-organizations-spreadsheet/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides)

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/master-data)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

B2B Organizations

[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet)

[How to configure tradeName to use in the organization search field](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)

[Enabling an access control list ACL in B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/enabling-an-access-control-list-acl-in-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/bulk-import-buyer-organizations-spreadsheet/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides)

B2B Suite

B2B Organizations

[Bulk Import Buyer Organizations Spreadsheet](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet)

Bulk Import Buyer Organizations Spreadsheet

This guide will walk you through the process of filling out the bulk import spreadsheet for use with the [Bulk Import API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations) to efficiently manage Buyer Organizations, Cost Centers, and Members through bulk import functionality.

## Before you begin

To use the bulk import of buyer organizations, you must first install and configure the [B2B Suite](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-suite) which includes the [B2B Organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.b2b-organizations) app.

> Bulk Import does not allow updating (editing) existing data in organizations or cost centers. This functionality is exclusively intended for creating and managing members.

## Step-by-step

1. Download the [template file](https://read.calvincode.net/reader?url=https://images.ctfassets.net/alneenqid6w5/PkYPXgHoDpok9ajVXQcM2/e5ff6b732ad776d2d04946855e109f15/b2b-bulk-import-template%5Fv1.xlsx).
2. Fill in the file with buyer organizations data following the specifications detailed in [File structure for import](#file-structure-for-import).

> Ensure your file is in `.xlsx` format and does not exceed 50MB.

1. Once your file is ready, upload it by making a request to the [Upload file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations%23post-/api/b2b/import/buyer-orgs) endpoint.
2. Validate file content by making a request to the [Validate file](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations%23post-/api/b2b/import/buyer-orgs/validate/-importId-) endpoint.
3. Once the file is successfully validated, start the bulk data import by making a request to the [Start import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/buyer-organizations%23post-/api/b2b/import/buyer-orgs/-importId-) endpoint.

## File structure for import

Before starting the upload and import process, it is essential to understand the required file structure. Ensure your import file adheres to the guidelines outlined below.

### File tabs

The import file should be structured with up to three tabs, each serving a distinct purpose:

1. [Buyer Orgs tab](#columns-in-the-buyer-orgs-tab): Contains detailed information about buyer organizations.
2. [Cost Centers tab](#columns-in-the-cost-centers-tab): Dedicated to managing cost centers within organizations.
3. [Members tab](#columns-in-the-members-tab): Stores information regarding members associated with organizations and cost centers.

### Columns in the Buyer Orgs tab

Each new organization should have one cost center in the Buyer Orgs tab. Additional columns for each custom field configured for the merchant can be added at the end of the Buyer Orgs tab.

Check the default columns present in this tab in the table below. Mandatory information is marked with `*`.

| Column              | Type   | Description                                                                              |
| ------------------- | ------ | ---------------------------------------------------------------------------------------- |
| Buyer Org ID\*      | String | Unique identifier for the buyer organization, for tracking and future updates.           |
| Buyer Org Name\*    | String | Official name of the buyer organization.                                                 |
| Admin First Name\*  | String | First name of the administrator overseeing the buyer organization.                       |
| Admin Last Name\*   | String | Last name of the administrator overseeing the buyer organization.                        |
| Admin Email\*       | String | Administrator's email address serves as the organization's primary point of contact.     |
| Cost Center ID\*    | String | Unique identifier for the cost center essential for tracking and future updates.         |
| Cost Center Name\*  | String | Name assigned to the cost center.                                                        |
| Address Type\*      | String | Classification of the address (e.g., residential, commercial).                           |
| Postal Code\*       | String | Postal code corresponding to the address.                                                |
| Street\*            | String | Street name of the address.                                                              |
| Number\*            | String | Numerical identifier for the location (house/building number).                           |
| Complement\*        | String | Additional information regarding the address if any.                                     |
| Neighborhood\*      | String | Neighborhood of the address.                                                             |
| City\*              | String | City where the address is located.                                                       |
| State\*             | String | State where the address is situated.                                                     |
| Country\*           | String | Country of the address.                                                                  |
| Receiver Name\*     | String | Name of the individual who is the point of contact at the address.                       |
| Phone Number\*      | String | Contact number for the receiver.                                                         |
| Business Document\* | String | Document that contains essential business information (e.g., tax identification number). |
| Collections         | String | Collections allowed to the buyer organization, separated by comma.                       |
| Price Tables        | String | Price tables allowed to the buyer organization, separated by comma.                      |
| Payment Terms       | String | Payment terms allowed to the buyer organization, separated by comma.                     |
| Trade Policies      | String | Trade policies allowed to the buyer organization, separated by comma.                    |
| Sellers             | String | Sellers allowed to the buyer organization, separated by comma.                           |

### Columns in the cost centers tab

This tab is required only for organizations with multiple cost centers. If the buyer organization has only one cost center, do not fill this tab.

Check the default columns present in the Cost Centers tab in the table below. Mandatory information is marked with `*`.

| Column              | Type   | Description                                                                             |
| ------------------- | ------ | --------------------------------------------------------------------------------------- |
| Buyer Org ID\*      | String | Unique identifier for the buyer organization essential for tracking and future updates. |
| Cost Center ID\*    | String | Unique identifier for the cost center essential for tracking and future updates.        |
| Cost Center Name\*  | String | Name assigned to the cost center.                                                       |
| Address Type\*      | String | Classification of the address (e.g., residential, commercial).                          |
| Postal Code\*       | String | Postal code corresponding to the address.                                               |
| Street\*            | String | Street name of the address.                                                             |
| Number\*            | String | Numerical identifier for the location (house/building number).                          |
| Complement\*        | String | Additional information regarding the address.                                           |
| Neighborhood\*      | String | Neighborhood of the address.                                                            |
| City\*              | String | City where the address is located.                                                      |
| State\*             | String | State where the address is situated.                                                    |
| Country\*           | String | Country of the address.                                                                 |
| Receiver Name\*     | String | Name of the individual who is the point of contact at the address.                      |
| Phone Number\*      | String | Contact number for the receiver.                                                        |
| Business Document\* | String | Document that contains essential business information (e.g. tax identification number). |

### Columns in the Members tab

This tab is required only for organization with multiple members. If the buyer organization has only one member, do not fill this information.

Check the default columns present in the Cost Centers tab in the table below. Mandatory information is marked with `*`.

| Column           | Type    | Description                                                                          |
| ---------------- | ------- | ------------------------------------------------------------------------------------ |
| Buyer Org ID\*   | String  | Unique identifier linking the member to a specific buyer organization.               |
| Cost Center ID\* | String  | Identifier linking the member to a specific cost center within the organization.     |
| Name\*           | String  | Member's full name used for identification and communication.                        |
| Email\*          | String  | Email address of the member serving as a primary point of contact for communication. |
| Role ID\*        | GUID    | Unique identifier denoting the member's role within the organization.                |
| Can Impersonate  | Boolean | Indicates if the member can impersonate another user within the system.              |

## Custom fields

To include custom fields in your spreadsheet, follow the steps below:

1. Add the desired custom fields as the last columns in your tab.
2. Use the prefix `CF_` followed by the exact name of the custom field as registered in the system.
   * Example: If you have a custom field named `DeliveryNote`, the column should be `CF_DeliveryNote`.
3. Fill in the values according to the data type.

Contributors

1

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

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/B2B-Suite/b2b-organizations/bulk-import-buyer-organizations-spreadsheet.md)

[Delivery Promise« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet//docs/guides/delivery-promise)[How to configure tradeName to use in the organization search fieldNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet//docs/guides/how-to-configure-tradename-to-use-in-the-organization-search-field)

Contributors

1

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

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23before-you-begin)

[Step-by-step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23step-by-step)

[File structure for import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23file-structure-for-import)

[File tabs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23file-tabs)[Columns in the Buyer Orgs tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-buyer-orgs-tab)[Columns in the cost centers tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-cost-centers-tab)[Columns in the Members tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-members-tab)

[Custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23custom-fields)

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/B2B-Suite/b2b-organizations/bulk-import-buyer-organizations-spreadsheet.md)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23before-you-begin)

[Step-by-step](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23step-by-step)

[File structure for import](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23file-structure-for-import)

[File tabs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23file-tabs)[Columns in the Buyer Orgs tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-buyer-orgs-tab)[Columns in the cost centers tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-cost-centers-tab)[Columns in the Members tab](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23columns-in-the-members-tab)

[Custom fields](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/bulk-import-buyer-organizations-spreadsheet/docs/guides/bulk-import-buyer-organizations-spreadsheet%23custom-fields)

On this page

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


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

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

[Assistant]
Documentation

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

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

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

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

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

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

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

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

Listrak

Official extension

Version: 2.6.1

Latest version: 2.6.1

## ⚠ Maintenance ⚠

_Starting June 1st 2023, this application will no longer be maintained by VTEX._

---

This app provides pixel integration for Listrak metrics and cart abandonment functionality, and provides related routes and blocks for use in an account's store-theme.

Additionally, if you would like the app to send Order, Product, and Customer data to Listrak, you can create a [Listrak Data Integration](#Listrak-Data-Integration).

## Configuration

1. [Install](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/store/installing-an-app) the `listrak-pixel` app in the desired account;
2. In the account's admin, access **Apps > My Apps** and then select the **Listrak** box;
3. Once in the app's page, define the app’s configurations in the **Setup** section:
* **Merchant ID**: Input your Listrak Merchant ID here.
* **Subscription Point ID**: Input your `Subscribe ID` of the email Subscription Point from your Listrak account.
* **Subscription Form IDs**: To capture a shoppers opt-in to an email subscription, enter the field IDs associated with the subscription form email input and submit button. Enter both IDs separated with commas and no spaces like `emailInputId,submitButtonId`. **If the Newsletter block from the `vtex.store-component` is used, no entry is necessary**.
* **Email Input Field IDs**: Listrak's cart abandonment feature works in part by capturing email addresses when shoppers type them into certain fields. These field IDs can be specified here, separated with commas and no spaces like `emailField1,emailField2`.
* **Preference Center Name**: This app creates a new store route with the path `/preference-center` which displays the Listrak Preference Center. Referencing your Listrak Preference Center integration instructions, input the value for the `data-ltk-prefcenter` attribute of the Preference Center div here.

The settings below are only needed if you have created a [Listrak Data Integration](#Listrak-Data-Integration).

* **Client ID**: Your Listrak Data Integration Client ID.
* **Client Secret**: Your Listrak Data Integration Client Secret.
* **Full Catalog Import**: Send your entire product catalog to Listrak. This will happen on the first SKU update after enabling the option.
* **Use SKU Reference ID**: Send Listrak SKU reference IDs instead of VTEX SKU IDs.
* **Image Size (in pixels)**: Set dimensions for images imported to Listrak. If left blank, the default size for your store's thumbnail images wil be used, usually 100x100 pixels.

**Listrak Fields and Values (Optional)**

The following optional settings allow you to map VTEX product specifications to specific Listrak fields. If left blank, they will be filled according to the default behavior explained below:

* **Category**: Input the name of the product specification field containing the product's main category. If left blank, this will be automatically set as the first category that the product belongs to.
* **Sub Category**: Input the name of the product specification field containing the product's secondary category. If left blank, this will be automatically set as "Type/Silhouette".
* **Meta 1**: Input the name of the product specification field containing any additional data you wish to send. If left blank, this will be automatically set as a pipe-separated list of the item's unique SKU specifications.
* **Meta 2**: Input the name of the product specification field containing any additional data you wish to send. If left blank, this will be automatically set with a placeholder value of "meta\_2".
* **Meta 3**: Input the name of the product specification field containing any additional data you wish to send. If left blank, this will be automatically set with a placeholder value of "meta\_3".

## (Optional) On-Site Recommendation Integration Block

To use this optional block in your `store-theme`, you must add the Listrak app to your `store-theme`'s peer dependencies in `manifest.json`:

`1

"peerDependencies": {

2

 "vtex.listrak-pixel": "1.x"

3

 }

`

Then you may use this block in your layouts:

* `"listrak-recommendations"`: The Listrak app provides this block which is designed to be added to the product page (`store.product`). It renders Listrak's On-Site Recommendations product shelf. The block takes two props:

| Prop name          | Type   | Description                                                             |
| ------------------ | ------ | ----------------------------------------------------------------------- |
| merchandiseBlockId | String | The Merchandise Block ID from Listrak's admin. Default: ''              |
| templateHTML       | String | The HTML template for the recommender from Listrak's admin. Default: '' |

:warning: Both props must be filled for the component to render.

Example - Listrak provides sample template code that looks like this:

`1

5

12

`

In this case, your block's props would look like this:

`1

"listrak-recommendations#example": {

2

 "props": {

3

 "merchandiseBlockId": "sample-merchandise-block-id",

4

 "templateHTML": "
@Recommendation.Title$@Recommendation.Price
"

5

 }

6

},

`

:warning: Note that the HTML has all been combined into a single line, and double quotes `"` replaced with single quotes `'`.

:warning: Also note that each `@Recommendation.LinkUrl` has been replaced with `@(window.location.origin + Recommendation.LinkUrl)`. This is because the `LinkUrl` stored for each product in Listrak is a relative URL. `ImageUrl` does NOT need this same treatment because each `ImageUrl` is already an absolute URL.

## Checkout Integration

To finalize a Listrak integration, custom JS code must be added to checkout in the `checkout6-custom.js` file:

`1

// Listrak

2

$(document).ready(function() {

3

 var prevItems = []

4

 $(window).on('orderFormUpdated.vtex', function(evt, orderForm) {

5

 ;(function() {

6

 if (typeof _ltk == 'object') {

7

 ltkCode()

8

 } else {

9

 ;(function(d) {

10

 if (document.addEventListener)

11

 document.addEventListener('ltkAsyncListener', d)

12

 else {

13

 e = document.documentElement

14

 e.ltkAsyncProperty = 0

15

 e.attachEvent('onpropertychange', function(e) {

16

 if (e.propertyName == 'ltkAsyncProperty') {

17

 d()

18

 }

19

 })

20

 }

21

 })(function() {

22

 ltkCode()

23

 })

24

 }

25

 function ltkCode() {

26

 _ltk_util.ready(function() {

27

 _ltk.SCA.CaptureEmail('client-pre-email')

28

 if (JSON.stringify(orderForm.items) != JSON.stringify(prevItems)) {

29

 if (orderForm.items.length > 0) {

30

 orderForm.items.forEach(item => {

31

 _ltk.SCA.AddItemWithLinks(

32

 item.id,

33

 item.quantity,

34

 (item.price / 100).toString(),

35

 item.name,

36

 item.imageUrl,

37

 item.detailUrl

38

 )

39

 })

40

 _ltk.SCA.Submit()

41

 } else {

42

 _ltk.SCA.ClearCart()

43

 }

44

 prevItems = orderForm.items

45

 }

46

 })

47

 }

48

 })()

49

 })

50

})

51

var biJsHost = 'https:' == document.location.protocol ? 'https://' : 'http://'

52

;(function(d, s, id, tid, vid) {

53

 var js,

54

 ljs = d.getElementsByTagName(s)[0]

55

 if (d.getElementById(id)) return

56

 js = d.createElement(s)

57

 js.id = id

58

 js.src =

59

 biJsHost + 'cdn.listrakbi.com/scripts/script.js?m=' + tid + '&v=' + vid

60

 ljs.parentNode.insertBefore(js, ljs)

61

})(document, 'script', 'ltkSDK', 'LISTRAK-MERCHANT-ID', '1')

62

// end Listrak

`

:warning: Make sure to replace `'LISTRAK-MERCHANT-ID'` in the second-to-last line with your Listrak Merchant ID. No other customizations are needed.

## Listrak Data Integration

Enabling this feature will send additional Order, Customer, and Product data to listrak.

* Orders data is sent when an order has been invoiced and/or updated if canceled.
* Customer data is sent when the order is invoiced.
* Product data is sent when a SKU has been created or updated.

To provide additional data to Listrak, you will need to create a new integration from the Listrak application and allow access to the Listrak API. Listrak provides some instructions [here](https://read.calvincode.net/reader?url=https://api.listrak.com/data%23section/INTEGRATION-SETUP).

**Access Levels**

The app supports sending Order, Customer, and Product data and will need these access levels selected.

**IP Address Whitelist**

There are three possible IPs the app may use to send data to the Listrak API, these will need to be added to the integration's whitelist.

* 34.199.112.14
* 107.23.210.212
* 52.73.206.45

## Customization

In order to apply CSS customizations to this and other blocks, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization).

| CSS Handles     |
| --------------- |
| recommendations |

See also

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

ON THIS PAGE

[⚠ Maintenance ⚠](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23-maintenance-)

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23configuration)

[(Optional) On-Site Recommendation Integration Block](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23optional-on-site-recommendation-integration-block)

[Checkout Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23checkout-integration)

[Listrak Data Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.listrak-pixel/docs/apps/vtex.listrak-pixel%23listrak-data-integration)

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

Was this helpful?

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