Get a spool serial

GET /v1/materials/spools/serial/{serial}

A spool serial as inventory and the printers know it `spoolId` is the spool in inventory carrying the serial (an active one, else the newest used up or archived one), null when none does. `slots` are the printer slots whose last tag read is this serial, newest first, each with the printer's remaining percent (null when it does not measure the roll) and what that leaves on the roll, read against the roll weight the printer reports, else the material's last delivered roll size, else the store's default spool size, else 1 kg. The prints that used the roll come from `GET /v1/print-history/serials/:serial/attempts`. Needs the filament-inventory and spool-tracking add-ons.

Requires: material.instance.view

Path Parameters

serial required

string

The spool serial

Response Schema

ReadSpool

serialrequired

string

slotsrequired

object[]

Slots whose last tag read is this serial.

amsIndexrequired

number

estimatedGramsrequired

number

What the roll holds by the printer's percent (see readSpoolGrams).

instanceIdrequirednullable

string

The inventory spool loaded in the slot, if any.

materialIdrequirednullable

string

printerIdrequired

string

printerNamerequired

string

remainingPercentrequirednullable

number

The printer's remaining percent, 1-100, or null when it does not measure the roll.

rollGramsrequired

number

The full roll weight the estimate reads against (see readSpoolRollGrams).

slotIndexrequired

number

variantIdrequirednullable

string

spoolFinishedrequired

boolean

Whether that spool is used up or archived.

spoolIdrequirednullable

string

The inventory spool carrying the serial: an active one, else the newest finished one.

Example Response

200 OK — application/json

{
  "serial": "string",
  "spoolId": "string",
  "spoolFinished": true,
  "slots": [
    {
      "printerId": "string",
      "printerName": "string",
      "amsIndex": 1,
      "slotIndex": 1,
      "materialId": "string",
      "variantId": "string",
      "instanceId": "string",
      "remainingPercent": 1,
      "rollGrams": 1,
      "estimatedGrams": 1
    }
  ]
}