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

[User] Provide a guide on guides vtex io documentation setting up google tag manager in VTEX.

[Assistant]
Documentation

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

[GuidesLearn how to use our APIs and extend the VTEX platform.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/api-reference)

[App DevelopmentLearn how to build cloud-based apps and integrations.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/app-development)

[Storefront DevelopmentExpress your brand identity creating unique storefronts.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/storefront-development)

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

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/troubleshooting)

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework)

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

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-using-advanced-layouts)

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

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-dealing-with-events)

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

[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)

[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)

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

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-managing-performance)

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

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-go-live)

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

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/faststore)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework)

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

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/getting-started-3)

Concepts

[Building pages](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-building-pages)

[Using components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-using-components)

[Using advanced layouts](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-using-advanced-layouts)

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

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-styling)

[Dealing with events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-dealing-with-events)

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

[Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-installing-google-tag-manager)

[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)

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

[Handling internationalization](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-multi-language-stores)

[Routing](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-routing)

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework-managing-performance)

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

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-go-live)

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

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/storefront-best-practices)

---

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/storefront-development)

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/store-framework)

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

[Setting up Google Tag Manager events and triggers](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager)

Setting up Google Tag Manager

Explore how to track and analyze store data using Google Analytics 4.

After installing the VTEX IO [Google Tag Manager app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.google-tag-manager), configure the necessary variables, triggers, and tags to set it up in your store.

In this guide, you will learn how to track and analyze store data using Google Analytics 4 (GA4). The guide covers:

* Configuring GA4 events by downloading and importing a container file; adding the necessary tags, triggers, and variables; and updating the Measurement ID field with your Google tag ID.
* Testing the GA4 Configuration tag to ensure it fires correctly on every page and confirming that GA4 Event tags accurately track user actions, such as viewing a product or adding a product to the cart.
* Using Google Analytics DebugView and Reports to check if events are being received and data is populating your reports.
* Tracking key user actions — including product impressions, add-to-cart events, and completed orders — by leveraging Pixel Apps and GA4 events.

## Before you begin

### Get the VTEX IO Google Tag Manager app

Install and configure the VTEX IO Google Tag Manager app. For more information, see the guide [Installing Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-installing-google-tag-manager).

### Create a Google Analytics 4 (GA4) Configuration tag

