---
name: master-data-api-v2
description: "Master Data API - v2 API skill. Use when working with Master Data API - v2 for api. Covers 20 endpoints."
version: 1.0.0
generator: lapsh
---

# Master Data API - v2
API version: 1.0

## Auth
ApiKey X-VTEX-API-AppKey in header | ApiKey X-VTEX-API-AppToken in header | ApiKey VtexIdclientAutCookie in header

## Base URL
https://apiexamples.vtexcommercestable.com.br

## Setup
1. Set your API key in the appropriate header
2. GET /api/dataentities/{dataEntityName}/search -- verify access
3. POST /api/dataentities/{dataEntityName}/documents -- create first documents

## Endpoints

20 endpoints across 1 groups. See references/api-spec.lap for full details.

### api
| Method | Path | Description |
|--------|------|-------------|
| POST | /api/dataentities/{dataEntityName}/documents | Create new document |
| PATCH | /api/dataentities/{dataEntityName}/documents | Create partial document |
| GET | /api/dataentities/{dataEntityName}/documents/{id} | Get document |
| PUT | /api/dataentities/{dataEntityName}/documents/{id} | Create document with custom ID or update entire document |
| PATCH | /api/dataentities/{dataEntityName}/documents/{id} | Update partial document |
| DELETE | /api/dataentities/{dataEntityName}/documents/{id} | Delete document |
| GET | /api/dataentities/{dataEntityName}/search | Search documents |
| GET | /api/dataentities/{dataEntityName}/scroll | Scroll documents |
| GET | /api/dataentities/{dataEntityName}/schemas | Get schemas |
| GET | /api/dataentities/{dataEntityName}/schemas/{schemaName} | Get schema by name |
| PUT | /api/dataentities/{dataEntityName}/schemas/{schemaName} | Save schema by name |
| DELETE | /api/dataentities/{dataEntityName}/schemas/{schemaName} | Delete schema by name |
| GET | /api/dataentities/{dataEntityName}/indices | Get indices |
| PUT | /api/dataentities/{dataEntityName}/indices | Create index |
| GET | /api/dataentities/{dataEntityName}/indices/{index_name} | Get index by name |
| DELETE | /api/dataentities/{dataEntityName}/indices/{index_name} | Delete index by name |
| POST | /api/dataentities/{dataEntityName}/documents/{id}/clusters | Validate document by clusters |
| GET | /api/dataentities/{dataEntityName}/documents/{id}/versions | List versions |
| GET | /api/dataentities/{dataEntityName}/documents/{id}/versions/{versionId} | Get version |
| PUT | /api/dataentities/{dataEntityName}/documents/{id}/versions/{versionId} | Update version |

## Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "Create a document?" -> POST /api/dataentities/{dataEntityName}/documents
- "Get document details?" -> GET /api/dataentities/{dataEntityName}/documents/{id}
- "Update a document?" -> PUT /api/dataentities/{dataEntityName}/documents/{id}
- "Partially update a document?" -> PATCH /api/dataentities/{dataEntityName}/documents/{id}
- "Delete a document?" -> DELETE /api/dataentities/{dataEntityName}/documents/{id}
- "List all search?" -> GET /api/dataentities/{dataEntityName}/search
- "List all scroll?" -> GET /api/dataentities/{dataEntityName}/scroll
- "List all schemas?" -> GET /api/dataentities/{dataEntityName}/schemas
- "Get schema details?" -> GET /api/dataentities/{dataEntityName}/schemas/{schemaName}
- "Update a schema?" -> PUT /api/dataentities/{dataEntityName}/schemas/{schemaName}
- "Delete a schema?" -> DELETE /api/dataentities/{dataEntityName}/schemas/{schemaName}
- "List all indices?" -> GET /api/dataentities/{dataEntityName}/indices
- "Get indice details?" -> GET /api/dataentities/{dataEntityName}/indices/{index_name}
- "Delete a indice?" -> DELETE /api/dataentities/{dataEntityName}/indices/{index_name}
- "Create a cluster?" -> POST /api/dataentities/{dataEntityName}/documents/{id}/clusters
- "List all versions?" -> GET /api/dataentities/{dataEntityName}/documents/{id}/versions
- "Get version details?" -> GET /api/dataentities/{dataEntityName}/documents/{id}/versions/{versionId}
- "Update a version?" -> PUT /api/dataentities/{dataEntityName}/documents/{id}/versions/{versionId}
- "How to authenticate?" -> See Auth section

## Response Tips
- Check response schemas in references/api-spec.lap for field details
- Create/update endpoints typically return the created/updated object

## CLI

```bash
# Update this spec to the latest version
npx @lap-platform/lapsh get master-data-api-v2 -o references/api-spec.lap

# Search for related APIs
npx @lap-platform/lapsh search master-data-api-v2
```

## References
- Full spec: See references/api-spec.lap for complete endpoint details, parameter tables, and response schemas

> Generated from the official API spec by [LAP](https://lap.sh)