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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-shipping-network)

[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-tracking)

[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-pick-and-pack)

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/multilevel-omnichannel-inventory)

[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/setting-up-white-label-seller-as-pickup-point)

[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise)

---

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/delivery-promise/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

[VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-shipping-network)

[VTEX Tracking](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-tracking)

[VTEX Pick and Pack](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/vtex-pick-and-pack)

[Multilevel Omnichannel Inventory](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/multilevel-omnichannel-inventory)

[Pickup point](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/setting-up-white-label-seller-as-pickup-point)

[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise)

---

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/delivery-promise/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Logistics

[Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise)

Delivery Promise

Delivery Promise helps your store show only products that can be delivered or picked up based on the customer’s location. It improves shopping experience, reduces cart abandonment, and increases product assortment visibility.

> This feature is in beta, and we are actively working to improve it. If you have any questions, please contact [our Support](https://read.calvincode.net/reader?url=https://help.vtex.com/en/support).

**Delivery Promise** is a VTEX solution that provides accurate and reliable delivery estimates for available products based on the customer's location. It ensures that customers only see products that are in stock and can be delivered to their address or picked up at a nearby location. Using this solution, your store can guarantee delivery for every product a customer sees.

The content is organized as follows:

* [Available features](#available-features)
* [Advantages](#advantages)
* [Requirements and restrictions](#requirements-and-restrictions)
* [Delivery Promise for Store Framework](#delivery-promise-for-store-framework)
* [Delivery Promise for headless stores](#delivery-promise-for-headless-stores)
* [Delivery Promise for FastStore](#delivery-promise-for-faststore)

## Available features

When the customer provides their address, an initial selection of products is made, displaying only products that can be delivered to that location or picked up at pickup points within a radius of up to 50 km from the provided address — a limit determined by Checkout.

* Products available for the desired postal code.
* Product delivery deadlines.
* Products available in stores near the customer's location.
* Faster shipping methods for order delivery.
* [Pickup point](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/pickup-points--2fljn6wLjn8M4lJHA6HP3R) where the customer wants to pick up the order.

At this stage, **Delivery Promise** allows your store's customers to filter the products displayed during navigation by using these filters:

| Filter                 | Description                                                                             | Availability                                                    |
| ---------------------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------- |
| **Deliver to**         | Products available for delivery to the specified address.                               | Store Framework and FastStore (only on PLPs and search results) |
| **Pickup**             | Products available for pickup at locations within up to 50 km of the specified address. | Store Framework and FastStore (only on PLPs and search results) |
| **Pickup nearby**      | Products available for pickup at locations within up to 10 km of the specified address. | Store Framework and FastStore (only on PLPs and search results) |
| **Pickup at {{name}}** | Products available for pickup at a specific pickup point.                               | Store Framework and FastStore (only on PLPs and search results) |
| **Global filters**     | All products available in the store’s navigation.                                       | FastStore                                                       |

> The filters mentioned above are native components of Intelligent Search. If you want to develop custom components for your store, please contact your development team or an [implementation partner](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/4yPqZQyj0t675QpcG7H6yl%23implementation-partners).

## Advantages

**Delivery Promise** is suitable for all types of operations, as the solution provides many advantages for any business model. Learn about the store architecture requirements for participating in the current beta phase in the [Requirements and restrictions](#requirements-and-restrictions) section.

For [omnichannel](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/unified-commerce-strategies--3WGDRRhc3vf1MJb9zGncnv/2LGAiUnHES1enjHsfi8fI3) operations, the greater the coverage of the logistics network and the greater the number of sellers and [franchise accounts](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/what-is-a-franchise-account--kWQC6RkFSCUFGgY5gSjdl) associated with the operation, the greater the benefits. The table below shows the main advantages:

| **Advantage**                                            | **Details**                                                                                |
| -------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Fewer abandoned carts                                    | Customers often abandon an order after entering their location at the cart step when they find out that the products can't be shipped to their location or that the shipping time doesn't meet their expectations.With **Delivery Promise**, the availability and delivery feasibility of each product the customer sees on the product listing page are considered based on the customer's location. In addition, shipping information is displayed from the beginning of the customer's buying journey.                                                                                |
| Increased product assortment on the product listing page | Without **Delivery Promise**, the product assortment displayed on the product listing page may not reflect all available products from sellers due to limitations in features such as [seller regionalization](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/configure-seller-regionalization--32t6wLpQCEnumoh8TjT5fw), [Comprehensive Seller](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/comprehensive-seller--5Qn4O2GpjUIzWTPpvLUfkI) and the [seller selection algorithm](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/white-label-sellers-selection--3MemNQ4pKkWCpMdzI27AHa).With **Delivery Promise**, the customer can view the complete product assortment of all sellers, provided that:Sellers are correctly configured..Products are available in stock..Products have a valid shipping method to the address entered by the customer. |
| Improved shopping experience                             | **Delivery Promise** promotes a better shopping experience for the customer as a whole:It eliminates any frustration at checkout when they find it impossible to place an order.It allows customers to view more products.It allows customers to browse the storefront in a way that meets their needs, whether they prioritize the type of shipment or choose to place an order in a physical store.                                                                                |
| Promotion of physical store sales                        | **Delivery Promise** gives customers confidence in finding certain products in physical stores, which encourages them to go to the stores and increases sales opportunities.                                                                                |

## Requirements and restrictions

**Delivery Promise** requires the customer's location from the beginning of the buying journey, ensuring that only products with valid shipping methods are displayed on the product listing page. To join the current phase of **Delivery Promise**, you must meet the following conditions:

| Requirement                | Description                                                                                |
| -------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Install Intelligent Search | Install the [Intelligent Search](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-intelligent-search--19wrbB7nEQcmwzDPl1l4Cb/3qgT47zY08biLP3d5os3DG) app in your VTEX account. This app provides advanced search capabilities for your store.                                                                   |
| Install Session Manager    | Install the [Session Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-collecting-user-session-data) app in your VTEX account. This app enables your store to collect user session data.                                                                                |
| Build the storefront       | Build your store's frontend using [Store Framework](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/67SCtUreXxKYWhZh8n0zvZ%23store-framework) or [FastStore](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/vtex-store-overview--eSDNk26pdvemF3XKM0nK9/67SCtUreXxKYWhZh8n0zvZ%23faststore). |

> Check the [Delivery Promise visual library](https://read.calvincode.net/reader?url=https://www.figma.com/community/file/1545494767147168145) with [use cases](https://read.calvincode.net/reader?url=https://www.figma.com/design/a9urb9GGi7BTQkX92hIPp8/Delivery-Promise-by-VTEX--Community-?node-id=8001-14743%26p=f%26t=6WFsbpkt0lln18z1-0), [behavior specifications](https://read.calvincode.net/reader?url=https://www.figma.com/design/a9urb9GGi7BTQkX92hIPp8/Delivery-Promise-by-VTEX--Community-?node-id=8002-48329%26p=f%26t=6WFsbpkt0lln18z1-0) and [components](https://read.calvincode.net/reader?url=https://www.figma.com/design/a9urb9GGi7BTQkX92hIPp8/Delivery-Promise-by-VTEX--Community-?node-id=8001-14732%26p=f%26t=6WFsbpkt0lln18z1-0) to better understand how to apply it to your store.

## Delivery Promise for Store Framework

When building your storefront with Store Framework, you can enable Delivery Promise components using the [Shipping Option Components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.shipping-option-components) and [Search Result](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.search-result) apps.

Learn how to configure these components in the [Setting up Delivery Promise components (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-delivery-promise-components) guide.

## Delivery Promise for headless stores

When using a headless approach in your store, you can use the [Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/intelligent-search-api) to enable Delivery Promise. To learn how to apply it to your store, read the [Delivery Promise for headless stores (Beta)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise-for-headless-stores) guide.

## Delivery Promise for FastStore

When building your storefront with FastStore, you can enable Delivery Promise using hooks, filter options, and location priority. Learn how to apply it in the [Delivery Promise](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/features-delivery-promise) guide.

Contributors

2

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

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

Was this helpful?

Yes

No

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

[Pickup point« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise//docs/guides/setting-up-white-label-seller-as-pickup-point)[Bulk Import Buyer Organizations SpreadsheetNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise//docs/guides/bulk-import-buyer-organizations-spreadsheet)

See also

Contributors

2

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

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

ON THIS PAGE

[Available features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23available-features)

[Advantages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23advantages)

[Requirements and restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23requirements-and-restrictions)

[Delivery Promise for Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-store-framework)

[Delivery Promise for headless stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-headless-stores)

[Delivery Promise for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-faststore)

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/Logistics/delivery-promise.md)

Copy page

On this page

ON THIS PAGE

[Available features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23available-features)

[Advantages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23advantages)

[Requirements and restrictions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23requirements-and-restrictions)

[Delivery Promise for Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-store-framework)

[Delivery Promise for headless stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-headless-stores)

[Delivery Promise for FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/delivery-promise/docs/guides/delivery-promise%23delivery-promise-for-faststore)

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 login integration guide admin saml2 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/login-integration-guide-admin-saml2/docs/guides)

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

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

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

Guides

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

---

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

---

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

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

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

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

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

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

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

[Admin (SAML 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2)

[Webstore (OAuth 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-webstore-oauth2)

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

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

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

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

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

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

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

[Admin (SAML 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2)

[Webstore (OAuth 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-webstore-oauth2)

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

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

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Integration Guides

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

[Admin (SAML 2.0)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2)

Admin (SAML 2.0)

User management is a native feature of the VTEX platform. Store administrators can not only manage the users that can log in to the admin panel, but also specify which pages they can see and the operations they are allowed to perform using [roles](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/roles--7HKK5Uau2H6wxE1rH5oRbc). This granular control allows stores to adopt [best practices](https://read.calvincode.net/reader?url=https://developers.onelogin.com/saml/best-practices-and-faqs) in terms of security and compliance.

However, there is often the need to enable or enforce the use of credentials from a central authentication system used by the organization. This guide provides the basic information you need to integrate such an authentication system to the Admin panel for a Single Sign-On (SSO) experience.

> If you need to use an external identity provider to login to your Admin panel, it must adhere to the SAML 2.0 protocol. We do not currently support other authentication protocols for this scope.

## SAML

Security Assertion Markup Language (SAML) is a standard for exchanging authentication and authorization data between domains.

SAML 2.0 is an XML-based protocol that enables web-based cross-domain Web Browser Single Sign-On (SSO). It uses secure, digitally signed tokens and encrypted messages to pass data between trusted parties.

It is an open standard, a product of the OASIS Security Services Technical Committee, and is supported by major vendors in the industry. Learn more about [SAML](https://read.calvincode.net/reader?url=https://github.com/jch/saml).

## Authentication flow

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

## SAML roles

In the context of SAML, you should be aware of the different roles performed by the entities that exchange information during authentication.

### Identity Provider (IdP)

An **Identity Provider** (IdP) is a system that creates, maintains, and manages identity information for principals (users, services, or systems) and provides principal authentication to other Service Providers (applications) within a federation or distributed network.

An IdP is a trusted third party that can be relied upon when users and servers are establishing a dialog that must be authenticated. The IdP sends an attribute assertion containing trusted information about the user to the Service Provider. A user password is never sent to an SP.

### Service Provider (SP)

A **Service Provider** is an application server that communicates with an IdP to determine if a user has authenticated and obtain information about the user. The information obtained from the IdP may be used to make authorization decisions.

> In the context of this guide, the external authentication system is the **Identity Provider** and the module for identifying users on the VTEX platform, VTEX ID, is the **Service Provider**.

## SAML Assertions

SAML 2.0 uses assertions (packages) to pass information between the SP and the IdP. These packages contain information about a user (subject) and are written using the XML markup language. Although the standard specification defines [three types of subject-related assertion statements](https://read.calvincode.net/reader?url=http://saml.xml.org/assertions), VTEX only supports the **Authentication Assertion** type. We recommend the reading of [this document](https://read.calvincode.net/reader?url=https://github.com/jch/saml) to get a better understanding of the SAML protocol.

> An **Authentication Assertion** states that a user was authenticated by an external service at a particular time and is often used to enable web browser SSO.

## Integration

You can implement a custom SAML login option for your Admin panel by providing some information about the communication between VTEX and your **identity provider**. To do that:

1. Make sure that you have correctly [set up your identity provider](#identity-provider-configuration).
2. Guarantee that you possess all the [required information](#required-information).
3. Follow the [step by step setup](#setup).

### Identity provider configuration

If required by the identity provider, you must use the appropriate service provider `metadata.xml` file to configure the identity provider. It is available for download in the following URL:

`1

https://vtexid.vtex.com.br/api/vtexid/pub/saml/{accountName}/sp/metadata

`

If you do not use the file indicated above, configure your identity provider manually with the Assertion Consumer Service (ACS), **NameID** and **EntityDescriptor** present in the SP `metadata.xml`. URL:

* **ACS**:

`1

https://vtexid.vtex.com.br/api/vtexid/pub/saml/{accountName}/idps/{accountName}-saml/sso

`

* **NameID**:

`1

urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress

`

* **EntityDescriptor**:

`1

https://identity-broker.vtex.com/{accountName}/idps/{accountName}-saml

`

> The `entityID` of the **EntityDescriptor** is not a URL and must not be configured as one. It is an ID.\\n- The `{accountName}` is your business identification on the VTEX platform. It is the one you use inside the URL that gives access to your admin: `{accountName}.myvtex.com/admin`.

The identity provider must send the authenticated user's email in the **Name Identifier** (`saml:NameID`) variable. The response will be cryptographically signed with the certificate described in the Identity Provider's [Metadata](#metadata) file.

### Required information

In the table below you can learn more about the information you need to provide when [setting up SAML](#setup).

| **Information**      | **Description**                                                                                |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Provider Name        | Name displayed to unauthenticated users in the list of login options.                                                                                |
| SSO Service Endpoint | URL of your SAML Identity provider. Users will be redirected to this address. This URL must be HTTPS.                                                                                |
| Redirect URL         | You can choose to redirect users to one of two URLs: https://{accountName}.myvtex.com/ or https://{accountName}.myvtex.com/admin.                                                                                |
| Allowed Email Hosts  | List of hosts (the portion after the @ symbol in an email address) allowed for authentication. When a SAML Authentication Assertion is received by our platform, the email provided by the user is checked against the list of **Allowed Email Hosts**. Only emails with hosts listed here are allowed.                                                                                |
| Metadata             | XML file that must be uploaded to the VTEX platform. It must describe your identity provider in a way that allows our servers to redirect users to it and securely identify assertions made by it. It usually contains information like the SSO and Logout URLs as well as the certificate used by the identity provider to sign the assertions. The authentication system your organization is using should be capable of generating this file for you. Learn more about [SAML 2.0 metadata](https://read.calvincode.net/reader?url=http://docs.oasis-open.org/security/saml/v2.0/saml-metadata-2.0-os.pdf). This file must also contain the SSO Service Endpoint, described above. You can see an example file below. |

#### Example metadata file

`1

<?xml version="1.0"?>

2

<md:EntityDescriptor entityID="https://idp.example.org/SAML2" validUntil="2013-03-22T23:00:00Z"

3

 xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"

4

 xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"

5

 xmlns:ds="http://www.w3.org/2000/09/xmldsig#">

6

 <md:IDPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol" WantAuthnRequestsSigned="false">

7

 <md:KeyDescriptor use="signing">

8

 <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">

9

 <ds:X509Data>

10

 <ds:X509Certificate>...</ds:X509Certificate>

11

 </ds:X509Data>

12

 </ds:KeyInfo>

13

 </md:KeyDescriptor>

14

 <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat>

15

 <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://idp.example.org/SAML2/SSO/Redirect"/>

16

 <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://idp.example.org/SAML2/SSO/POST"/>

17

 </md:IDPSSODescriptor>

18

 <md:Organization>

19

 <md:OrganizationName xml:lang="en">Some Non-profit Organization of New York</md:OrganizationName>

20

 <md:OrganizationDisplayName xml:lang="en">Some Non-profit Organization</md:OrganizationDisplayName>

21

 <md:OrganizationURL xml:lang="en">https://www.example.org/</md:OrganizationURL>

22

 </md:Organization>

23

 <md:ContactPerson contactType="technical">

24

 <md:SurName>SAML Technical Support</md:SurName>

25

 <md:EmailAddress>mailto:saml-support@example.org</md:EmailAddress>

26

 </md:ContactPerson>

27

</md:EntityDescriptor>

`

### Setup

Once you have [setup your identity provider](#identity-provider-configuration) and have all the [required information](#required-information), follow these steps to set up SAML login:

1. Go to the **Admin panel** \> **Account settings** \> **Authentication**.
2. Click the **Admin** tab.
![{"base64":"  ","img":{"width":897,"height":530,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":23951,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/login-integration-guide-admin-saml2-1.PNG"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/login-integration-guide-admin-saml2-1.PNG)
3. Click `Set up` in the **My SAML** section.
4. Fill in the [required information](#required-information) as described above.
![{"base64":"  ","img":{"width":884,"height":518,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":30335,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/login-integration-guide-admin-saml2-2.PNG"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/login-integration-guide-admin-saml2-2.PNG)
5. Upload your metadata XML according to the information provided in [required information](#required-information).
![{"base64":"  ","img":{"width":885,"height":435,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":18603,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/login-integration-guide-admin-saml2-3.PNG"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/login-integration-guide-admin-saml2-3.PNG)
6. You have the option of setting the **Send AuthRequest** toggle. Turning it on means that the attributes `RelayState` and `SAMLRequest` will be sent on the URL when authenticating on the identity provider.
7. Click `Save`.

With this, your SAML configuration is set up.

### Edit existing SAML configuration

Once you created your SAML configuration, you may edit it by going through the same steps described above, in [Setup](#setup).

## Certificate renewals

When the certificate used by your **Identity Provider** to sign the assertions is about to expire, it's important to update the `metadata.xml` file in VTEX to allow for a seamless transition between the old and the new certificate.

This is done by including two `<md:KeyDescriptor use="signing">` entries in your exported file, as seen in the example below, where the `{OLD CERTIFICATE}` and `{NEW CERTIFICATE}` placeholders should be replaced by valid **X.509** certificates.

`1

<?xml version="1.0"?>

2

<md:EntityDescriptor entityID="https://idp.example.org/SAML2" validUntil="2013-03-22T23:00:00Z"

3

 xmlns:md="urn:oasis:names:tc:SAML:2.0:metadata"

4

 xmlns:saml="urn:oasis:names:tc:SAML:2.0:assertion"

5

 xmlns:ds="http://www.w3.org/2000/09/xmldsig#">

6

 <md:IDPSSODescriptor protocolSupportEnumeration="urn:oasis:names:tc:SAML:2.0:protocol" WantAuthnRequestsSigned="false">

7

 <md:KeyDescriptor use="signing">

8

 <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">

9

 <ds:X509Data>

10

 <ds:X509Certificate>{OLD CERTIFICATE}</ds:X509Certificate>

11

 </ds:X509Data>

12

 </ds:KeyInfo>

13

 </md:KeyDescriptor>

14

 <md:KeyDescriptor use="signing">

15

 <ds:KeyInfo xmlns:ds="http://www.w3.org/2000/09/xmldsig#">

16

 <ds:X509Data>

17

 <ds:X509Certificate>{NEW CERTIFICATE}</ds:X509Certificate>

18

 </ds:X509Data>

19

 </ds:KeyInfo>

20

 </md:KeyDescriptor>

21

 <md:NameIDFormat>urn:oasis:names:tc:SAML:1.1:nameid-format:emailAddress</md:NameIDFormat>

22

 <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-Redirect" Location="https://idp.example.org/SAML2/SSO/Redirect"/>

23

 <md:SingleSignOnService Binding="urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST" Location="https://idp.example.org/SAML2/SSO/POST"/>

24

 </md:IDPSSODescriptor>

25

 <md:Organization>

26

 <md:OrganizationName xml:lang="en">Some Non-profit Organization of New York</md:OrganizationName>

27

 <md:OrganizationDisplayName xml:lang="en">Some Non-profit Organization</md:OrganizationDisplayName>

28

 <md:OrganizationURL xml:lang="en">https://www.example.org/</md:OrganizationURL>

29

 </md:Organization>

30

 <md:ContactPerson contactType="technical">

31

 <md:SurName>SAML Technical Support</md:SurName>

32

 <md:EmailAddress>mailto:saml-support@example.org</md:EmailAddress>

33

 </md:ContactPerson>

34

</md:EntityDescriptor>

`

As the SP, VTEX ID must know of the new certificate or it will not be able to validate the signatures. And since the SP is unable to check at what stage of renewal the IdP is, it always checks if the signature validates for each of the listed certificates.

> We recommend checking if your IdP allows the configuration of a primary and secondary certificate to simplify the export process.

Once the old certificate expires, you may remove it from the `metadata.xml` file and re-upload it if you wish to avoid unnecessary requests in the **Send Valid Credentials** step of the [SAML authentication flow](#authentication-flow).

Contributors

3

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

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

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

Contributors

3

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

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

ON THIS PAGE

[SAML](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml)

[Authentication flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23authentication-flow)

[SAML roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml-roles)

[Identity Provider (IdP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23identity-provider-idp)[Service Provider (SP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23service-provider-sp)

[SAML Assertions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml-assertions)

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

[Identity provider configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23identity-provider-configuration)[Required information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23required-information)[Setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23setup)[Edit existing SAML configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23edit-existing-saml-configuration)

[Certificate renewals](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23certificate-renewals)

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/login-integration-guide/login-integration-guide-admin-saml2.md)

Copy page

On this page

ON THIS PAGE

[SAML](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml)

[Authentication flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23authentication-flow)

[SAML roles](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml-roles)

[Identity Provider (IdP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23identity-provider-idp)[Service Provider (SP)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23service-provider-sp)

[SAML Assertions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23saml-assertions)

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

[Identity provider configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23identity-provider-configuration)[Required information](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23required-information)[Setup](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23setup)[Edit existing SAML configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23edit-existing-saml-configuration)

[Certificate renewals](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/login-integration-guide-admin-saml2/docs/guides/login-integration-guide-admin-saml2%23certificate-renewals)

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

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

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

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

PowerReviews

Official extension

Version: 2.4.1

Latest version: 2.4.1

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

The PowerReviews app provides a way to bring your PowerReviews content into your VTEX store. The app also implements the PowerReviews Checkout Beacon during checkout, sending customer purchase data to the PowerReviews platform.

## Configuration

Before you can start using the app, you will need an existing [PowerReviews](https://read.calvincode.net/reader?url=https://www.powerreviews.com/) account and API key.

### Step 1 - Defining the app settings

In your VTEX account's admin, perform the following actions:

1. Access the **Apps** section and then **My Apps**.
2. Select the **PowerReviews** app box.
3. Complete the following required fields in the Settings section:
* `App Key` \- The API Key provided by PowerReviews.
* `Merchant ID` \- Your unique PowerReviews merchant ID.
* `Merchant Group ID` \- Your PowerReviews merchant group ID.
* `Client ID` \- Your PowerReviews Client ID
* `Client Secret` \- Your PowerReviews Client Secret
* `Send Email After Invoicing` \- Instead of sending email after checkout, we can send email after an order has been invoiced. Enabling this disables purchase pixel's ability to track checkout
* `API Unique Id` \- The product field used as the identifier (or pageId) on PowerReviews.

Optionally, the `Use Legacy Review Display Component` checkbox allows you to use the PowerReviews Review Display component instead of the VTEX Reviews component.

If needed, provide a URL path to a CSS stylesheet to override the styles of the PowerReviews Write-a-Review, Questions & Answers, or Review Display components.

### Step 2 - Update your store theme

1. Add the `powerreviews` app as a `peerDependency` in your theme's `manifest.json` file:

`1

 "peerDependencies": {

2

+ "vtex.powerreviews": "2.x"

3

 }

`

1. If not already present, add the following to your theme's `dependencies`:

`1

 "vtex.product-review-interfaces": "1.x",

2

 "vtex.product-summary-context": "0.x",

3

 "vtex.product-context": "0.x",

4

 "vtex.store-header": "2.x",

5

 "vtex.pixel-interfaces": "1.x",

6

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

`

### Step 3 - Defining the app's blocks

The PowerReviews app integrates with the following store framework blocks.

| Block name                    | Description                                                                                |
| ----------------------------- | ---------------------------------------------------------------------------------------------------------------- |
| product-reviews               | Display a paginated list of reviews for the product being viewed. This must be placed on the store.product page. |
| product-rating-summary        | Display the average rating for the product being viewed. This must be placed on the store.product page.          |
| product-rating-inline         | Display the average rating for the product being viewed, intended for use on the product shelf.                  |
| product-review-form           | Display the PowerReviews Write-a-Review form component. This must be placed on the product-review-form page.     |
| product-questions-and-answers | Display the PowerReviews Questions & Answers component for the product being viewed.                             |

An example of the blocks above in use:

`1

 "store.product": {

2

 "blocks": [

3

 "product-rating-summary",

4

 "product-reviews",

5

 "product-questions-and-answers"

6

 ]

7

 }

`

`1

 "store.product-review-form": {

2

 "blocks": [

3

 "product-review-form"

4

 ]

5

 }

`

See also

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

ON THIS PAGE

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

[Step 1 - Defining the app settings](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/apps/vtex.powerreviews%23step-1-defining-the-app-settings)[Step 2 - Update your store theme](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/apps/vtex.powerreviews%23step-2-update-your-store-theme)[Step 3 - Defining the app's blocks](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.powerreviews/docs/apps/vtex.powerreviews%23step-3-defining-the-apps-blocks)

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