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

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

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

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

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

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

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

---

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

VTEX IO Apps

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

---

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

Product Summary List

[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

The Product Summary List app (`list-context.product-list`) is an instance of the `list-context` interface, which provides predefined interfaces used to create content lists, such as a product list.

![{"base64":"  ","img":{"width":1919,"height":951,"type":"png","mime":"image/png","wUnits":"px","hUnits":"px","length":437866,"url":"https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-product-summary-productsummarylist-0.png"}}](https://read.calvincode.net/reader?url=https://cdn.jsdelivr.net/gh/vtexdocs/dev-portal-content@main/images/vtex-product-summary-productsummarylist-0.png)

To create a product list, you must use the `list-context.product-list` and `product-summary.shelf` blocks.

## product-list-block

This block is used to specify the variation of `product-summary` that should be used to create the product list and the `list-context.product-list` you want, as follows:

`1

 "product-summary.shelf#demo1": {

2

 "children": [

3

 "stack-layout#prodsum",

4

 "product-summary-name",

5

 "product-rating-inline",

6

 "product-summary-space",

7

 "product-summary-price",

8

 "product-summary-buy-button"

9

 ]

10

 },

11

 "list-context.product-list#demo1": {

12

 "blocks": ["product-summary.shelf#demo1"],

13

 "children": ["slider-layout#demo-products"]

14

 },

`

`list-context.product-list` also runs the GraphQL query that fetches the product list, allowing it to receive the following props:

| Prop name            | Type                                                | Description                                                                                | Default value            |
| -------------------- | --------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------ |
| category             | string                                              | Category ID of the listed items. For subcategories, use "/" (example: "1/2/3").                                                                                | \-                       |
| specificationFilters | Array({ id: String, value: String })                | Specification filters of the listed items.                                                                                | \[\]                     |
| collection           | string                                              | Filter by collection.                                                                                | \-                       |
| orderBy              | enum                                                | Sort type of the items. Possible values are: '', OrderByTopSaleDESC, OrderByReleaseDateDESC, OrderByBestDiscountDESC, OrderByPriceDESC, OrderByPriceASC, OrderByNameASC, OrderByNameDESC.              | OrderByTopSaleDESC       |
| hideUnavailableItems | boolean                                             | Hides unavailable items.                                                                                | false                    |
| maxItems             | number                                              | Maximum items to be fetched.                                                                                | 10                       |
| skusFilter           | [SkusFilterEnum](#skusfilterenum)                   | Control SKUs returned for each product in the query. The fewer SKUs that need to be returned, the more efficient your shelf query will be. Possible values are: FIRST\_AVAILABLE, ALL\_AVAILABLE, ALL. | "ALL\_AVAILABLE"         |
| installmentCriteria  | [InstallmentCriteriaEnum](#installmentcriteriaenum) | Controls the price that will be displayed when the price has different installment options. Possible values are: MAX\_WITHOUT\_INTEREST, MAX\_WITH\_INTEREST.                                          | "MAX\_WITHOUT\_INTEREST" |
| listName             | string                                              | Name of the list property in Google Analytics events.                                                                                | \-                       |
| preferredSKU         | [PreferredSKUEnum](#preferredskuenum)               | Controls the SKU that will be selected in the summary. Possible values are: FIRST\_AVAILABLE, LAST\_AVAILABLE, PRICE\_ASC, PRICE\_DESC.                                                                | "FIRST\_AVAILABLE"       |

### `SkusFilterEnum`:

| Name            | Value            | Description                                                                                |
| --------------- | ---------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |
| First Available | FIRST\_AVAILABLE | Best performance, ideal if you don't have a SKU selector on your shelf. It returns only the first available SKU for that product in your shelf query. |
| All Available   | ALL\_AVAILABLE   | Somewhat better performance. It only returns available SKUs, which is ideal if you have a SKU selector but still want better performance.             |
| All             | ALL              | Returns all SKUs related to the product. This is the least efficient option.                                                                          |

### `InstallmentCriteriaEnum`:

| Name                     | Value                  | Description                                                       |
| ------------------------ | ---------------------- | ----------------------------------------------------------------- |
| Maximum without interest | MAX\_WITHOUT\_INTEREST | Displays the maximum installment option with no interest.         |
| Maximum                  | MAX\_WITH\_INTEREST    | Displays the maximum installment option with or without interest. |

### `PreferredSKUEnum`:

| Name            | Value            | Description                                        |
| --------------- | ---------------- | -------------------------------------------------- |
| First Available | FIRST\_AVAILABLE | Selects the first available SKU it finds.          |
| Last Available  | LAST\_AVAILABLE  | Selects the last available SKU it finds.           |
| Cheapest        | PRICE\_ASC       | Selects the cheapest SKU in stock it finds.        |
| Most Expensive  | PRICE\_DESC      | Selects the most expensive available SKU it finds. |

> To select the SKU that will take precedence over this prop, create a Product (field) specification and assign the value of the desired SKU to be initially set for each product. If the specification doesn't exist or the value is empty, the `preferredSKU` prop will be used as a fallback. For more information, see [Configuring custom images for the SKU Selector](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/vtex-io-documentation-configuring-custom-images-for-the-sku-selector).

See also

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

ON THIS PAGE

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

[SkusFilterEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/apps/vtex.product-summary/ProductSummaryList%23skusfilterenum)[InstallmentCriteriaEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/apps/vtex.product-summary/ProductSummaryList%23installmentcriteriaenum)[PreferredSKUEnum:](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/apps/vtex.product-summary/ProductSummaryList/docs/apps/vtex.product-summary/ProductSummaryList%23preferredskuenum)

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] Provide a guide on guides trigger ab test 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/trigger-ab-test/docs/guides)

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-best-practices)

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

Schemas

Triggers

[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-triggers-on-master-data-v2)

[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/trigger-ab-test)

[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/sending-emails-with-triggers-on-master-data-v2)

[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-v2-document-saving-flow)

[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)

[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/using-dynamic-expressions-on-master-data-v2)

[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/searching-by-geocoordinates-in-master-data-v2)

[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-alternate-keys-in-master-data-v2)

[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-best-practices)

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

Schemas

Triggers

[Setting up triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-triggers-on-master-data-v2)

[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/trigger-ab-test)

[Sending emails with triggers on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/sending-emails-with-triggers-on-master-data-v2)

[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/master-data-v2-document-saving-flow)

[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)

[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/using-dynamic-expressions-on-master-data-v2)

[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/searching-by-geocoordinates-in-master-data-v2)

[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-alternate-keys-in-master-data-v2)

[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)

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

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

Triggers

[A/B testing Master Data v2 trigger actions](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test/docs/guides/trigger-ab-test)

A/B testing Master Data v2 trigger actions

The [Master Data v2 trigger](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/setting-up-triggers-on-master-data-v2) configuration has an optional property called `weight`.

It is a field that accepts integers between zero and 100\. This number is a percentage value of distribution between triggers.

This allows you to perform comparative experiments with different actions for the same Master Data trigger.

> This feature works only if you have at least two actions with value in the `weight` property.

Example 1: A/B Test between two triggers with 50% of the load.

`1

 {

2

 "properties": { ... },

3

 "v-triggers": [

4

 {

5

 "name": "scenario-1",

6

 "weight": 50,

7

 ...

8

 },

9

 {

10

 "name": "scenario-2",

11

 "weight": 50,

12

 ...

13

 }

14

 ]

15

 }

`

Example 2: A/B Test between four triggers with different weights.

`1

 {

2

 "properties": { ... },

3

 "v-triggers": [

4

 {

5

 "name": "scenario-1",

6

 "weight": 40,

7

 ...

8

 },

9

 {

10

 "name": "scenario-2",

11

 "weight": 30,

12

 ...

13

 },

14

 {

15

 "name": "scenario-3",

16

 "weight": 20,

17

 ...

18

 },

19

 {

20

 "name": "scenario-4",

21

 "weight": 10,

22

 ...

23

 }

24

 ]

25

 }

`

Contributors

1

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/trigger-ab-test.md)

[Setting up triggers on Master Data v2« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test//docs/guides/setting-up-triggers-on-master-data-v2)[Sending emails with triggers on Master Data v2Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/trigger-ab-test//docs/guides/sending-emails-with-triggers-on-master-data-v2)

Contributors

1

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

Was this helpful?

 Send feedback

[Suggest edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/triggers/trigger-ab-test.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=)


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

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

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

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

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

[Getting started with VTEX IO for VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/getting-started-with-vtex-io-for-vtex-shipping-network)

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

[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/notification-1)

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

[VTEX Shipping Network Labels Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-shipping-network-labels-integration)

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

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

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

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

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

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

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

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

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

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

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

---

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

Guides

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

---

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

---

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

---

Integration Guides

---

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

---

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

---

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

---

Payments

---

Orders

---

Logistics

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

[Getting started with VTEX IO for VTEX Shipping Network](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/getting-started-with-vtex-io-for-vtex-shipping-network)

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

[Notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/notification-1)

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

[VTEX Shipping Network Labels Integration](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/vtex-shipping-network-labels-integration)

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

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

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

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

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

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

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

---

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

---

VTEX Session

---

VTEX Shield

---

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

---

Weni by VTEX

---

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

Logistics

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

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

Tracking

Access the [boilerplate repository for the tracking app](https://read.calvincode.net/reader?url=https://github.com/vtex-apps/carrier-hubs-examples/tree/main/carrier-tracking-example) to clone it and begin development.

A tracking app published by a carrier will include an endpoint like this one:`https://app.io.vtex.com/{app_name}/{app_version}/{account}/{workspace}/tracking`

Once every hour, the VTEX tracking hub makes a `POST` request to this endpoint containing a list of packages’ tracking numbers. The app should respond with the updated tracking information for each package.

Below are some examples, but you can learn more about this request on the [tracking API request documentation](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-developer-docs/reference/vtex-log-tracking-app).

Request body example:

`1

[

2

 {

3

 "trackingNumber": "BR000000000"

4

 }

5

]

`

Response body example:

`1

{

2

 <trackingNumber>: {

3

 "deliveredDate": Date,

4

 "events": [

5

 {

6

 "city": string,

7

 "date": Date,

8

 "description": string,

9

 "state": string

10

 }

11

 ],

12

 "hasReturnedToSender": bool,

13

 "isDelivered": bool

14

 }

15

}

`

> Be aware that this call may contain several package's tracking numbers, and the app should respond with tracking information for each of them.

## Learn more

See this guide on [how to develop carrier apps on VTEX IO](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/getting-started-with-vtex-io-for-carriers). You can also learn more about the [integration flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/integration-flow) and [notification](https://read.calvincode.net/reader?url=https://developers.vtex.com/vtex-rest-api/docs/notification-1) for carrier apps.

Contributors

2

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

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

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/Fulfillment/vtex-shipping-network/tracking-1.md)

[Notification« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1//docs/guides/notification-1)[VTEX Shipping Network Labels IntegrationNext »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1//docs/guides/vtex-shipping-network-labels-integration)

Contributors

2

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

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

ON THIS PAGE

[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/tracking-1%23learn-more)

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/Fulfillment/vtex-shipping-network/tracking-1.md)

Copy page

On this page

ON THIS PAGE

[Learn more](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/tracking-1/docs/guides/tracking-1%23learn-more)

On this page

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


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

[User] Provide a guide on guides creating relationships between data entities using master data v2 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/creating-relationships-between-data-entities-using-master-data-v2/docs/guides)

[API ReferenceExplore detailed information about our endpoints.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/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/creating-relationships-between-data-entities-using-master-data-v2/docs/app-development)

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

[TroubleshootingFind practical solutions to common development issues.](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/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/creating-relationships-between-data-entities-using-master-data-v2/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data)

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2)

Schemas

Triggers

[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2-document-saving-flow)

[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)

[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)

[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)

[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)

[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)

[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v1)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides)

