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

[User] Explain the VTEX api reference payments gateway api API and how to use it.

[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/api-reference/payments-gateway-api/docs/guides)

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

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

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

API Reference

Filter By

Post

Get

Put

Delete

Patch

[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/antifraud-provider-protocol/)

---

[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/audience-api/)

---

[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/buyer-organizations/)

---

[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/budgets-api/)

---

[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/legacy-cms-portal-api/)

---

[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/card-token-vault-api/)

---

[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/catalog-api-seller-portal/)

---

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

---

[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/checkout-api/)

---

[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/customer-credit-api/)

---

[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/delivery-promise-notification-api/)

---

[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/giftcard-api/)

---

[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/giftcard-provider-protocol/)

---

[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/giftcard-hub-api/)

---

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/headless-cms-api/)

---

[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/intelligent-search-api/)

---

[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/intelligent-search-events-api-headless/)

---

[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/license-manager-api/)

---

[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/logistics-api/)

---

[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/marketplace-apis/)

---

[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/marketplace-protocol/)

---

[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/master-data-api-v2/)

---

[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/masterdata-api/)

---

[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/message-center-api/)

---

[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/mtls-api/)

---

[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/operational-capacity-api/)

---

[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/orders-api/)

---

[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/organization-units-api/)

---

[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/payment-provider-protocol/)

---

[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/payments-gateway-api/)

Installments

Configuration

Transaction Process

Transaction Flow

Payment Notification

---

[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/pick-and-pack-api/)

---

[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/pick-and-pack-protocol-api/)

---

[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/pick-and-pack-order-changes-api/)

---

[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/policies-system-api/)

---

[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/pricing-api/)

---

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

---

[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/promotions-and-taxes-api/)

---

[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/promotions-and-taxes-api-v2/)

---

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

---

[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/reviews-and-ratings-api/)

---

[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/recommendations-bff-api/)

---

[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/sku-bindings-api/)

---

[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/search-api/)

---

[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/session-manager-api/)

---

[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/ssl-certificates-api/)

---

[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/storefront-permissions-api/)

---

[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/subscriptions-api-v3/)

---

[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/vtex-ads-api/)

---

[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/vtex-shipping-network-api/)

---

[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/tracking/)

---

[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/vtex-do-api/)

---

[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/vtex-id-api/)

---

[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/profile-system/)

---

[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/orders-api-pii-version/)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/guides)

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

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

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

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

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

---

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

API Reference

Filter By

Post

Get

Put

Delete

Patch

[Anti-fraud Provider API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/antifraud-provider-protocol/)

---

[Audience API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/audience-api/)

---

[Buyer organizations](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/buyer-organizations/)

---

[Budgets API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/budgets-api/)

---

[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/legacy-cms-portal-api/)

---

[Card Token Vault API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/card-token-vault-api/)

---

[Catalog API - Seller Portal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/catalog-api-seller-portal/)

---

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

---

[Checkout API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/checkout-api/)

---

[Customer Credit API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/customer-credit-api/)

---

[Delivery Promise Notification API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/delivery-promise-notification-api/)

---

[GiftCard API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/giftcard-api/)

---

[Giftcard Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/giftcard-provider-protocol/)

---

[GiftCard Hub API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/giftcard-hub-api/)

---

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/headless-cms-api/)

---

[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/intelligent-search-api/)

---

[Intelligent Search Events API - Headless](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/intelligent-search-events-api-headless/)

---

[License Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/license-manager-api/)

---

[Logistics API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/logistics-api/)

---

[Marketplace API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/marketplace-apis/)

---

[Marketplace Protocol](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/marketplace-protocol/)

---

[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/master-data-api-v2/)

---

[Master Data API - v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/masterdata-api/)

---

[Message Center API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/message-center-api/)

---

[mTLS API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/mtls-api/)

---

[Operational Capacity API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/operational-capacity-api/)

---

[Orders API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/orders-api/)

---

[Organization Units API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/organization-units-api/)

