Inventory Manager API · stocktakes

The counting sheet: every of the stocktake's scope that holds stock or was counted

GET /stocktakes/{stocktakeId}/sheet

The counting sheet: every (SKU, location) of the stocktake's scope that holds stock or was counted, and every stock SKU at least once, with expected (what inventory holds there now), the counted figure, the SKU's unitCostCents and, where it has none, the suggestedCostCents its cost basis offers.

missingCost marks a SKU an opening stocktake cannot complete without (no cost on it and no cost basis); missingCosts counts them all. q narrows by SKU or name, missingCost=true to the SKUs still to value; paged by limit (1–500, 100 when omitted) and offset, total counting every match.

Access

Requires stock:read.

How scopes come from roles: Scopes and roles. Getting a token: Authentication and app tokens.

AI agent tool

Agents call this as inventory_stocktake_sheet (Inventory: Stocktake counting sheet), in the stocktakes toolset. It only reads.

Connecting an agent: AI agents.

Example

curl
curl -X GET 'https://inventory.getmanifold.io/stocktakes/stk_01a16585-57c0-7200-961d-25255f868ed4/sheet?limit=100' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"
JavaScript (fetch)
const response = await fetch("https://inventory.getmanifold.io/stocktakes/stk_01a16585-57c0-7200-961d-25255f868ed4/sheet?limit=100", {
  method: "GET",
  headers: { Authorization: `Bearer ${process.env.MANIFOLD_TOKEN}` },
});
if (!response.ok) throw new Error(`${response.status}: ${await response.text()}`);
const answer = await response.json();
Response · 200 · application/json
{
  "stocktakeId": "stk_01a16585-57c0-7200-961d-25255f868ed4",
  "kind": "periodic",
  "status": "open",
  "lines": [
    {
      "sku": "WIDGET-BLUE",
      "name": "Widget, blue",
      "locationId": "loc_019cadd3-8330-7e12-aa44-2cd5f05da74a",
      "expected": 140,
      "counted": 137,
      "suggestedCostCents": 1250,
      "missingCost": false
    },
    {
      "sku": "WIDGET-GREEN",
      "name": "Widget, green",
      "locationId": "loc_019cadd3-8330-7e12-aa44-2cd5f05da74a",
      "expected": 0,
      "missingCost": false
    },
    {
      "sku": "WIDGET-RED",
      "name": "Widget, red",
      "locationId": "loc_019cadd3-8330-7e12-aa44-2cd5f05da74a",
      "expected": 0,
      "counted": 0,
      "suggestedCostCents": 1250,
      "missingCost": false
    },
    {
      "sku": "WIDGET-SERIAL",
      "name": "Widget controller, serialised",
      "locationId": "loc_019cadd3-8330-7e12-aa44-2cd5f05da74a",
      "expected": 7,
      "suggestedCostCents": 8900,
      "missingCost": false
    }
  ],
  "total": 4,
  "missingCosts": 0,
  "limit": 100,
  "offset": 0
}

The panel writes this call in other languages. It does not send it: Manifold's APIs do not take calls from a web page on another site, so run the call from your own code or terminal. The whole API as OpenAPI: inventory-manager.openapi.json. Base URL https://inventory.getmanifold.io.

Errors

Every refusal is a status and a JSON body whose _tag names it. A refused call changes nothing.

401

RefusalWhat it meansWhat to do
Unauthorized reason The token is missing, expired or not one Manifold issued.Get a fresh token and send the call again.
TokenAlreadyUsed tokenId A single-use app token was already spent.Mint a new token for this call.

402

RefusalWhat it meansWhat to do
SubscriptionRequired status The organization's subscription has lapsed, so writes are refused.An owner settles billing. Reads still work meanwhile.

403

RefusalWhat it meansWhat to do
TenantRequired userId The token names no organization.Choose the organization, then get a new token.
ScopeRequired required The token's roles do not grant the scope this call needs.Ask an owner or admin for a role that grants it.

404

RefusalWhat it meansWhat to do
StocktakeNotFound stocktakeId No such record in this organization.Check the id in the path or the body.

409

RefusalWhat it meansWhat to do
MirroredFromSource source This area is fed by your source system until the organization goes live.Make the change in the source system, or go live first.

503

RefusalWhat it meansWhat to do
RequestLogUnavailable tokenId, reason The service could not record the request, so it did nothing.Try again shortly.

How refusals work everywhere: Errors.

Used in