VTEX

MasterData API - v1

MasterData API - v1 endpoints from VTEX

Other#openapi

Fork copies the collection into your workspace, without the publisher's secrets, so you can add your own key and send requests. Star saves it to your starred APIs (Account › Marketplace) and helps others find it.

Overview

MasterData API - v1 endpoints from VTEX

Endpoints 20

Attachments

  • POSTSave attachment/api/dataentities/:acronym/documents/:id/:field/attachmentsThis API allows you to save a file in a field of type File. When using in javascript, you must add the header content-type with value multipart/form-data; You…
  • GETRetrieve attachment/api/dataentities/:acronym/documents/:id/:field/attachments/:file-nameUse this API to retrieve a file. Be sure to include the file extension in the name. Like in this example:…

Clusters

  • POSTValidate Document by Clusters/api/dataentities/:acronym/documents/:id/clusters

Data Entities

  • GETList data entities/api/dataentitiesRetrieves the list of existing data entities in the store. Response status code 1. Status Code 403: Access not allowed 2. Status Code 200: Retrieves data…
  • GETGet data entity structure/api/dataentities/:acronymReturns the data entity structure with its respective fields and data type. Response status code 1. Status Code 403: Access not allowed 2. Status Code 200:…

Documents

  • PUTCreate or update entire document/api/dataentities/:acronym/documents
  • POSTCreate new document/api/dataentities/:acronym/documentsCreates documents through a JSON object where the key is the name of the field.
  • PATCHCreate or update partial document/api/dataentities/:acronym/documents
  • GETGet document/api/dataentities/:acronym/documents/:idRetrieves a document. Assign the _fields parameter in the query string to retrieve the desired fields. If you want to return all the fields use _fields=_all.
  • PUTUpdate entire document/api/dataentities/:acronym/documents/:id
  • DELETEDelete document/api/dataentities/:acronym/documents/:idIt allows to delete a document.
  • PATCHUpdate partial document/api/dataentities/:acronym/documents/:id

Score

  • PUTPut scores/api/dataentities/:acronym/documents/:id/scoreIt allows punctuate in more than one field and more than one key.
  • PUTPut score by field/api/dataentities/:acronym/documents/:id/score/:field-nameIt allows to punctuate in a specific field.
  • DELETEDelete score by field/api/dataentities/:acronym/documents/:id/score/:field-nameAllows you to remove a key from a specific field.

Scroll

  • GETScroll documents/api/dataentities/:acronym/scrollScrolls through documents according to the query parameter filters. > Avoid sending too many requests with wildcards (*) in the search parameters or that use…

Search

  • GETSearch documents/api/dataentities/:acronym/search?_fields=email,firstName,document&_where=firstName is not null&_schema={{schema}}&_keyword=String to search&_sort=firstName ASCSearch documents by the query parameters described below. > Avoid sending too many requests with wildcards (*) in the search parameters or that use the…

Versions

  • GETList versions/api/dataentities/:acronym/documents/:id/versionsAllows to list the versions of a document.
  • GETGet version/api/dataentities/:acronym/documents/:id/versions/:versionIdReturns the version of a document.
  • PUTPut version/api/dataentities/:acronym/documents/:id/versions/:versionIdUpdates document with version values.

API details

Base URL
https://vtex.local
https://{accountName}.{environment}.com.br
Authentication
An API key in the X-VTEX-API-AppKey header
An API key in the X-VTEX-API-AppToken header
Operations
20 operations on 13 pathsGET 8PUT 5POST 3PATCH 2DELETE 2
Main resources
Documents 7Score 3Versions 3Attachments 2Data Entities 2Clusters 1Scroll 1Search 1
Response formats
application/json
Description format
OpenAPI 3.0.0, API version 1.0
Listed from
APIs.guru OpenAPI Directory (CC0-1.0)
Source updated

How to test the MasterData API - v1 in Swastik Codes

  1. Open the APISelect “Fork & run in Swastik Codes” on this page. Sign in or create a free account if asked.
  2. Fork it into your workspaceChoose a workspace. You get your own copy of the MasterData API - v1 collection, without the publisher's secrets.
  3. Add your credentialsThis API uses an API key in the X-VTEX-API-AppKey header. Add yours in the collection's variables or an environment; the requests already reference it.
  4. Send a requestPick an endpoint, for example “Save attachment” (POST /api/dataentities/:acronym/documents/:id/:field/attachments), and press Send. Check the response, add tests and run the whole collection with the runner.

Frequently asked questions

What is the MasterData API - v1?

MasterData API - v1 endpoints from VTEX It is listed under Other and has 20 endpoints.

Who publishes the MasterData API - v1?

It is listed from VTEX's public API description (an OpenAPI document), not published by VTEX on Swastik Codes. Anyone who controls vtex.com can claim the profile by adding a DNS TXT record.

What is the base URL of the MasterData API - v1?

Its description lists 2 base URLs: https://vtex.local, https://{accountName}.{environment}.com.br. The first is the usual one; the others are typically sandbox or regional servers.

How do I authenticate with the MasterData API - v1?

It accepts 2 methods: an API key in the X-VTEX-API-AppKey header; an API key in the X-VTEX-API-AppToken header.

How many endpoints does the MasterData API - v1 have?

20 operations on 13 paths (8 GET, 5 PUT, 3 POST, 2 PATCH, 2 DELETE). The largest groups are Documents, Score, Versions, Attachments.

Is forking the MasterData API - v1 free?

Yes. Forking copies the collection into your workspace for free. It has been starred 0 times and forked 0 times.

Suggest an API

Tell us which public API is missing. We check it, then add it here with its endpoints when it has an OpenAPI (Swagger) description.