---

[Payment Provider Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/payment-provider-protocol/)

---

[Payments Gateway API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/payments-gateway-api/)

Installments

Configuration

Transaction Process

Transaction Flow

Payment Notification

---

[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/pick-and-pack-api/)

---

[Pick and Pack Last Mile Protocol API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/pick-and-pack-protocol-api/)

---

[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/pick-and-pack-order-changes-api/)

---

[Policies System API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/policies-system-api/)

---

[Pricing API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/pricing-api/)

---

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

---

[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/promotions-and-taxes-api/)

---

[Promotions & Taxes API v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/promotions-and-taxes-api-v2/)

---

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

---

[Reviews and Ratings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/reviews-and-ratings-api/)

---

[Recommendations BFF API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/recommendations-bff-api/)

---

[SKU Bindings API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/sku-bindings-api/)

---

[Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/search-api/)

---

[Session Manager API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/session-manager-api/)

---

[SSL Certificates API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/ssl-certificates-api/)

---

[Storefront Permissions API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/storefront-permissions-api/)

---

[Subscriptions API (v3)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/subscriptions-api-v3/)

---

[VTEX Ads API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/vtex-ads-api/)

---

[VTEX Shipping Network API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/vtex-shipping-network-api/)

---

[VTEX Tracking APIs](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/tracking/)

---

[VTEX DO API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/vtex-do-api/)

---

[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/vtex-id-api/)

---

[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/profile-system/)

---

[Orders API - PII Data Architecture (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/orders-api-pii-version/)

---

[GeGet Credentials« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/payment-provider-protocol%23get-/authorization/credentials)[GeGet installments optionsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/payments-gateway-api/docs/api-reference/payments-gateway-api%23get-/api/pvt/installments)

[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 remove all items from cart 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/remove-all-items-from-cart/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/custom-data-1)

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

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

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

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/checkout-security)

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

[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/simulate-a-shopping-cart)

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

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

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

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

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

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

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

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

[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/get-cart-installments-information)

[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/add-coupons-to-the-cart)

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

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

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/checkout-error-codes)

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

[Custom Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/custom-data-1)

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

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

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

[Order Placement](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/orders-2)

[Security](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/checkout-security)

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

[Simulate a shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/simulate-a-shopping-cart)

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

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

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

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

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

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

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

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

[Get cart installments information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/get-cart-installments-information)

[Add coupons to the cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/add-coupons-to-the-cart)

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

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

[Configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/configuration-section-api-quick-start-guides)

[Fulfillment](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/fulfillment-checkout-section-api-quick-start-guides)

[Region](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/region-section-api-quick-start-guides)

[Checkout error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/checkout-error-codes)

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

Remove all items from cart

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

This guide will describe how to remove all items from a shopping cart by the API.

## Getting and accessing shopping cart information

The first step is to get the `orderFormId` and access the shopping cart information that you want to remove the items from. To do so, access the [Get cart information by ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/get-cart-information-by-id) guide.

See below an example of item details contained in a shopping cart:

