REST API - Examples using the batch mode

Introduction

In this article, you will find examples of the provided resource usage for different operations. For each analyzed scenario, we provide an example of the data that you are expected to provide to the API, as well as an example response.

Batch mode

The batch mode allows creating and / or updating multiple elements in one request. Notice the list of resources which supports the batch mode.

The results of the different tasks (create / update) is stacked and returns one result. In addition, the batch mode supports the detaching of elements in on request.

The following resources supports the batch mode.

  • Article
  • Variant
  • Translation

To use the batch mode, send a PUT request without an id in the URL.

PUT /api/articles
[
  {
    "name": "Lorem",
    "taxId": 1,
    "mainDetail": {
        "number": "SW123456"
    }
  },
  {
    "name": "Ipsum",
    "taxId": 1,
    "mainDetail": {
        "number": "SW123457"
    }
  },
  {
    "name": "Dolor",
    "taxId": 1,
    "mainDetail": {
        "number": "SW123458"
    }
  }
]

DELETE /api/articles
[
  {
    "id": 2
  },
  {
    "id": 4
  },
  {
    "id": 6
  },
  {
    "id": 8
  }
]
Top