[API Reference](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/api-reference)

[App Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/app-development)

[Storefront Development](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/storefront-development)

[VTEX IO Apps](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/vtex-io-apps)

[Troubleshooting](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/troubleshooting)

---

[Release Notes](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/updates/release-notes)

Guides

[VTEX Platform Overview](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/vtex-platform-overview)

---

[API usage](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/api-usage)

---

[Getting started](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/getting-started)

---

Integration Guides

---

[Catalog](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/catalog-integration)

---

[Checkout](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/checkout-api-overview)

---

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data)

[Understanding Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/understanding-master-data)

[Master Data best practices](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-best-practices)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2)

Schemas

Triggers

[Master Data v2 document saving flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2-document-saving-flow)

[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)

[Using dynamic expressions on Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/using-dynamic-expressions-on-master-data-v2)

[Searching by geocoordinates in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/searching-by-geocoordinates-in-master-data-v2)

[Setting up alternate keys in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/setting-up-alternate-keys-in-master-data-v2)

[Setting up an auto increment field in Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/setting-up-an-auto-increment-field-in-master-data-v2)

[Master Data v1](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v1)

---

Payments

---

Orders

---

Logistics

---

B2B Suite

---

VTEX Sales App

---

UI Customization

---

Message Center

---

Pricing

---

Promotions