`1

...

2

"items": [

3

 {

4

 "uniqueId": "C6D260865A4B4609B494973D96790104",

5

 "id": "5",

6

 "productId": "7",

7

 "productRefId": "",

8

 "refId": null,

9

 "ean": "978020137962",

10

 "name": "Ultra Moisturizing Milk Conditioner 100 ml",

11

 "skuName": "100 ml",

12

 "modalType": null,

13

 "parentItemIndex": null,

14

 "parentAssemblyBinding": null,

15

 "assemblies": [],

16

 "priceValidUntil": "2023-10-11T16:31:28Z",

17

 "tax": 0,

18

 "taxCode": "54WC8ZN6K8" ,

19

 "price": 4490,

20

 "listPrice": 4490,

21

 "manualPrice": null,

22

 "manualPriceAppliedBy": null,

23

 "sellingPrice": 448509,

24

 "rewardValue": 0,

25

 "isGift": false,

26

 "additionalInfo": {

27

 "dimension": null,

28

 "brandName": "VALDIE&CO",

29

 "brandId": "2000000",

30

 "offeringInfo": null,

31

 "offeringType": null,

32

 "offeringTypeId": null

33

 },

34

 "preSaleDate": null,

35

 "productCategoryIds": "/4/1/",

36

 "productCategories": {

37

 "1": "Treatments",

38

 "4": "Stylers"

39

 },

40

 "quantity": 1,

41

 "seller": "cosmetics1",

42

 "sellerChain": [

43

 "cosmetics1"

44

 ],

45

 "imageUrl": "http://cosmetics2.vteximg.com.br/arquivos/ids/155403-55-55/Ultra-Moisturizing-Milk-Conditioner.jpg?v=637109315995300000",

46

 "detailUrl": "/ultra-moisturizing-milk-conditioner/p",

47

 "components": [],

48

 "bundleItems": [],

49

 "attachments": [],

50

 "attachmentOfferings": [],

51

 "offerings": [],

52

 "priceTags": [

53

 {

54

 "name": "discount@price-0e45a4e3-6084-4bf9-bff7-0fe8403699fc#5aeb71dd-f6dd-4a2d-a624-d635f20e7cd0",

55

 "value": -491,

56

 "rawValue": -4.91,

57

 "isPercentual": false,

58

 "identifier": "0e45a4e3-6084-4bf9-bff7-0fe8403699fc",

59

 "owner": "cosmetics2"

60

 }

61

 ],

62

 "availability": "available",

63

 "measurementUnit": "mg",

64

 "unitMultiplier": 100.0000,

65

 "manufacturerCode": null,

66

 "priceDefinition": {

67

 "calculatedSellingPrice": 448509,

68

 "total": 448509,

69

 "sellingPrices": [

70

 {

71

 "value": 448509,

72

 "quantity": 1

73

 }

74

 ]

75

 }

76

 },

77

 ...

`

>  For more information about the meaning of each of the fields available in the shopping cart, access the [orderForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/orderform-fields) overview.

## Removing all items from the shopping cart

To remove all items from the shopping cart, you need to use the [Remove all items](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/reference/removeallitems) endpoint. In this request, the `ordeFormId` of the shopping cart must be sent through the URL request, as shown by the example below:

`https://{accountname}.{environment.com.br}/api/checkout/pub/orderForm/{orderFormId}/items/removeAll`

Additionally, you need to send the request body containing only two curly brackets, as shown below:

`1

{}

`

After sending the request, the endpoint will return the response body with all item information removed from the shopping cart (`"items"` field empty).

`1

...

2

"items": [],

3

...

`

## Error codes

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

### 400 - Bad Request

* **Message error example (code ORD002)**: `"Carrinho inválido"` (_Invalid Cart_): this message indicates that the `orderFormId` used in the request does not exist or is incorrect.

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "ORD002",

5

 "message": "Carrinho inválido",

6

 "exception": null

7

 },

8

 "operationId": "5d37a185-bfe6-4686-9d92-aac9482cc63d"

9

}

`

* **Message error example (code 001)**: `"Bad Request"`: this message indicates that information other than `{}` was sent in the request body.

`1

{

2

 "fields": {},

3

 "error": {

4

 "code": "001",

5

 "message": "Bad request",

6

 "exception": null

7

 },

8

 "operationId": "91b68251-1a60-4716-b846-c7c9c31fa565"

9

}

`

### 404 - Not Found

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

`1

2

404 Not Found

3

The requested URL was not found on this server.

4

