vtex-io-masterdata

Guide VTEX IO Master Data v2 design with MasterDataClient and indexed fields.

Updated Mar 27, 2026
One-click install
npx skills add https://github.com/exilonX/ap2 --skill vtex-io-masterdata-exilonx
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: vtex-io-masterdata
Source: https://github.com/exilonX/ap2/tree/main/.agents/skills/vtex-io-masterdata
Command: npx skills add https://github.com/exilonX/ap2 --skill vtex-io-masterdata-exilonx

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

It prevents teams from misusing VTEX Master Data v2 as a default storage layer by forcing a rigorous check of whether Master Data is the right system of record for the problem at hand.

Core Features & Use Cases

  • Master Data decision guidance: Critically evaluate whether data belongs in Catalog, OMS/checkout surfaces, a BFF with caching, or an external database rather than defaulting to Master Data.
  • Correct MasterData v2 implementation: Define entities and JSON Schemas, use MasterDataClient/ctx.clients.masterdata for CRUD, and ensure query performance through indexed where fields.
  • Operational safety for scale: Avoid placing synchronous Master Data in purchase-critical paths, respect pagination/scroll behavior, manage trigger usage, and plan around the 60-schema limit.

Quick Start

Use the vtex-io-masterdata skill to review your VTEX IO Master Data design and validate that your entities, schemas, indexing, and access patterns are correct and safe for production.

Frequently Asked Questions about vtex-io-masterdata

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I decide if VTEX Master Data v2 is the right persistence layer for my data?

VTEX Master Data v2 should only be used after evaluating whether data belongs in Catalog, OMS, a BFF with caching, or an external database. This prevents misusing Master Data as a default storage layer.

How do I perform CRUD operations in Master Data v2 correctly?

Perform CRUD operations in Master Data v2 strictly using the MasterDataClient or ctx.clients.masterdata. Direct REST API calls are prohibited to ensure correct and safe implementation.

What are the limits and constraints when designing JSON Schemas for VTEX IO?

VTEX IO JSON Schemas must respect a 60-schema limit, require indexed `where` fields for query performance, and need careful trigger management to maintain operational safety at scale.

Can I put synchronous Master Data calls in the VTEX checkout purchase path?

Avoid placing synchronous Master Data calls in the VTEX checkout purchase path. This operational safety measure prevents critical performance bottlenecks during high-scale transactions.

How does search indexing and pagination work in Master Data v2?

Search indexing in Master Data v2 requires indexed `where` fields for query performance. Pagination and scroll behaviors must be respected to correctly handle large data retrieval.

When should I not use Master Data as a single source of truth?

Do not use Master Data as a single source of truth when data natively belongs to Catalog, OMS, or checkout surfaces. Governance rules mandate evaluating external databases or BFFs first.