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

[User] Provide a guide on guides faststore analytics extending and customizing native types in VTEX.

[Assistant]
Documentation

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

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

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/api-reference)

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

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

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

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/troubleshooting)

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

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore)

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

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/headless-cms-overview)

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

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/sdk-overview)

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-overview)

[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-send-analytics-event)

[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-use-analytics-event)

[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-sending-custom-events)

[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types)

[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/cart-overview)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/search-overview)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/session-overview)

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

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/api-extensions-overview)

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

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/storefront-best-practices)

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/updates/release-notes)

Storefront Development

[Getting started with storefront solutions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/getting-started-with-storefront-solutions)

---

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore)

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

[Getting Started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/getting-started-overview)

[FastStore WebOps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/webops-dashboard)

[Headless CMS](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/headless-cms-overview)

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

[Styling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/styling-overview)

[UI components](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/components-index)

[Implementing storefront features](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/storefront-features-overview)

[FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/faststore-api-overview)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/sdk-overview)

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-overview)

[sendAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-send-analytics-event)

[useAnalyticsEvent](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-use-analytics-event)

[Sending custom events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-sending-custom-events)

[Extending and customizing native types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types)

[Use case: Implementing custom newsletter analytics events](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)

[Cart](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/cart-overview)

[Search](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/search-overview)

[Session](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/session-overview)

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

[Extending the FastStore API](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/api-extensions-overview)

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

[Managing performance](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/managing-performance-overview)

[SEO](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/seo-overview)

[Going live](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/go-live-overview)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/troubleshooting-overview)

---

[Store Framework](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/store-framework)

---

(Legacy) CMS Portal

---

[Storefront best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/storefront-best-practices)

---

[Storefront development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/storefront-development)

[FastStore](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore)

[FastStore SDK](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/sdk-overview)

[Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-overview)

Extending and customizing native types

