Master Data API - v1

Name: Master Data API - v1 API
Brand: Master Data API - v1
Availability: InStock

★ Only Publicly Available OpenAPI DocumentE CommerceStorefrontapiKey25 EndpointsREST

For Agents

Programmatically list data entities, get data entity structure. Covers 25 operations with apiKey authentication.

Connect the Master Data API - v1 to your agent

Jentic One is a self-hosted execution layer for AI agents. It lets your agent call the Master Data API - v1, or any other public or private API you need. You set the rules, the agent never sees your credentials, and every call is logged.

Install Jentic One Beta (Self-Hosted)

Jentic One Host machine

# On the machine that will host your Jentic One instance:
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh

Agent machine

# On the machine where your agent runs (keep this separate from the instance):
curl -fsSL https://raw.githubusercontent.com/jentic/jentic-one/main/tools/install.sh | sh
jentic register       # connects your agent to your Jentic One instance

Jentic One is in public beta. The setup above keeps your agent separate from the instance, which is what you want before using real credentials: an agent running as the same OS user as Jentic One can read its stored keys directly. Just evaluating? A single local install is fine to start. See the secure deployment guide for the tiers.

Capabilities

What an agent can do with Master Data API - v1 API.

List data entities

Get data entity structure

Create new document

Update partial document

Monitor Master Data API - v1 operational status and events

GET STARTED

Start building with Master Data API - v1 API

Explore with Jentic

View OpenAPI Document

Jentic publishes the only available OpenAPI document for Master Data API - v1, keeping it validated and agent-ready.

Master Data is a highly customizable VTEX database solution, which 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. Learn more about [Master Data v1](https://help.vtex.com/en/tutorial/master-data--4otjBnR27u4WUIciQsmkAw). Index Dat. The API exposes 25 endpoints secured with apiKey authentication.

Use Cases

Patterns agents use Master Data API - v1 API for, with concrete tasks.

★ E-Commerce Operations

Use the Master Data API - v1 to perform e commerce operations programmatically. The API provides 25 endpoints covering core functionality including list data entities, get data entity structure, create new document.

Call GET /api/dataentities to list data entities

Automated Data Entities Management

Automate data entities operations by combining multiple Master Data API - v1 endpoints. Agents can get data entity structure and then create new document in a single workflow.

Call GET /api/dataentities/{acronym} to get data entity structure, then verify the result

AI Agent Integration via Jentic

AI agents discover and call Master Data API - v1 endpoints through Jentic without managing credentials directly. An agent searches for the required operation by intent, receives the matching endpoint schema, and executes the call with Jentic-managed authentication. This eliminates the need to read API documentation or handle apiKey tokens manually.

Search Jentic for 'list data entities', load the operation schema, and execute with Jentic-managed credentials

Key Endpoints

25 endpoints — master data is a highly customizable vtex database solution, which enables you to create applications.

METHOD

PATH

DESCRIPTION

GET

/api/dataentities

List data entities

GET

/api/dataentities/{acronym}

Get data entity structure

POST

/api/dataentities/{acronym}/documents

Create new document

PATCH

/api/dataentities/{acronym}/documents

Create partial document

GET

/api/dataentities/{acronym}/documents/{id}

Get document

PUT

/api/dataentities/{acronym}/documents/{id}

Create document with custom ID or update entire document

PATCH

/api/dataentities/{acronym}/documents/{id}

Update partial document

DELETE

/api/dataentities/{acronym}/documents/{id}

Delete document

GET

/api/dataentities

List data entities

GET

/api/dataentities/{acronym}

Get data entity structure

POST

/api/dataentities/{acronym}/documents

Create new document

PATCH

/api/dataentities/{acronym}/documents

Create partial document

GET

/api/dataentities/{acronym}/documents/{id}

Get document

Why though Jentic?

Three things that make agents converge on Jentic-routed access.

Credential isolation

Master Data API - v1 apiKey credentials are stored encrypted in the Jentic vault (MAXsystem). Agents receive scoped access tokens — raw secrets never enter the agent context.

Intent-based discovery

Agents search by intent (e.g., 'list data entities') and Jentic returns the matching Master Data API - v1 operation with its input schema, so the agent can call the right endpoint without browsing docs.

Time to first call

Direct Master Data API - v1 integration: 1-3 days for auth handling, response parsing, and error cases. Through Jentic: under 1 hour — search, load schema, execute.

Related APIs

Alternatives and complements available in the Jentic catalogue.

Alternative

Shopify

Alternative e commerce API

Choose Shopify when you need a different approach to e commerce operations

Alternative

Stripe

Alternative e commerce API

Choose Stripe when you need a different approach to e commerce operations

FAQs

Specific to using Master Data API - v1 API through Jentic.

What authentication does the Master Data API - v1 use?

The Master Data API - v1 uses an API key passed in the `X-VTEX-API-AppKey` header. Through Jentic, these credentials are stored encrypted in the MAXsystem vault and injected at execution time, so raw secrets never enter the agent context.

Can I list data entities with the Master Data API - v1?

Yes. Use the GET /api/dataentities endpoint. The API returns structured JSON responses that agents can parse and act on directly.

What are the rate limits for the Master Data API - v1?

Rate limits are not specified in the OpenAPI spec. Check the vendor documentation for current limits. Through Jentic, rate limiting is handled automatically with retry logic built into the execution layer.

How do I list data entities through Jentic?

Install the Jentic SDK with pip install jentic, authenticate at https://app.jentic.com/sign-up, then search for 'list data entities'. Jentic returns the matching Master Data API - v1 operation with its input schema. Load the schema and execute the call — credentials are injected automatically.

How many endpoints does the Master Data API - v1 have?

The Master Data API - v1 exposes 25 endpoints covering data entities, documents, customer profiles operations.