Create material instance

POST /v1/materials/instances

Create material instance

Add a new spool to your inventory

Requires: material.instance.create

Request Body

Spool data with variant and remaining weight

MaterialInstanceInsert

externalIdoptional

string

materialIdrequired

string

pattern: ^[a-z0-9]{24}$

materialTyperequired

string

remainingMaterialrequired

number

min: 0

sourceoptional

string

variantIdrequired

string

pattern: ^[a-z0-9]{24}$

Example Request

application/json

{
  "materialId": "string",
  "variantId": "string",
  "materialType": "string",
  "remainingMaterial": 0
}

Response Schema

MaterialInstance

createdAtrequired

string

format: date-time

externalIdoptional

string

idrequired

string

pattern: ^[a-z0-9]{24}$

materialIdrequired

string

pattern: ^[a-z0-9]{24}$

materialTyperequired

string

remainingMaterialrequired

number

min: 0

sourceoptional

string

storeIdrequired

string

pattern: ^[a-z0-9]{24}$

updatedAtrequired

string

format: date-time

variantIdrequired

string

pattern: ^[a-z0-9]{24}$

Example Response

201 OK — application/json

{
  "variantId": "string",
  "materialId": "string",
  "materialType": "string",
  "remainingMaterial": 0,
  "id": "string",
  "storeId": "string",
  "createdAt": "2026-08-24T03:58:55.617Z",
  "updatedAt": "2026-08-24T03:58:55.617Z"
}