Read multiple Items

POST /items/batch

Status codes

  • 200 on success
  • 400 on invalid request
  • 404 if any of the items are missing

Request properties

  • ids: An array of item ids to read.

Response properties

  • items: Array of item objects.

You can see all the Item properties on the GET /items/:id page under "Response properties".

Example request and response

Request body:

{
  "ids": ["itm_oh0IyIjqvd", "itm_xAWy4N9VCg"]
}

Response body:

{
  "items": [
    {
      "id": "itm_oh0IyIjqvd",
      "category": "cat_KaNDv51Gh0",
      "name": "Vodka",
      "vessel": {
        "size": 7,
        "unit": "dl",
        "type": "BO"
      },
      "bundles": [
        {
          "type": "CT",
          "size": 6
        }
      ],
      "price": 750,
      "supplier": {
        "id": 1693919950079,
        "reference": "1100992"
      }
    },
    {
      "id": "itm_xAWy4N9VCg",
      "category": "cat_myTRpvnsNb",
      "name": "Chicken breast",
      "vessel": {
        "size": 1,
        "unit": "kg"
      },
      "price": 990,
      "price_per": "kg",
      "order_by": "kg",
      "supplier": {
        "id": 1663919969543,
        "reference": "prd-chicken-998"
      }
    }
  ]
}