Master Data API - v2

Master Data v2 is not compatible with data entities from previous versions, such as CL and AD.

Master Data is a secure, fast, scalable, and extensible solution that allows users to create their own entities, store data, and retrieve information directly from the storefront or external integrations.

Several internal VTEX modules use Master Data as a data repository, including Orders and Sales App.

There are two main ways to use Master Data:

• Directly from the storefront
• With an external integration

Directly from the storefront

When using Master Data within the storefront, consider the following:

• Use the storefront host to query or store information to avoid issues related to Cross-origin resource sharing (CORS).
• Use the relative path to avoid CORS issues.
• Configure the JSON Schema of the Data Entity to specify which information should be public and which should not be.
• Avoid creating query loops to prevent potential throttling issues or APIs being disabled due to security protection measures.
• Never add authentication keys, such as X-VTEX-API-AppKey or X-VTEX-API-AppToken, via JavaScript as this could pose security risks.

External integrations

When using Master Data to store data from an external integration, such as client data from another service, consider the following:

• Use the host {{accountName}}.vtexcommercestable.com.br.
• Use the authentication keys (X-VTEX-API-AppKey ou X-VTEX-API-AppToken).

Common parameters

Name	Description
accountName	Account name in VTEX License Manager.
name	Data Entity name.
schema	JSON Schema of a Data Entity.
id	Identifier of a document.
X-VTEX-API-AppKey	appKey.
X-VTEX-API-AppToken	appToken.