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

# Master Data API - v1
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 -- verify access
3. POST /api/dataentities/{acronym}/documents -- create first documents

## Endpoints

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

### api
| 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/{acronym}/documents/{id}/versions | List versions |
| GET | /api/dataentities/{acronym}/documents/{id}/versions/{versionId} | Get version |
| PUT | /api/dataentities/{acronym}/documents/{id}/versions/{versionId} | Update version |
| GET | /api/dataentities/{acronym}/scroll | Scroll documents |
| GET | /api/dataentities/{acronym}/search | Search documents |
| GET | /api/dataentities/{acronym}/documents/{id}/{field}/attachments/{file-name} | Retrieve attachment |
| POST | /api/dataentities/{acronym}/documents/{id}/{field}/attachments | Save attachment |
| POST | /api/dataentities/{acronym}/documents/{id}/clusters | Validate document by clusters |
| PUT | /api/dataentities/{acronym}/documents/{id}/score | Update scores |
| PUT | /api/dataentities/{acronym}/documents/{id}/score/{field-name} | Update score by field |
| DELETE | /api/dataentities/{acronym}/documents/{id}/score/{field-name} | Delete score by field |
| POST | /api/dataentities/CL/documents | Create new customer profile |
| PATCH | /api/dataentities/CL/documents/{id} | Update customer profile |
| DELETE | /api/dataentities/CL/documents/{id} | Delete customer profile |
| POST | /api/dataentities/AD/documents | Create new customer address |
| GET | /api/dataentities/AD/documents/{addressId} | Get address by ID |
| PATCH | /api/dataentities/AD/documents/{addressId} | Update address by ID |
| DELETE | /api/dataentities/AD/documents/{addressId} | Delete address by ID |

## Common Questions

Match user requests to endpoints in references/api-spec.lap. Key patterns:
- "List all dataentities?" -> GET /api/dataentities
- "Get dataentity details?" -> GET /api/dataentities/{acronym}
- "Create a document?" -> POST /api/dataentities/{acronym}/documents
- "Get document details?" -> GET /api/dataentities/{acronym}/documents/{id}
- "Update a document?" -> PUT /api/dataentities/{acronym}/documents/{id}
- "Partially update a document?" -> PATCH /api/dataentities/{acronym}/documents/{id}
- "Delete a document?" -> DELETE /api/dataentities/{acronym}/documents/{id}
- "List all versions?" -> GET /api/dataentities/{acronym}/documents/{id}/versions
- "Get version details?" -> GET /api/dataentities/{acronym}/documents/{id}/versions/{versionId}
- "Update a version?" -> PUT /api/dataentities/{acronym}/documents/{id}/versions/{versionId}
- "List all scroll?" -> GET /api/dataentities/{acronym}/scroll
- "List all search?" -> GET /api/dataentities/{acronym}/search
- "Get attachment details?" -> GET /api/dataentities/{acronym}/documents/{id}/{field}/attachments/{file-name}
- "Create a attachment?" -> POST /api/dataentities/{acronym}/documents/{id}/{field}/attachments
- "Create a cluster?" -> POST /api/dataentities/{acronym}/documents/{id}/clusters
- "Update a score?" -> PUT /api/dataentities/{acronym}/documents/{id}/score/{field-name}
- "Delete a score?" -> DELETE /api/dataentities/{acronym}/documents/{id}/score/{field-name}
- "Create a document?" -> POST /api/dataentities/CL/documents
- "Partially update a document?" -> PATCH /api/dataentities/CL/documents/{id}
- "Delete a document?" -> DELETE /api/dataentities/CL/documents/{id}
- "Create a document?" -> POST /api/dataentities/AD/documents
- "Get document details?" -> GET /api/dataentities/AD/documents/{addressId}
- "Partially update a document?" -> PATCH /api/dataentities/AD/documents/{addressId}
- "Delete a document?" -> DELETE /api/dataentities/AD/documents/{addressId}
- "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-v1 -o references/api-spec.lap

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

## 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)