The [Analytics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview) module offers built-in [ecommerce events](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/14434488?hl=en) based on the [Google Analytics 4 (GA4) data model](https://read.calvincode.net/reader?url=https://developers.google.com/analytics/devguides/collection/ga4/reference/events).

While these parameters are often the most used in online stores, you may need to track additional properties to monitor specific behaviors that are only valuable to particular business models. For example, a subscription box service would want to track details like `subscription_frequency` or `is_renewal` beyond standard purchase data to understand customer lifetime value and churn better.

FastStore natively supports extending and customizing Analytics native types. The Analytics module can accept new types and also export its native types. You don't need to rewrite an event interface's code to make minor additions. Also, since the Analytics module is built with [generics](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/2/generics.html), you can rewrite only part of a type, like the `Item` structure, if necessary.

In this guide, you'll learn how to extend and customize native types from the Analytics module.

## Before you begin

* Review the list of [Available types](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-overview%23list-of-native-event-types) that you can extend.
* Familiarize yourself with [Type Aliases or Extended Interfaces](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/2/everyday-types.html%23differences-between-type-aliases-and-interfaces) in TypeScript, which are the techniques you'll use to extend the desired type.

## Extending event interfaces

To add new properties to an existing event interface, you must create a new TypeScript interface that extends the native FastStore Analytics event type. This step allows you to add custom event-level details that aren't part of the standard GA4 data model but are important for your business. For example, knowing whether the cart contains a product bundle can be key to a specific promotion or product strategy.

1. Create a new interface that extends the native FastStore Analytics event type. For example, to add an `isProductBundle` property to `AddToCartEvent`:
`1
import type { AddToCartEvent } from '@faststore/sdk'
2

3
interface AddToCartExtended extends AddToCartEvent {
4
 isProductBundle: boolean
5
}
`
   * The `isProductBundle` property is a flag that indicates whether the added item is part of a product bundle.
   * The `AddToCartExtended` interface now includes all properties from `AddToCartEvent` (`name` and `params`) and the new `isProductBundle` property.
2. To use this extended type when sending an event, ensure your event object conforms to the `AddToCartExtended` new interface structure inside the component you send analytics events. See the following example:
`1
import { analytics } from 'src/sdk/analytics'
2

3
const extendedAddToCartEvent: AddToCartExtended = {
4
name: 'add_to_cart',
5
params: {
6
 currency: 'USD',
7
 value: 12.99,
8
 items: [
9
 {
10
 item_id: 'SKU123',
11
 item_name: 'Product A',
12
 price: 12.99,
13
 quantity: 1,
14
 },
15
 ],
16
},
17
isProductBundle: true, // The new custom property
18
};
19

20
// Call your analytics send method with the extended event object:
21
analytics.sendEvent(extendedAddToCartEvent);
`

## Overriding `Item` properties using generics

To add custom dimensions or metrics to individual items within an event without changing the overall event structure, use [generics](https://read.calvincode.net/reader?url=https://www.typescriptlang.org/docs/handbook/2/generics.html) to override the `Item` property. This allows you to attach unique custom attributes to individual products or services in your catalog.

1. Create an interface for your custom `Item` properties. For example, to add `dimension10` to an item:
`1
import type { AddToCartEvent, Item } from '@faststore/sdk'
2

3
interface ItemExtension {
4
dimension10: string
5
}
`
   * `dimension10` serves as a customizable placeholder for item-specific dimensions in analytics, such as "product color family" and "licensing type". This placeholder allows for the representation of custom data.
2. Create a new type that combines the native `Item` type with your `ItemExtension` using a TypeScript intersection (`&`):
`1
import type { AddToCartEvent, Item } from '@faststore/sdk'
2

3
interface ItemExtension {
4
dimension10: string
5
}
6

7
type ItemExtended = Item & ItemExtension
8

9
type AddToCartWithExtendedItems = AddToCartEvent<ItemExtended>
`
   * `AddToCartExtended` has the same properties as `AddToCartEvent` (`name` and `params`), but the items inside the `params` property will now have the `ItemExtended type`.

Below, see an example of how you can use this type when sending an event in a component:

`1

import { analytics } from 'src/sdk/analytics'

2

3

const addToCartWithExtendedItemsEvent: AddToCartWithExtendedItems = {

4

 name: 'add_to_cart',

5

 params: {

6

 currency: 'USD',

7

 value: 25.00,

8

 items: [

9

 {

10

 item_id: 'SKU456',

11

 item_name: 'Product B',

12

 price: 25.00,

13

 quantity: 1,

14

 dimension10: 'Custom Value Here', // The new custom property for the item

15

 },

16

 ],

17

 },

18

};

19

20

analytics.sendEvent(addToCartWithExtendedItemsEvent);

`

* `const addToCartWithExtendedItemsEvent: AddToCartWithExtendedItems`: Declares a constant variable named `addToCartWithExtendedItemsEvent` and explicitly tells that it must conform to the `AddToCartWithExtendedItems` type.
* `name: 'add_to_cart'`: Default event name recognized by GA4.
* `params: { ... }`: Holds the default GA4 parameters for an `add_to_cart` event (`currency`, `value`, `items`).
* dimension10: `ItemExtended` now includes the `dimension10` custom dimension.

## Best practices for validating extended types at runtime

Since TypeScript types are erased during compilation, validate your extended event data at runtime to ensure analytics tools like [Google Analytics 4](https://read.calvincode.net/reader?url=https://support.google.com/analytics/topic/14089939?hl=en%26ref%5Ftopic=14090456%26sjid=1384409646416570899-SA) receive correctly formatted events. Consider the following methods:

> These methods can help catch runtime errors. Choose what fits your workflow.

| **Method**                                                                                | **Purpose**                                                                                |
| ------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Installing a validation library                                                                  | Use a validation library to catch typos and validate backend data.                                                                                |
| Intercepting events                                                                              | Verify events before they reach analytics tools by wrapping analytics.sendEvent(safeEvent) with validation logic to filter invalid events in your code.                                             |
| Debugging with [GA4 DebugView](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/7201382?hl=en%23zippy=) | Enable debug mode and monitor real-time events in GA4's DebugView interface. For more information, see the [GA4 DebugView](https://read.calvincode.net/reader?url=https://support.google.com/analytics/answer/7201382?hl=en%23zippy=) guide. |
| Adding unit tests                                                                                | Write tests that verify your event objects catches schema violations during development.                                                                                |

Contributors

1

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/extending-and-customizing-native-types.mdx)

[Sending custom events« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-sending-custom-events)[Use case: Implementing custom newsletter analytics eventsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-implementing-custom-newsletter-analytics-events)

Contributors

1

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

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types%23before-you-begin)

[Extending event interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types%23extending-event-interfaces)

[Overriding Item properties using generics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types%23overriding-item-properties-using-generics)

[Best practices for validating extended types at runtime](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types%23best-practices-for-validating-extended-types-at-runtime)

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/faststore/docs/sdk/analytics/extending-and-customizing-native-types.mdx)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types%23before-you-begin)

