stock.list

Tracked materials with the count on hand and low point. low_only lists only those at or below their low point (a reorder list).


Who	Agents can call this
REST	`GET /v1/stock`
MCP tool	`stock_list`
Writes	no
Area	Shop

When to use it

Tracked materials with the count on hand and low point. low_only lists only those at or below their low point (a reorder list).

What to tell the owner

Tell them what you found in plain words. Don't read back raw fields.

Input

Field	Type	Required
`shop_id`	string (uuid)	yes
`low_only`	boolean	no
`include_archived`	boolean	no

Example

GET https://doingwork.work/v1/stock?shop_id=00000000-0000-4000-8000-000000000000

Output

Field	Type	Always there
`items`	array	yes
`items[].pricebook_item_id`	string (uuid)	yes
`items[].shop_id`	string (uuid)	yes
`items[].name`	string	yes
`items[].unit`	string	yes
`items[].on_hand`	number	yes
`items[].low_at`	['number', 'null']	yes
`items[].low`	boolean	yes
`items[].archived`	boolean	yes
`items[].updated_by`	['string', 'null', ' ', '(', 'u', 'u', 'i', 'd', ')']	yes
`items[].updated_at`	string (date-time)	yes
`low_count`	integer	yes

{
  "items": [
    {
      "pricebook_item_id": "00000000-0000-4000-8000-000000000000",
      "shop_id": "00000000-0000-4000-8000-000000000000",
      "name": "Ruiz Plumbing",
      "unit": "...",
      "on_hand": "...",
      "low_at": "...",
      "low": true,
      "archived": true,
      "updated_by": "00000000-0000-4000-8000-000000000000",
      "updated_at": "..."
    }
  ],
  "low_count": 1
}

Errors

Code	Status	What to do
`invalid_input`, `invalid_token`, `rate_limited`		Can happen on any call. See errors.