stock.setLevel

Track stock for a price book material, or correct its count after a physical count: sets the count on hand and the low point (stock.low is sent when the count falls to or below it; null for none). Owner or office.

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

When to use it

Track stock for a price book material, or correct its count after a physical count: sets the count on hand and the low point (stock.low is sent when the count falls to or below it; null for none). Owner or office.

What to tell the owner

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

Input

FieldTypeRequired
shop_idstring (uuid)yes
pricebook_item_idstring (uuid)yes
on_handnumberyes
low_at['number', 'null']no
notestringno

Example

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

{
  "shop_id": "00000000-0000-4000-8000-000000000000",
  "pricebook_item_id": "00000000-0000-4000-8000-000000000000",
  "on_hand": "..."
}

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.