vtex.local – MasterData-API-

Tools (22)

Extracted live via the executor SDK.

• attachments.retrieveattachment

  Use this API to retrieve a file.

  Be sure to include the file extension in the name. Like in this example:

  /dataentities/CL/documents/123/file/attachments/image.png

• attachments.saveattachment

  This 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 can upload more than one file. Just add a new field in the form-data with type File.

• clusters.validateDocumentbyClusters
• dataEntities.getdataentitystructure

  Returns 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: Retrieves data entity structure

  All headers listed below are required.

• dataEntities.listdataentities

  Retrieves 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 entity list

  All headers listed below are required.

• documents.createnewdocument

  Creates documents through a JSON object where the key is the name of the field.

• documents.createorupdateentiredocument
• documents.createorupdatepartialdocument
• documents.deletedocument

  It allows to delete a document.

• documents.getdocument

  Retrieves 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.

• documents.updateentiredocument
• documents.updatepartialdocument
• score.deletescorebyfield

  Allows you to remove a key from a specific field.

• score.putscorebyfield

  It allows to punctuate in a specific field.

• score.putscores

  It allows punctuate in more than one field and more than one key.

• scroll.scrolldocuments

  Scrolls through documents according to the query parameter filters.

  Avoid sending too many requests with wildcards (*) in the search parameters or that use the keyword parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code 429.

  Use all the features of search API to perform filters.

  In the first request, the X-VTEX-MD-TOKEN token will be obtained in the header. This token must be passed to the next request in the query string _token parameter. The token has a timeout of 10 minutes, which refreshes after each request.

  ATTENTION: To inform the number of documents per request, use the query string parameter _size, which has the maximum value of 1000.

  After the token is obtained it is no longer necessary to send the filter or document size per page parameters. You only need to resend the token until the document collection is empty.

  First request example:

  /dataentities/CL/scroll?isCluster=true&_size=250&_fields=email,firstName

  After the first request, retrieve the token in the header X-VTEX-MD-TOKEN and make the next requests.

  Example of subsequent requests:

  /dataentities/CL/scroll?_token=tokenvalueexample

• search.searchdocuments

  Search documents by the query parameters described below.

  Avoid sending too many requests with wildcards (*) in the search parameters or that use the keyword parameter. This may lead to this endpoint being temporarily blocked for your account. If this happens you will receive an error with status code 503.

• versions.getversion

  Returns the version of a document.

• versions.listversions

  Allows to list the versions of a document.

• versions.putversion

  Updates document with version values.

• openapi.previewSpec

  Preview an OpenAPI document before adding it as a source

• openapi.addSource

  Add an OpenAPI source and register its operations as tools