stock.adjust

Record stock received, used, returned, lost or adjusted for a tracked material. quantity is how much (above 0); used and lost take it away, received and returned add it, adjusted takes a signed change. Refused with 409 when it would take the count below 0. Any member.

WhoAgents can call this
RESTPOST /v1/stock/adjust
MCP toolstock_adjust
Writesyes, send an Idempotency-Key
AreaShop

When to use it

Record stock received, used, returned, lost or adjusted for a tracked material. quantity is how much (above 0); used and lost take it away, received and returned add it, adjusted takes a signed change.

What to tell the owner

Say what you did in plain words and what happens next.

Input

FieldTypeRequired
pricebook_item_idstring (uuid)yes
kindstring (one of received, used, returned, lost, adjusted)yes
quantitynumberyes
job_idstring (uuid)no
notestringno

Example

POST https://doingwork.work/v1/stock/adjust
content-type: application/json
Idempotency-Key: 3f1c...

{
  "pricebook_item_id": "00000000-0000-4000-8000-000000000000",
  "kind": "received",
  "quantity": "..."
}

Output

JSON. The response shape isn't published yet; read the fields you need and ignore the rest. Errors are {code, message, status}.

Errors

CodeStatusWhat to do
invalid_input, invalid_token, rate_limitedCan happen on any call. See errors.