Update material instance

PUT /v1/materials/instances/{id}

Update material instance

Update spool information (e.g., remaining weight)

Requires: material.instance.edit

Path Parameters

id required

string

Instance ID

Request Body

Fields to update

PartialMaterialInstance

createdAtoptional

string

format: date-time

externalIdoptional

string

idoptional

string

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

materialIdoptional

string

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

materialTypeoptional

string

remainingMaterialoptional

number

min: 0

sourceoptional

string

storeIdoptional

string

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

updatedAtoptional

string

format: date-time

variantIdoptional

string

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

Example Request

application/json

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

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

200 OK — application/json

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