[Extending event interfaces](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types%23extending-event-interfaces)

[Overriding Item properties using generics](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types%23overriding-item-properties-using-generics)

[Best practices for validating extended types at runtime](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/faststore/analytics-extending-and-customizing-native-types/docs/guides/faststore/analytics-extending-and-customizing-native-types%23best-practices-for-validating-extended-types-at-runtime)

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

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

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

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

[My Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-authentication)

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

[My Authentication](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-authentication)

---

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

---

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

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

My Authentication

Official extension

Version: 1.9.1

Latest version: 1.9.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-)

## Description

This VTEX IO app extends the [MyAccount](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/my-account) app to add authentication-related menu options (`Authentication` tab). It is installed by default in every VTEX account. Just like `MyAccount`, this can be used in either `IO` or `Portal` stores.

![{"base64":"  ","img":{"width":1251,"height":624,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":48311,"url":"https://user-images.githubusercontent.com/22064061/112358629-47ff2100-8caf-11eb-8f89-80bdb48d2e68.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/22064061/112358629-47ff2100-8caf-11eb-8f89-80bdb48d2e68.png)

## Table of Contents

* [Usage](#usage)
   * [Visibility](#visibility)
* [Customization](#customization)
   * [IO Stores](#io-stores)
   * [Portal Stores](#portal-stores)
* [CSS Handles List](#css-handles-list)
* [Contributors](#contributors)

## Usage

### Visibility

By default, the `Authentication` tab is not visible in the left-side menu of the [MyAccount UI](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/my-account).

To make it visible, go into

https://`{{accountName}}`.myvtex.com/admin/apps/

and search for `My Account` among the `installed` apps. Then click `Settings`.

![{"base64":"  ","img":{"width":299,"height":182,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":9457,"url":"https://user-images.githubusercontent.com/22064061/112537384-5de31380-8d8d-11eb-80a5-902d1e0922db.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/22064061/112537384-5de31380-8d8d-11eb-80a5-902d1e0922db.png)

Set `Authentication` option to :white\_check\_mark: `Visible`, then click `Save`.

![{"base64":"  ","img":{"width":152,"height":72,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":2819,"url":"https://user-images.githubusercontent.com/22064061/112537098-0b095c00-8d8d-11eb-915a-3dd7e8da86da.png"}}](https://read.calvincode.net/reader?url=https://user-images.githubusercontent.com/22064061/112537098-0b095c00-8d8d-11eb-915a-3dd7e8da86da.png)

:loudspeaker: **Disclaimer:** in a close future, the `Authentication` tab visibility will become always true.

:information\_source: **Before making this tab visible**, you should [customize](#customization) it to match your store visual identity

## Customization

### IO Stores

In order to apply CSS customizations to the app, follow the instructions given in the recipe on [Using CSS Handles for store customization](https://read.calvincode.net/reader?url=https://vtex.io/docs/recipes/style/using-css-handles-for-store-customization) (you don't have to worry about `block` or `blockClass`).

A list of all `CSS Handles` is in [this section](#css-handles-list).

You can see the `Authentication` UI being customized in:

https://`{{workspaceName}}`\--`{{accountName}}`.myvtex.com/account#/authentication

### Portal Stores

In order to customize the app, create a `.css` file with your own rules. Your class selectors should reference the UI's pre-existing classes.

A list of all `CSS Handles` is in [this section](#css-handles-list).

:loudspeaker: **Avoid** using element or position-based selectors, as the customization may break in the face of the smallest UI changes.

To upload your `.css` file, go to the VTEX CMS (`/admin/a`) and open the `CMS/Files Manager/.css` file. Click `Add` and you'll be able to upload it. This file is accessible from [VTEX CMS storage](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tutorial/ver-o-conteudo-dos-arquivos-css-da-loja--U5v7DXpRSee86uqiKQUQi).

Lastly, you should link that `.css` file to the Account Page HTML Head by [editing the "Account" CMS template](https://read.calvincode.net/reader?url=https://help.vtex.com/en/tracks/cms--2YcpgIljVaLVQYMzxQbc3z/Y6dPEF6GzROQ8PuYKxrKe).

You can see the `Authentication` UI being customized in:

https://`{{accountName}}`.vtexcommercestable.com.br/\_secure/account#/authentication

(if you want to use IO workspaces, just add the query string "?workspace=`{{workspaceName}}`")

## CSS Handles List

:information\_source: **If you're in a Portal Store**, append the prefix `vtex_my-authentication_` to each handle for your CSS class selectors.

| CSS Handles                        |
| ---------------------------------- |
| box\_container                     |
| box\_header                        |
| box\_headerSeparator               |
| box\_content                       |
| box\_footer                        |
| errorAlert\_container              |
| warnAlert\_container               |
| authenticationScreen\_container    |
| authenticationScreen\_passBox      |
| newPassInput\_container            |
| passValidation\_container          |
| passValidation\_title              |
| passValidation\_content            |
| passValidation\_minLengthNumber    |
| passValidation\_minLength          |
| passValidation\_number             |
| passValidation\_lowerUpper         |
| passValidation\_lower              |
| passValidation\_upper              |
| passValidation\_iconSuccess        |
| passValidation\_iconFailure        |
| savePassButton\_container          |
| skeletonEditPassword\_content      |
| skeletonEditPassword\_button       |
| currPassInput\_container           |
| createPassword\_text               |
| codeInput\_container               |
| resendCodeButton\_container        |
| maskedPassword\_title              |
| maskedPassword\_content            |
| loginSessionsBox\_title            |
| loginSessionsBox\_content          |
| skeletonLoginSessions\_content     |
| skeletonLoginSessions\_button      |
| loginSessionsScreen\_container     |
| loginSessions\_skeleton            |
| loginSessions\_error               |
| loginSessions\_list                |
| loginSessions\_box                 |
| skeletonLoginSessionsScreen\_title |
| skeletonLoginSessionsScreen\_text1 |
| skeletonLoginSessionsScreen\_text2 |
| loginSession\_currSession          |
| loginSession\_currSessionIcon      |
| loginSession\_currSessionText      |
| loginSession\_device               |
| loginSession\_lastAccess           |
| loginSession\_originDetails        |
| loginSession\_fullAddress          |
| loginSession\_firstAccess          |

[My Account Commons« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-account-commons)[VTEX IO deprecated appsNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/guides/vtex-io-deprecated-apps)

See also

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

ON THIS PAGE

[Description](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-authentication%23description)

[Table of Contents](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-authentication%23table-of-contents)

[Usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-authentication%23usage)

[Visibility](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-authentication%23visibility)

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

[IO Stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-authentication%23io-stores)[Portal Stores](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-authentication%23portal-stores)

[CSS Handles List](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.my-authentication/docs/apps/vtex.my-authentication%23css-handles-list)

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

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

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

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

Authentication

Delivery Services

---

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

---

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

---

[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking/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/tracking/docs/api-reference/orders-api-pii-version/)

---

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

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

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

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

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

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

Authentication

Delivery Services

---

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

---

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

---

[Profile System (Data Protection Plus)](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking/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/tracking/docs/api-reference/orders-api-pii-version/)

---

[PoTracking Events with App« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking/docs/api-reference/vtex-shipping-network-api%23post-/-app%5Fname-/v-app%5Fversion-/-account-/-workspace-/tracking)[PoAsynchronous LoginNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/tracking/docs/api-reference/tracking%23post-/auth)

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