`

Contributors

2

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

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

Was this helpful?

Yes

No

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

[Get cart information by ID« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart//docs/guides/get-cart-information-by-id)[Remove all personal data from cartNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart//docs/guides/remove-all-personal-data)

Contributors

2

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

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

ON THIS PAGE

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

[Removing all items from the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/remove-all-items-from-cart%23removing-all-items-from-the-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/remove-all-items-from-cart%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/remove-all-items-from-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/remove-all-items-from-cart%23404-not-found)

Was this helpful?

 Send feedback

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

Copy page

On this page

ON THIS PAGE

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

[Removing all items from the shopping cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/remove-all-items-from-cart%23removing-all-items-from-the-shopping-cart)

[Error codes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/remove-all-items-from-cart%23error-codes)

[400 - Bad Request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/remove-all-items-from-cart%23400-bad-request)[404 - Not Found](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/remove-all-items-from-cart/docs/guides/remove-all-items-from-cart%23404-not-found)

On this page

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


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

[User] Provide a guide on guides faststore organisms newsletter in VTEX.

[Assistant]
Documentation

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

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

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

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

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

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

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

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/molecules-overview)

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

[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-banner-text)

[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-cart-sidebar)

[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-empty-state)

[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-filter-slider)

[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-filter)

[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-hero)

[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-image-gallery)

[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-navbar-slider)

[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-navbar)

[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter)

[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-out-of-stock)

[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-payment-methods)

[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-price-range)

[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-product-grid)

[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-product-shelf)

[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-region-modal)

[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-search-input)

[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-shipping-simulation)

[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-slide-over)

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

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

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

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

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

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

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

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

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

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

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

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

---

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

Storefront Development

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

---

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

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

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

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

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

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

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

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

[Atoms](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/atoms-overview)

[Molecules](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/molecules-overview)

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

[BannerText](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-banner-text)

[CartSidebar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-cart-sidebar)

[EmptyState](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-empty-state)

[FilterSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-filter-slider)

[Filter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-filter)

[Hero](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-hero)

[ImageGallery](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-image-gallery)

[NavbarSlider](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-navbar-slider)

[Navbar](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-navbar)

[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter)

[OutOfStock](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-out-of-stock)

[PaymentMethods](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-payment-methods)

[PriceRange](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-price-range)

[ProductGrid](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-product-grid)

[ProductShelf](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-product-shelf)

[RegionModal](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-region-modal)

[SearchInput](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-search-input)

[ShippingSimulation](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-shipping-simulation)

[SlideOver](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-slide-over)

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

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

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

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

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

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

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

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

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

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

---

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

---

(Legacy) CMS Portal

---

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

---

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

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

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

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

Newsletter

The `Newsletter` component is a section with at least one input text with an action allowing users to submit their input.

[ Source code](https://read.calvincode.net/reader?url=https://github.com/vtex/faststore/tree/main/packages/components/src/organisms/Newsletter)

Uses `NewsletterForm`, `NewsletterHeader` and `NewsletterContent` as compound components.

Example

Code

### Get News and Special Offers!

Receive our news and promotions in advance. Enjoy and get 10% off your first purchase. For more information click here.

Name

Email

By subscribing to our newsletter you agree to to our Privacy Policy.

Subscribe

## Usage

### Import the component

`1

import {

2

 Newsletter,

3

 NewsletterAddendum,

4

 NewsletterContent,

5

 NewsletterForm,

6

 NewsletterHeader,

7

} from "@faststore/ui";

`

### Import styles

To apply styles, include the following in your stylesheet:

`1

@import "@faststore/ui/src/components/organisms/Newsletter/styles.scss";

