COMPOST

Deposit compost

Deposit compost into a compost bin

put/v2/compost/{compostBinId}

Request

  • Base URL: https://api.zee-verse.com (the document declares no server; this is the origin it was published from)
  • URL: https://api.zee-verse.com/v2/compost/{compostBinId}
  • Auth: HTTP bearer

Path parameters

compostBinIdstring required

Request body

itemIdstring uuid required

Unique inventory ID of the compost item

compostbinIdstring uuid required

Unique compost bin ID

amountnumber required

Amount of compost to deposit

Example request

{
  "itemId": "123e4567-e89b-12d3-a456-426614174000",
  "compostbinId": "123e4567-e89b-12d3-a456-426614174000",
  "amount": 1
}

Response

Compost deposited

idstring uuid required
userIdstring uuid required
binKeystring required
depositednumber required
processIdstring uuid
readyboolean required

Example response

{
  "result": {
    "itemId": "123456789",
    "amount": 1,
    "slot": "17"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.