Printago API
POST /v1/materials/spools/serial/{serial}

Add a spool serial to inventory

Add a roll known by its serial to inventory Creates one spool of `variantId` holding `grams`, carrying the serial, out of that color's bulk when `from` is `bulk_first` and bulk holds it (else as new stock), and loads it in the slot that last read the serial when that slot holds no spool. 409 with the `spoolId` when an active spool already carries the serial. Needs the filament-inventory and spool-tracking add-ons.

Requires: material.instance.create

Path Parameters

serial required
string
The spool serial

Request Body

The color, what the roll holds, and where it comes from

AddReadSpoolRequest
fromrequired
"bulk_first" | "new_stock"
Out of that color's bulk when bulk holds it, or always as new stock.
bulk_firstnew_stock
gramsrequired
number
What the roll holds now, in grams.
rollGramsoptionalnullable
number
The roll's full weight, when known.
variantIdrequired
string

Example Request

application/json 
{
  "variantId": "string",
  "grams": 1,
  "rollGrams": 1,
  "from": "bulk_first"
}

Response Schema

AddReadSpoolResponse
fromBulkrequired
boolean
Whether the spool came out of bulk.
spoolIdrequired
string

Example Response

201 OK — application/json 
{
  "spoolId": "string",
  "fromBulk": true
}