API Reference

Master DataGetting started
Master Data v2 basics

Master Data v2 provides a powerful data base solution for your store, that you can manage via the Master Data v2 API. Below you can learn about some basic features and how to use them.

Saving documents

If you do not need to validate your data, you may save your documents without any setup. You can use the following API requests:

In case you need to validate the data, you must first create a JSON schema. After that, you'll add the name of the JSON Schema to the query, like in this example:


Retrieving documents

There are three ways of retrieving documents. If you have the document's ID, you must use the Get document endpoint.

To get multiple documents, you may use the Search documents API request.

And finally, if you want to get all documents that attend to a specific set of criteria, you must use the Scroll documents API endpoint.

The documents could comply with none or multiple JSON Schemas. You may add the _schema parameter to the query to filter the documents based in the JSON Schema. See the example below.

api/dataentities/{data-entity-name}/documents/{id}?_schema={my-schema} api/dataentities/{data-entity-name}/search?_schema={my-schema} api/dataentities/{data-entity-name}/scroll?_schema={my-schema}
Photo of the contributor
Photo of the contributor
Photo of the contributor
+ 3 contributors
Was this helpful?
Suggest edits (Github)
On this page