Master Data API - v1
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.
Do not use Master Data as a log, cache, or temporary data store. Writing high volumes of disposable data can trigger API throttling and degrade store performance.
Endpoints
Data entities
| Summary | Method | Path |
|---|---|---|
| List data entities | GET | /api/dataentities |
| Get data entity structure | GET | /api/dataentities/{acronym} |
Documents
| Summary | Method | Path |
|---|---|---|
| Create new document | POST | /api/dataentities/{acronym}/documents |
| Create partial document | PATCH | /api/dataentities/{acronym}/documents |
| Get document | GET | /api/dataentities/{acronym}/documents/{id} |
| Create document with custom ID or update entire document | PUT | /api/dataentities/{acronym}/documents/{id} |
| Update partial document | PATCH | /api/dataentities/{acronym}/documents/{id} |
| Delete document | DELETE | /api/dataentities/{acronym}/documents/{id} |
Customer profiles
| Summary | Method | Path |
|---|---|---|
| Create new customer profile | POST | /api/dataentities/CL/documents |
| Update customer profile | PATCH | /api/dataentities/CL/documents/{id} |
| Delete customer profile | DELETE | /api/dataentities/CL/documents/{id} |
Addresses
| Summary | Method | Path |
|---|---|---|
| Create new customer address | POST | /api/dataentities/AD/documents |
| Get address by ID | GET | /api/dataentities/AD/documents/{addressId} |
| Update address by ID | PATCH | /api/dataentities/AD/documents/{addressId} |
| Delete address by ID | DELETE | /api/dataentities/AD/documents/{addressId} |
Versions
| Summary | Method | Path |
|---|---|---|
| List versions | GET | /api/dataentities/{acronym}/documents/{id}/versions |
| Get version | GET | /api/dataentities/{acronym}/documents/{id}/versions/{versionId} |
| Update version | PUT | /api/dataentities/{acronym}/documents/{id}/versions/{versionId} |
Scroll
| Summary | Method | Path |
|---|---|---|
| Scroll documents | GET | /api/dataentities/{acronym}/scroll |
Search
| Summary | Method | Path |
|---|---|---|
| Search documents | GET | /api/dataentities/{acronym}/search |
Attachments
| Summary | Method | Path |
|---|---|---|
| Retrieve attachment | GET | /api/dataentities/{acronym}/documents/{id}/{field}/attachments/{file-name} |
| Save attachment | POST | /api/dataentities/{acronym}/documents/{id}/{field}/attachments |
Clusters
| Summary | Method | Path |
|---|---|---|
| Validate document by clusters | POST | /api/dataentities/{acronym}/documents/{id}/clusters |
Score
| Summary | Method | Path |
|---|---|---|
| Update scores | PUT | /api/dataentities/{acronym}/documents/{id}/score |
| Update score by field | PUT | /api/dataentities/{acronym}/documents/{id}/score/{field-name} |
| Delete score by field | DELETE | /api/dataentities/{acronym}/documents/{id}/score/{field-name} |