Adjust bulk stock

POST /v1/filament-stock/adjust

Correct a variant's bulk weight, recording who changed it and why Needs the filament-inventory add-on. A correction that would take the bucket below 0 g, or that has no reason, is refused with a 400.

Requires: material.edit

Request Body

The variant, the change or the new weight, and a reason

AdjustBulkStockRequest

deltaGramsoptional

number

Move the bucket by this much. Mutually exclusive with `setGrams`.

reasonrequired

string

Why the weight changed. Required: an unexplained correction is refused.

setGramsoptional

number

Set the bucket to this weight, ledgering the difference.

min: 0

variantIdrequired

string

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

Example Request

application/json

{
  "variantId": "string",
  "deltaGrams": 1,
  "setGrams": 0,
  "reason": "string"
}

Response Schema

Response

deltaGramsrequired

number

remainingGramsrequired

number

Example Response

201 OK — application/json

{
  "remainingGrams": 1,
  "deltaGrams": 1
}