Create a Google Analytics 4 (GA4) Configuration tag using your Measumerent ID in [Google Tag Manager (GTM)](https://read.calvincode.net/reader?url=https://tagmanager.google.com/). For more information, see the Google article [Set up the Google Analytics 4 Configuration tag](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/9442095).

## Instructions

### Step 1 - Setting up GA4 events

After creating the GA4 Configuration tag, set up GA4 events as follows:

1. Download the [GTM container file](https://read.calvincode.net/reader?url=https://developers.vtex.com/container-template.json) to preload all necessary tags, triggers, and variables.
2. Import the container file by following Google’s [Import a container](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/6106997?%23import) guide. This will add all the necessary tags, triggers, and variables to the workspace.
![{"base64":"  ","img":{"width":946,"height":1281,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":210180,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/new-ga4-tags-variables___b2619df57689429d97a8abd56a5f7d83.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/new-ga4-tags-variables___b2619df57689429d97a8abd56a5f7d83.png)
3. In the GTM container, go to the GA4 Configuration tag, and edit the **Measurement ID** field with your Google tag ID (G- ID).
> To find your Google tag ID, check the [Find your Google tag ID](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/9539598?sjid=16676572490197811169-SA%23find-G-ID) guide.

### Step 2 - Testing tags in Google Tag Manager

To test if the GA4 Configuration tag is firing correctly on every page, use the [Preview mode](https://read.calvincode.net/reader?url=https://support.google.com/tagmanager/answer/6107056) in GTM. Additionally, check if the GA4 Event tags are firing accurately for user actions, such as viewing a product or adding a product to the cart.

### Step 3 - Testing events sent to Google Analytics 4

To check if the events are being received and the reports are populated with data, go to the Google Analytics Admin and use the [DebugView](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/7201382) to make sure the events are arriving and the [Reports](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/9212670) are getting the data.

![{"base64":"  ","img":{"width":1488,"height":820,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":101996,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/gtm-debug-view___e2dc572dcc33e2e23e81749583226ec8.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/gtm-debug-view___e2dc572dcc33e2e23e81749583226ec8.png)

To see the available events that GA4 can track, check the [Overview of trackable events](#overview-of-trackable-events) section.

## Overview of trackable events

This section provides a list of events that GA4 can track and explains the `view_promotion` event, which is usually attached to the promotion banner carousel displayed by the [Slider Layout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.slider-layout) block.

### View promotion

The [GA4 view\_promotion](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fpromotion) event expects the product name or ID associated with it.

This event is commonly attached to the promotion banner carousel displayed by the Slider Layout block. For example, you can use Site Editor to configure the `Product ID` and `Product Name`. To access Site Editor, go to **Storefront > Site Editor** in the VTEX Admin.

![{"base64":"  ","img":{"width":819,"height":464,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":336599,"url":"https://vtexhelp.vtexassets.com/assets/docs/src/gtm-site-editor___bc52365aafad63deb5bfed1d74f307c0.png"}}](https://read.calvincode.net/reader?url=https://vtexhelp.vtexassets.com/assets/docs/src/gtm-site-editor___bc52365aafad63deb5bfed1d74f307c0.png)

### Supported events

Check the available events that [Pixel Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/pixel-apps) can listen to, along with their corresponding names in Universal Analytics (UA) and Google Analytics 4 (GA4):

| VTEX                   | UA             | GA4                                                                                |
| ---------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------ |
| vtex:promoView         | promoView      | [view\_promotion](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fpromotion)          |
| vtex:promotionClick    | promoClick     | [select\_promotion](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23select%5Fpromotion)      |
| vtex:productImpression | impressions    | [view\_item\_list](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fitem%5Flist)       |
| vtex:productClick      | click          | [select\_item](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23select%5Fitem)                |
| vtex:productView       | detail         | [view\_item](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fitem)                    |
| vtex:addToCart         | add            | [add\_to\_cart](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23add%5Fto%5Fcart)             |
| vtex:removeFromCart    | remove         | [remove\_from\_cart](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23remove%5Ffrom%5Fcart)   |
| vtex:viewCart          | Not applicable | [view\_cart](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23view%5Fcart)                    |
| vtex:beginCheckout     | checkout       | [begin\_checkout](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23refund)                    |
| vtex:addShippingInfo   | Not applicable | [add\_shipping\_info](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23add%5Fshipping%5Finfo) |
| vtex:addPaymentInfo    | Not applicable | [add\_payment\_info](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23add%5Fpayment%5Finfo)   |
| vtex:orderPlaced       | purchase       | [purchase](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23purchase)                         |
| vtex:refund            | Not applicable | [refund](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23refund)                             |
| vtex:search            | Not applicable | [search](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23search)                             |
| vtex:share             | Not applicable | [share](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23share)                               |
| vtex:addToWishlist     | Not applicable | [add\_to\_wishlist](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23add%5Fto%5Fwishlist)     |

### Partially supported events

The following events are not fully supported yet. Although the GTM app will listen and format them into GA4, corresponding VTEX event triggers have not been implemented yet:

| VTEX        | GA4                                                                                |
| ----------- | ------------------------------------------------------------------------------------------------------------------------- |
| vtex:login  | [login](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23login)        |
| vtex:signUp | [sign\_up](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events?client%5Ftype=gtm%23sign%5Fup) |

Contributors

1

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

[Installing Google Tag Manager« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager//docs/guides/vtex-io-documentation-installing-google-tag-manager)[Setting up cross-border storesNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager//docs/guides/store-framework-setting-up-cross-border-stores)

Contributors

1

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

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23before-you-begin)

[Get the VTEX IO Google Tag Manager app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23get-the-vtex-io-google-tag-manager-app)[Create a Google Analytics 4 (GA4) Configuration tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23create-a-google-analytics-4-ga4-configuration-tag)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23instructions)

[Step 1 - Setting up GA4 events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-1-setting-up-ga4-events)[Step 2 - Testing tags in Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-2-testing-tags-in-google-tag-manager)[Step 3 - Testing events sent to Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-3-testing-events-sent-to-google-analytics-4)

[Overview of trackable events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23overview-of-trackable-events)

[View promotion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23view-promotion)[Supported events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23supported-events)[Partially supported events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23partially-supported-events)

Was this helpful?

 Send feedback

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

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23before-you-begin)

[Get the VTEX IO Google Tag Manager app](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23get-the-vtex-io-google-tag-manager-app)[Create a Google Analytics 4 (GA4) Configuration tag](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23create-a-google-analytics-4-ga4-configuration-tag)

[Instructions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23instructions)

[Step 1 - Setting up GA4 events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-1-setting-up-ga4-events)[Step 2 - Testing tags in Google Tag Manager](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-2-testing-tags-in-google-tag-manager)[Step 3 - Testing events sent to Google Analytics 4](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23step-3-testing-events-sent-to-google-analytics-4)

[Overview of trackable events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23overview-of-trackable-events)

[View promotion](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23view-promotion)[Supported events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23supported-events)[Partially supported events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-setting-up-google-tag-manager/docs/guides/vtex-io-documentation-setting-up-google-tag-manager%23partially-supported-events)

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 product summary productsummaryspecificationbadges 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.product-summary/productsummaryspecificationbadges/docs/guides)

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

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

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

Product Specification Badges

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

Version: 2.91.0

Latest version: 2.91.0

![{"base64":"  ","img":{"width":73,"height":20,"type":"svg","mime":"image/svg+xml","wUnits":"px","hUnits":"px","url":"https://img.shields.io/badge/-Deprecated-red"}}](https://read.calvincode.net/reader?url=https://img.shields.io/badge/-Deprecated-red)

> The Product Specification Badges block has been deprecated in favor of the [Product Specifications](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-product-specifications) app. Although support for this block is still available, we strongly recommend that you update your store theme with the Product Specifications app to stay up with the component's evolution.

Use this component to show badges based on your product specifications inside your product page.

### Configuration

This component must be configured to be able to display the specifications properly. Its props can be configured via `blocks.json` and they are:

| Prop name              | Type                                                  | Description                                                                                | Default value |
| ---------------------- | ----------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| specificationGroupName | String                                                | The name of the specification group in which the desired specifications are                                                                                | ""            |
| specificationName      | String                                                | Pass the name of the specification you want to target. If left empy, will target all of the group                                                                                | ""            |
| visibleWhen            | String                                                | Pass this if you want the specification to be displayed only if it has this exact value. If left empty, the badge will be showed regardless of the specification value.                                                                                | ""            |
| displayValue           | SPECIFICATION\_NAME or SPECIFICATION\_VALUE or string | Choose the value that will appear if the specification condition is met and the badge will be showed. Pass SPECIFICATION\_NAME if you want to display the specification name. Pass SPECIFICATION\_VALUE if you want to display its value. Pass any other custom string to display it. | null          |
| specificationsOptions  | Array<Option>                                         | Pass this if you want to control the conditions to show certain specifications. Each value of the array should be a valid object of the Option format.                                                                                | null          |
| orientation            | vertical or horizontal                                | Determines if the group of specifications are showed horizontally or vertically                                                                                | vertical      |
| blockClass             | string                                                | Allows to pass a custom name to be added to component css classes                                                                                | null          |

`Option` type:

| Prop name         | Type                                                  | Description                                                                                | Default value |
| ----------------- | ----------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------- |
| specificationName | String                                                | Pass the name of the specification you want to target. If empty, option will not be checked.                                                                                | ""            |
| visibleWhen       | string                                                | Pass this if you want this option to be applied when the specification has the exactly same value as specified in visibleWhen. If left empty, the badge will be showed regardless of the specification value.                                                         | null          |
| displayValue      | SPECIFICATION\_NAME or SPECIFICATION\_VALUE or string | Choose the value that will appear if the option condition is met and the badge will be showed. Pass SPECIFICATION\_NAME if you want to show the specification name. Pass SPECIFICATION\_VALUE if you want to show its value. Pass any other custom string to show it. | null          |

Important note: All products come with a default `allSpecifications` group, that is a group that combines all specifications in your product. If you manually create another group and add a specification in it, this specification will also appear in the `allSpecifications` group. So, if you want to apply your conditions to all specification, regardless of group, you must pass the value `allSpecifications`.

### Example 1

Let's say your product has this specification groups:

`1

// specificationGroups array

2

[

3

 {

4

 name: 'Group',

5

 specifications: [

6

 {

7

 name: 'On Sale',

8

 values: ['True'],

9

 },

10

 ],

11

 },

12

 {

13

 name: 'Group 2',

14

 specifications: [

15

 {

16

 name: 'Demo',

17

 values: ['True'],

18

 },

19

 {

20

 name: 'PromoExclusion',

21

 values: ['1'],

22

 }

23

 ],

24

 },

25

 {

26

 name: 'allSpecifications',

27

 specifications: [

28

 {

29

 name: 'On Sale',

30

 values: ['True'],

31

 },

32

 {

33

 name: 'Demo',

34

 values: ['True'],

35

 },

36

 {

37

 name: 'PromoExclusion',

38

 values: ['1'],

39

 },

40

 ],

41

 },

42

 ]

`

If you want to display all specifications with the value `True`, you could then pass:

`1

"product-specification-badges": {

2

 "props": {

3

 "specificationGroupName": "allSpecifications",

4

 "displayValue": "SPECIFICATION_NAME",

5

 "visibleWhen": "True"

6

 }

7

 },

`

In this case, it will appear the `On Sale` and `Demo` badges (because you passed the `SPECIFICATION_NAME` in `displayValue`).

### Example 2

Using the specification groups from example 1, we can get the same result with the specificationOptions prop:

`1

 "product-specification-badges": {

2

 "props": {

3

 "specificationGroupName": "allSpecifications",

4

 "specificationsOptions": [{

5

 "specificationName": "On Sale",

6

 "displayValue": "SPECIFICATION_NAME",

7

 "visibleWhen": "True"

8

 },

9

 {

10

 "specificationName": "Demo",

11

 "displayValue": "SPECIFICATION_NAME",

12

 "visibleWhen": "True"

13

 }]

14

 }

15

 },

`

### Example 3

`1

// specificationGroups array

2

[

3

 {

4

 name: 'Group',

5

 specifications: [

6

 {

7

 name: 'On Sale',

8

 values: ['True'],

9

 },

10

 ],

11

 },

12

 {

13

 name: 'Group 2',

14

 specifications: [

15

 {

16

 name: 'Demo',

17

 values: ['True'],

18

 },

19

 {

20

 name: 'PromoExclusion',

21

 values: ['1'],

22

 }

23

 ],

24

 },

25

 {

26

 name: 'allSpecifications',

27

 specifications: [

28

 {

29

 name: 'On Sale',

30

 values: ['True'],

31

 },

32

 {

33

 name: 'Demo',

34

 values: ['My Cool Value'],

35

 },

36

 {

37

 name: 'PromoExclusion',

38

 values: ['1'],

39

 },

40

 ],

41

 },

42

 ]

`

If you want to show the value for the `Demo` specification, you could pass:

`1

 "product-specification-badges": {

2

 "props": {

3

 "specificationGroupName": "allSpecifications",

4

 "specificationsOptions": [{

5

 "specificationName": "On Sale",

6

 "displayValue": "SPECIFICATION_NAME",

7

 "visibleWhen": "True"

8

 },

9

 {

10

 "specificationName": "Demo",

11

 "displayValue": "SPECIFICATION_VALUE",

12

 }]

13

 }

14

 },

`

Final result: will appear the `On Sale` badge and a badge with `My Cool Value`.

Note the use of `SPECIFICATION_VALUE` in `displayValue` and the lack of `visibleWhen` in `Demo`.

### Example 4

Using the example given in example 3.

To show a custom string you could do:

`1

 "product-specification-badges": {

2

 "props": {

3

 "specificationGroupName": "allSpecifications",

4

 "specificationsOptions": [{

5

 "specificationName": "On Sale",

6

 "displayValue": "SPECIFICATION_NAME",

7

 "visibleWhen": "True"

8

 },

9

 {

10

 "specificationName": "Demo",

11

 "displayValue": "SPECIFICATION_VALUE",

12

 },

13

 {

14

 "specificationName": "PromoExclusion",

15

 "displayValue": "Cool Promo",

16

 }]

17

 }

18

 },

`

Final result: will appear the `On Sale` badge, a badge with `My Cool Value` and a badge with the string `Cool Promo`.

Note the usage of a custom value in the `displayValue` config.

### Usage tip

You can use our `stack-layout` to show the badges over your product image for example.

`1

 "stack-layout": {

2

 "children": [

3

 "product-images",

4

 "product-specification-badges"

5

 ]

6

 },

7

8

 "product-specification-badges": {

9

 "props": {

10

 "specificationGroupName": "allSpecifications",

11

 "displayValue": "SPECIFICATION_NAME",

12

 "specificationName: "On Sale",

13

 "visibleWhen": "True"

14

 }

15

 },

16

 "flex-layout.row#product-image": {

17

 "children": ["product-images"]

18

 },

`

## Customization

To apply CSS customizations in this and other blocks, follow the [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/docs/vtex-io-documentation-using-css-handles-for-store-customization) guide.

| CSS Handles    |
| -------------- |
| groupContainer |
| badgeContainer |
| badgeText      |

Note: each badge also receives a class `badgeContainer` with its specification name slug appended to it. Example: on specification `On Sale` the badge will also have the class `badgeContainer--on-sale`.

See also

[Vtex.product SummaryVTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/productsummaryspecificationbadges/docs/apps/vtex.product-summary)[VTEX App StoreVTEX IO Apps](https://read.calvincode.net/reader?url=https://apps.vtex.com/)

ON THIS PAGE

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

Was this helpful?

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


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

[User] Explain the VTEX api reference pick and pack protocol 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/pick-and-pack-protocol-api/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/antifraud-provider-protocol/)

---

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

---

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

---

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

---

[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/catalog-api-seller-portal/)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/license-manager-api/)

---

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

---

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

---

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

---

[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/masterdata-api/)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-protocol-api/)

Authentication

Service integration

Carriers

Shipping updates

---

[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/policies-system-api/)

---

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

---

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

---

[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/promotions-and-taxes-api-v2/)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/orders-api-pii-version/)

---

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

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

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

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

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

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

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/antifraud-provider-protocol/)

---

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

---

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

---

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

---

[Legacy CMS Portal API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/catalog-api-seller-portal/)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

[Intelligent Search API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/license-manager-api/)

---

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

---

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

---

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

---

[Master Data API - v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/masterdata-api/)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

[Pick and Pack API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-protocol-api/)

Authentication

Service integration

Carriers

Shipping updates

---

[Pick and Pack Order Changes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/policies-system-api/)

---

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

---

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

---

[Promotions & Taxes API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/promotions-and-taxes-api-v2/)

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

[VTEX ID](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-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/pick-and-pack-protocol-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/pick-and-pack-protocol-api/docs/api-reference/orders-api-pii-version/)

---

[GeList shipments by order ID« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-api%23get-/shipments/-orderId-)[PoCreate JWT tokenNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/pick-and-pack-protocol-api/docs/api-reference/pick-and-pack-protocol-api%23post-/token)

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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

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

[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/setting-up-the-type-of-interest-rate)

[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/setting-up-merchant-id-in-apple-pay)

[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/cardholder-document-configuration)

[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)

[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/metadata-information-in-payment-transactions)

---

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/payments-configuration-guides/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

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

[Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/setting-up-the-type-of-interest-rate)

[Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/setting-up-merchant-id-in-apple-pay)

[Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/cardholder-document-configuration)

[Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions)

[Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides/docs/guides/metadata-information-in-payment-transactions)

---

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/payments-configuration-guides/docs/guides/activity-flow)

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Payments

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

Configuration Guides

The articles listed below will present the necessary steps to make payment settings.

| Article                                                                                | Description                                                                                |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- |
| [Setting up the type of interest rate](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-the-type-of-interest-rate)                                                                      | How to identify the payment methods' ID and set up the interest rate type using the Payments Gateway API. |
| [Setting up Merchant ID in Apple Pay](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/setting-up-merchant-id-in-apple-pay)                                                                        | How to set up Merchant ID in Apple Pay.                                                                   |
| [Cardholder document configuration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/cardholder-document-configuration)                                                                            | How to configure a cardholder document field to be displayed at checkout.                                 |
| [Implementing a pre-analysis anti-fraud flow for debit card transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/implementing-a-pre-analysis-antifraud-flow-for-debit-card-transactions) | How to activate the anti-fraud flow for debit card transactions.                                          |
| [Metadata information in payment transactions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/metadata-information-in-payment-transactions)                                                      | How to insert metadata information into your payment transactions.                                        |

Contributors

3

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

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

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

[Interacting with Master Data v1 through VTEX IO services« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides//docs/guides/interacting-with-master-data-v1-through-vtex-io-services)[Setting up the type of interest rateNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/payments-configuration-guides//docs/guides/setting-up-the-type-of-interest-rate)

Contributors

3

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

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

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

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/Payments/payments-configuration-guides.md)

Copy page

On this page

On this page

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