---

Infrastructure

---

Search

---

Storefront Permissions

---

[VTEX Activity Flow](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/activity-flow)

---

[VTEX Ads](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/vtex-ads)

---

VTEX Session

---

VTEX Shield

---

[Data Protection Plus](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/data-protection-plus)

---

Weni by VTEX

---

[Guides](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides)

[Master Data](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data)

[Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/master-data-v2)

[Creating relationships between data entities using Master Data v2](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2)

Creating relationships between data entities using Master Data v2

Learn how to create relationships between data entities in Master Data v2.

This document will teach you how to establish relationships between data entities in **Master Data v2**. Creating these relationships is vital for organizing and structuring data efficiently within your system.

## Before you begin

Before delving into the process of creating relationships, it's essential to grasp the structure of JSON Schema. If you're not familiar with JSON Schema, we recommend referring to the external documentation, [Understanding JSON Schema](https://read.calvincode.net/reader?url=https://json-schema.org/understanding-json-schema).

To learn more about schemas in Master Data v2, see [Schema lifecycle](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-schema-lifecycle).

## Establishing relationships

Use the [Save schema by name](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/schemas/-schemaName-) ednpoint to configure a field to link to another data entity using either the ID or a field with an associated [index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/master-data-components%23index) created using the [Create index](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23put-/api/dataentities/-dataEntityName-/indices) endpoint.

Below are examples of both methods:

Link through ID

`1

{

2

 "properties": {

3

 "clientEmail": { "type": "string" },

4

 "address": {

5

 "type": "string",

6

 "link": "https://vtexaccount.vtexcommercestable.com.br/api/dataentities/address/schemas/address-schema-v1"

7

 }

8

 }

9

}

`

Link through a field with an index

`1

{

2

 "properties": {

3

 "clientEmail": { "type": "string" },

4

 "addressName": {

5

 "type": "string",

6

 "link": "https://vtexaccount.vtexcommercestable.com.br/api/dataentities/address/schemas/address-schema-v1",

7

 "linked_field": "addressName"

8

 }

9

 }

10

}

`

Notice that the `link` property associates a JSON Schema of the data entity with which you want to create a relationship.

## Response handling

Creating a relationship in this manner will generate a response containing a new field with the JSON of the related document.

The fields in the returned object will match those specified in the `v-default-fields`. However, if the document does not exist with the specified key, the property will be populated with `null`.

Example of a [Get document request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/documents/-id-) without schema

`GET` `/api/dataentities/client/documents/{id}?_fields={fields}`

`1

{

2

 "clientEmail": "vtext@mail.com",

3

 "address": "1"

4

}

`

Example of a [Get document request](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/api-reference/master-data-api-v2%23get-/api/dataentities/-dataEntityName-/documents/-id-) using a schema with a link

In this request, you must use the `_schema` and the `_fields` query parameters for the linked fields to return correctly.

`GET` `/api/dataentities/client/documents/{id}?_schema={schema}&_fields={fields}`

`1

{

2

 "clientEmail": "vtext@mail.com",

3

 "address": "1"

4

 "address_linked": {

5

 "id": "1"

6

 "city": "Rio de Janeiro"

7

 }

8

}

`

Contributors

1

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

Was this helpful?

Yes

No

[Suggest Edits (GitHub)](https://read.calvincode.net/reader?url=https://github.com/vtexdocs/dev-portal-content/edit/main/docs/guides/Master-Data/master-data-v2/creating-relationships-between-data-entities-using-master-data-v2.md)

[Master Data v2 document saving flow« Previous](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2//docs/guides/master-data-v2-document-saving-flow)[Using dynamic expressions on Master Data v2Next »](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2//docs/guides/using-dynamic-expressions-on-master-data-v2)

Contributors

1

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

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23before-you-begin)

[Establishing relationships](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23establishing-relationships)

[Response handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23response-handling)

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/Master-Data/master-data-v2/creating-relationships-between-data-entities-using-master-data-v2.md)

Copy page

On this page

ON THIS PAGE

[Before you begin](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23before-you-begin)

[Establishing relationships](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23establishing-relationships)

[Response handling](https://read.calvincode.net/reader?url=https://developers.vtex.com/docs/guides/creating-relationships-between-data-entities-using-master-data-v2/docs/guides/creating-relationships-between-data-entities-using-master-data-v2%23response-handling)

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