Master Data is a VTEX database platform solution, which is highly customizable, and it also enables you to create applications.

By default, Master Data is used to store and organize Customer data from your store. It features a powerful search engine, allowing you to store, search, expand, and customize data.

In this article you will learn more about each available version of the Master Data, important concepts, and how to use it.

Note that depending on the functionality and version you wish to use, it is necessary to contact your development team.

Currently there are two versions available and you can choose the one that best suits your operational needs. The main difference between the two is that v2 does not have a graphical interface and can be used only through Master Data v2 API, although it has other relevant functionalities, such as the use of JSON schemas.

VTEX automatically saves customer data from your store in Master Data v1.

Check the table below to learn more about the different functionalities of each version.

Functionality	v1	v2	Learn more
Graphical interface	Yes	No	-
API	Yes	Yes	- Master Data v1 API - Master Data v2 API
Importing and exporting spreadsheets	Yes	No	- Import data into Master Data v1 - Export data from Master Data v1
Attachments (imagens)	Yes	No	-
Triggers	Yes	Yes	- Triggers - Creating triggers with Master Data v1 - Creating triggers with Master Data v2
JSON Schemas	No	Yes	- JSON schemas - Understanding JSON schemas - Starting to work with JSON schemas in Master Data v2 - Schema life cycle in Master Data v2
Nested properties	No	Yes	- Nested properties
Data entities	Referenced by acronyms composed of two capital letters. For example, the 'CL' entity stores client data from the store and 'AD' stores addresses. Cannot be created via API.	Referenced by their names. For example, 'Notification'. Can only be created via API.	- Data entities - Data entities in Master Data v1 - Creating relationships between Master Data v2 data entities
Fields	Must be filled in in the specific format configured in the data entity.	At first, there is no restriction on fields's formats. Format is validated through JSON schemas.	- Field types in Master Data v1 - JSON schemas
Indexes	Yes	Yes	- How to set up indexes in Master Data v1 - How to set up indexes with Master Data v2 API

Note that the data entities of the two versions are independent, even if some may be analogous. This means that a data created in a v1 entity cannot be queried or edited using v2 resources and vice versa.

Both versions of Master Data use some basic components, which may be equivalent to concepts found in other database solutions, with other names such as record or table. Below you can find more details about:

• Data entities
• Documents
• Fields
• Indexes

Data entities are in the form of tables where documents and fields are recorded.

Master Data v1 data entities are referenced by acronyms composed of two capital letters. In v2, you can use the name of the data entity. For example, in v1, the 'CL' entity stores Client data from the store and 'AD' stores client addresses. Equivalent entities in v2 can be referenced with names such as 'Client' and 'Address'.

In a data entity date, the information is structured in documents and fields.

Documents are records in a data entity. If data entities are in the form of tables, each document represents a row in a table.

For example, within an entity that stores client data from the store, such as 'CL' or 'Client', each document contains information from a client.

Each document has an ID automatically generated by the platform at the time of its creation, a unique code that identifies that record.

The attributes that make up Master Data documents are called fields. When comparing data entities with tables, we can think of the fields as the columns of a table.

For example, in an entity that stores client data from the store, such as 'CL' or 'Client', we may fill in fields such as name, email, date of birth, and document.

In Master Data v1, the fields must be filled in in the specific format configured in the data entity. Learn more about the field types in Master Data v1.

However, in v2, there is no restriction on fields and formats. Format validation is made through JSON schemas.

Nested properties

Master Data v2 allows you to structure the data with nested properties, a structure often found in the JSON format. This concept consists of the possibility of creating composite fields from other fields, to better structure the data. For example, a client profile might have the field 'Document', which in turn consists of the 'Type' and 'Number' properties. You can also create nested triggers.

Indices are used to specify a document to be accessed, indicated by an indexed field instead of its ID.

As mentioned above, each document has an ID automatically generated by the platform at the time of its creation. If you want to query a document but do not know its ID, you can use indices.

For example, you can query a document with a client's information by specifying the value of the 'email' field for the client.

Learn more about setting up indexes in Master Data v1 or setting up indexes with Master Data v2 API.

A Master Data trigger is a mechanism that performs an action after creating or updating a document, if the conditions set in the configuration are met. These actions can be of three types:

• Send HTTP request.
• Send an email.
• Save document in another data entity.

Learn more about how to configure triggers in Master Data v1 or how to configure triggers with Master Data v2 API

With Master Data v2, you can define data formats with JSON schemas. This format indicates how the Master Data should validate and index documents.

Learn more about JSON schemas.

You can save a document to any data entity if the content is a valid JSON. A data entity may or may not have multiple JSON schemas associated with it.

A document can be compatible with multiple JSON Schemas, but also with none.

Both versions of Master Data are extremely flexible, allowing you to meet a variety of your store's needs. You may check below some examples of applying Master Data functionalities.

With v2 triggers, you can establish multiple actions for the same trigger by setting the load percentage that each action should receive. Therefore, it is possible to comparatively test the impact of different automations on your store.

Learn how to configure A/B testing with Master Data v2.

Master Data can also be used to create abandoned cart integrations, i.e. performing automatic actions whenever clients add products to their store cart and log out without checking out.

To learn more, please see this guide on abandoned cart configuration