Finish spools

POST /v1/materials/instances/finish

Finish spools as used up or archived, in bulk Used up writes off what is left on each spool as waste. Archived takes the spool out of on-hand stock but keeps its weight on record, so it can be restored. Either way each spool's weight leaves stock on a `retire` row in its activity, and a spool loaded in a printer slot comes out of it; the slot keeps the spool's material and color. A spool that is already finished is left as it is, with no second row, and is listed in `alreadyFinished`. An unknown id is a 404 and finishes nothing. Needs the filament-inventory and spool-tracking add-ons.

Requires: material.instance.edit

Request Body

Up to 500 spool IDs and how they were finished

FinishSpoolsRequest

instanceIdsrequired

string[]

min items: 1max items: 500

reasonrequired

"used_up" | "archived"

`used_up` writes off what is left as waste. `archived` takes the spool out of on-hand stock but keeps its weight on record.

used_uparchived

Example Request

application/json

{
  "instanceIds": [
    "string"
  ],
  "reason": "used_up"
}

Response Schema

FinishSpoolsResponse

alreadyFinishedrequired

string[]

Spools that were already finished and were left as they were.

finishedrequired

string[]

Spools finished by this request.

Example Response

201 OK — application/json

{
  "finished": [
    "string"
  ],
  "alreadyFinished": [
    "string"
  ]
}