`

For details, see [Importing FastStore UI component styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/using-themes-importing-ui-components-styles).

---

## Examples

Example

Code

### Get News and Special Offers!

Receive our news and promotions in advance. Enjoy and get 10% off your first purchase. For more information click here.

Name

Email

By subscribing to our newsletter you agree to to our Privacy Policy.

Subscribe

### Get News and Special Offers!

Receive our news and promotions in advance. Enjoy and get 10% off your first purchase. For more information click here.

Name

Email

By subscribing to our newsletter you agree to to our Privacy Policy.

Subscribe

### Color variants

#### Main

Example

Code

### Get News and Special Offers!

Receive our news and promotions in advance. Enjoy and get 10% off your first purchase. For more information click here.

Name

Email

By subscribing to our newsletter you agree to to our Privacy Policy.

Subscribe

#### Light

Example

Code

### Get News and Special Offers!

Receive our news and promotions in advance. Enjoy and get 10% off your first purchase. For more information click here.

Name

Email

By subscribing to our newsletter you agree to to our Privacy Policy.

Subscribe

#### Accent

Example

Code

### Get News and Special Offers!

Receive our news and promotions in advance. Enjoy and get 10% off your first purchase. For more information click here.

Name

Email

By subscribing to our newsletter you agree to to our Privacy Policy.

Subscribe

---

## Design tokens

| Local token                      | Default value/Global token linked |
| -------------------------------- | --------------------------------- |
| \--fs-newsletter-padding-mobile  | var(--fs-spacing-5)               |
| \--fs-newsletter-padding-desktop | var(--fs-spacing-9) 10%           |
| \--fs-newsletter-border-radius   | var(--fs-border-radius)           |

### Title

| Local token                   | Default value/Global token linked |
| ----------------------------- | --------------------------------- |
| \--fs-newsletter-title-size   | var(--fs-text-size-title-section) |
| \--fs-newsletter-title-weight | var(--fs-text-weight-bold)        |

### Icon

| Local token                | Default value/Global token linked |
| -------------------------- | --------------------------------- |
| \--fs-newsletter-icon-size | var(--fs-spacing-5)               |

### Variants

#### Card

| Local token                         | Default value/Global token linked |
| ----------------------------------- | --------------------------------- |
| \--fs-newsletter-card-border-radius | var(--fs-border-radius)           |

#### Main

| Local token                      | Default value/Global token linked |
| -------------------------------- | --------------------------------- |
| \--fs-newsletter-main-bkg-color  | var(--fs-color-primary-bkg)       |
| \--fs-newsletter-main-text-color | var(--fs-color-primary-text)      |

#### Light

| Local token                       | Default value/Global token linked   |
| --------------------------------- | ----------------------------------- |
| \--fs-newsletter-light-bkg-color  | var(--fs-color-secondary-bkg-light) |
| \--fs-newsletter-light-text-color | var(--fs-color-text-display)        |

#### Accent

| Local token                        | Default value/Global token linked     |
| ---------------------------------- | ------------------------------------- |
| \--fs-newsletter-accent-bkg-color  | var(--fs-color-highlighted-bkg)       |
| \--fs-newsletter-accent-text-color | var(--fs-newsletter-light-text-color) |

---

## Data attributes

You can target and override `Newsletter` styles using the following data attributes:

`data-fs-newsletter`

`data-fs-newsletter-color-variant="main" | "light" | "accent"`

`data-fs-newsletter-form`

`data-fs-newsletter-header`

`data-fs-newsletter-header-title`

`data-fs-newsletter-header-description`

`data-fs-newsletter-content`

`data-fs-newsletter-addendum`

## Creating the Newsletter data entity in VTEX Master Data

The Newsletter data entity, also known as the `NL` acronym, is a [Master Data](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw?%26utm%5Fsource=autocomplete) entity that stores subscription information for the Newsletter component. This entity enables the newsletter subscription feature for stores using FastStore.

When customers subscribe to the store newsletter, their information is saved in the `NL` entity. For the newsletter to operate, such as when a user subscribes, the `NL` entity must be set up in the Master Data.

To create the `NL` entity, follow the instructions below based on the method you prefer: [creating via Admin](#creating-via-admin) or [creating via API](#creating-via-api).

> For more details about Master Data data entities, see the [data entity](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/data-entity--tutorials%5F1265) article.

### Creating via Admin

1. In the VTEX Admin, go to **Store Settings > Storefront > Master Data**.
2. In Master Data, click **Applications > Advanced Settings > Data structure**.
3. Click the **Data Entities** tab.
4. Click `Add new`.
5. Complete the fields of the **Data Entity** section with the following information:
| **Field name**       | **Value**              |
| -------------------- | ---------------------- |
| **Acronym**          | NL                     |
| **Name**             | Newsletter             |
| **Primary key type** | Generate a unique GUID |
6. In the **Fields** tab, create three new fields:
**Field 1**
This field will store the customer's email address for newsletter subscription.
   1. Click `New Field` and complete the fields with the following values:
   | **Name** | **Display Name** | **Type** |
   | -------- | ---------------- | -------- |
   | email    | Email            | Email    |
   2. Click the gear icon (⚙) to open the field configuration options and check all the following options:
         * **Is nullable?**
         * **Make readable without credentials**
         * **Allow editing without credentials**
         * **Allow filtering without credentials**
   3. In the **Search and filter settings** section, check the **Is searchable?** and **Is filterable?** options.
![{"base64":"  ","img":{"width":1357,"height":463,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":29863,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/newsletter-field-1___61c595999569e52175f1de93d9ecd8f0.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/newsletter-field-1___61c595999569e52175f1de93d9ecd8f0.png)
**Field 2**
This field will indicate whether the user will receive the newsletter.
   1. Click `New field` and complete the fields with the following values:
| **Name**          | **Display Name**    | **Type** |
| ----------------- | ------------------- | -------- |
| isNewsletterOptIn | Receive newsletter? | Boolean  |
   1. Click the gear icon ⚙ to open the field configuration options and check all the following options:
   * **Make readable without credentials**
   * **Allow editing without credentials**
   * **Allow filtering without credentials**
   1. In the **Search and filter settings** section, check the **Is searchable?** and **Is filterable?** options.
![{"base64":"  ","img":{"width":1359,"height":511,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":33839,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/newsletter-field-2___62281c88b10436ce052707080cc5173e.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/newsletter-field-2___62281c88b10436ce052707080cc5173e.png)
**Field 3**
This field will store the user’s name.
   1. Click `New Field` and complete the fields with the following values:
   | **Name** | **Display Name** | **Type**    |
   | -------- | ---------------- | ----------- |
   | name     | Name             | Varchar 750 |
   2. Click the gear icon (⚙) to open the field configuration options and check all the following options:
         * **Make readable without credentials**
         * **Allow editing without credentials**
         * **Allow filtering without credentials**
   3. In the **Search and filter settings** section, check the **Is searchable?** and **Is filterable?** options.
![{"base64":"  ","img":{"width":1357,"height":682,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":41773,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/newsletter-field-3___4e7d9fec7f0a827c5d49908df0e2f20b.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/newsletter-field-3___4e7d9fec7f0a827c5d49908df0e2f20b.png)
7. Click `Save` and you will be redirected back to the Data Entity tab.
8. In the row of the new `NL` entity, click the diskette 💾 to publish the created data entity.
9. Click `OK`.
10. Click the **Applications** tab to return to the Master Data homepage.
11. Click `Reload applications`.

### Creating via API

You can also create the Newsletter data entity using the [Create partial document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23patch-/api/dataentities/-acronym-/documents) endpoint.

To create the three fields for the Newsletter data entity, see the [Create document with custom ID or update entire document](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/masterdata-api%23put-/api/dataentities/-acronym-/documents/-id-) endpoint reference.

> The field information must be the same as described in [Creating via Admin](#creating-via-admin).

---

## Props

### Newsletter

| Name             | Type              | Description                                                                            | Default                                              |      |
| ---------------- | ----------------- | -------------------------------------------------------------------------------------- | ---------------------------------------------------- | ---- |
| **card\***       | false \| true     | Enables the card Variant.                                                              |                                                      |      |
| **colorVariant** | "main" \| "light" | "accent"                                                                               | Specifies the component's color variant combination. | main |
| **testId**       | string            | ID to find this component in testing tools (e.g.: Cypress, Testing Library, and Jest). | fs-newsletter                                        |      |

### NewsletterAddendum

| Name         | Type   | Description                                                                            | Default                |
| ------------ | ------ | -------------------------------------------------------------------------------------- | ---------------------- |
| **addendum** | string | Specifies the addendum for the subscription.                                           |                        |
| **testId**   | string | ID to find this component in testing tools (e.g.: Cypress, Testing Library, and Jest). | fs-newsletter-addendum |

### NewsletterContent

| Name       | Type   | Description                                                                            | Default               |
| ---------- | ------ | -------------------------------------------------------------------------------------- | --------------------- |
| **testId** | string | ID to find this component in testing tools (e.g.: Cypress, Testing Library, and Jest). | fs-newsletter-content |

### NewsletterForm

| Name           | Type                                | Description                                                                            | Default            |
| -------------- | ----------------------------------- | -------------------------------------------------------------------------------------- | ------------------ |
| **onSubmit\*** | (event: FormEvent<Element>) => void | Function called when submit button is clicked.                                         |                    |
| **testId**     | string                              | ID to find this component in testing tools (e.g.: Cypress, Testing Library, and Jest). | fs-newsletter-form |

### NewsletterHeader

| Name            | Type             | Description                                                                            | Default              |    |                          |                             |                     |             |                       |
| --------------- | ---------------- | -------------------------------------------------------------------------------------- | -------------------- | -- | ------------------------ | --------------------------- | ------------------- | ----------- | --------------------- |
| **icon**        | string \| number | false                                                                                | true                 | {} | ReactElement<any, string | JSXElementConstructor<any>> | Iterable<ReactNode> | ReactPortal | Icon for the section. |
| **title\***     | string           | Title for the section.                                                                 |                      |    |                          |                             |                     |             |                       |
| **description** | string           | A description for the section.                                                         |                      |    |                          |                             |                     |             |                       |
| **testId**      | string           | ID to find this component in testing tools (e.g.: Cypress, Testing Library, and Jest). | fs-newsletter-header |    |                          |                             |                     |             |                       |

Contributors

3

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/_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/faststore/organisms-newsletter/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F3356699%3Fv%3D4%26w=64%26q=75)](https://github.com/hellofanny)

Was this helpful?

Yes

No

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

[Navbar« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-navbar)[OutOfStockNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-out-of-stock)

Contributors

3

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

[![Photo of the contributor](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/_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/faststore/organisms-newsletter/_next/image?url=https%3A%2F%2Favatars.githubusercontent.com%2Fu%2F3356699%3Fv%3D4%26w=64%26q=75)](https://github.com/hellofanny)

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23usage)

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23import-styles)

[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23examples)

[Color variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23color-variants)

[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23design-tokens)

[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23title)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23icon)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23variants)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23data-attributes)

[Creating the Newsletter data entity in VTEX Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23creating-the-newsletter-data-entity-in-vtex-master-data)

[Creating via Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23creating-via-admin)[Creating via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23creating-via-api)

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

[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newsletter)[NewsletterAddendum](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newsletteraddendum)[NewsletterContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newslettercontent)[NewsletterForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newsletterform)[NewsletterHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newsletterheader)

Was this helpful?

 Send feedback

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

Copy page

On this page

ON THIS PAGE

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23usage)

[Import the component](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23import-the-component)[Import styles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23import-styles)

[Examples](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23examples)

[Color variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23color-variants)

[Design tokens](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23design-tokens)

[Title](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23title)[Icon](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23icon)[Variants](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23variants)

[Data attributes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23data-attributes)

[Creating the Newsletter data entity in VTEX Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23creating-the-newsletter-data-entity-in-vtex-master-data)

[Creating via Admin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23creating-via-admin)[Creating via API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23creating-via-api)

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

[Newsletter](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newsletter)[NewsletterAddendum](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newsletteraddendum)[NewsletterContent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newslettercontent)[NewsletterForm](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newsletterform)[NewsletterHeader](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/organisms-newsletter/docs/guides/faststore/organisms-newsletter%23newsletterheader)

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