Inventory Manager API · items

A page of the SKU master

GET /items

A page of the SKU master, SKU-ascending, each row carrying the item and its derived levels (the same shape GET /items/:sku/stock returns) — followed by the kits: composite variants, which hold no stock of their own, appear after the stocked rows as CompositeItemSummary with their divisible availability and recipe, so the grid is the whole sellable master.

kind=composite narrows to them (and kind=stock,service excludes them). The stocked half is paged and counted by the store; the kits fill the tail of the last stocked page, and total counts both. (Also returns, so a grid never has to re-derive available — which it could not do honestly anyway without knowing which locations are fulfillable). q matches SKU (separators ignored, typos forgiven), name or barcode, best first; tracking narrows to one identity mode, kind to stock or service items, sellable to those that may (or may not) be sold, catalogId to the SKUs a channel catalog's products list (an admin viewing the master as that channel; an unknown catalog is a 404, and an archived one lists nothing — it has been withdrawn, and it resolves empty for every reader), locationId to the SKUs held at any of those locations, comma-separated (on the shelf, damaged or awaiting identification there, in transit to it, or expected there from an open purchase order — the master as one site sees it; kits hold no stock anywhere, so a location scope lists stocked rows only), sort/order reorder the page (sku, name, tracking, kind, createdAt, updatedAt; asc or desc — the derived stock figures are computed after the page is cut, so they cannot order it), and total is the count matching the query with limit/offset ignored — what a pager needs. Omitting limit returns every match in one page, which is how the CSV exporter reads the catalogue.

Access

Requires stock:read or products:read or receiving:read or purchasing:read or allocations:read.

Any one of these scopes is enough.

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

AI agent tool

Agents call this as inventory_list_items (Inventory: List items), in the stock toolset. It only reads.

Connecting an agent: AI agents.

Example

curl
curl -X GET 'https://inventory.getmanifold.io/items?q=widget&catalogId=cat_019cadd3-8524-7934-9ee3-29b896f71f80&kind=stock%2Ccomposite&sort=sku&order=asc&limit=50' \
  -H "Authorization: Bearer $MANIFOLD_TOKEN"
JavaScript (fetch)
const response = await fetch("https://inventory.getmanifold.io/items?q=widget&catalogId=cat_019cadd3-8524-7934-9ee3-29b896f71f80&kind=stock%2Ccomposite&sort=sku&order=asc&limit=50", {
  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
{
  "items": [
    {
      "item": {
        "id": "itm_019cd543-e6f8-7bec-b392-ec0ac6b812ed",
        "sku": "WIDGET-BLUE",
        "name": "Widget, blue",
        "tracking": "none",
        "costingMethod": "fifo",
        "kind": "stock",
        "counted": true,
        "sellable": true,
        "barcodes": [
          {
            "value": "9300000000019",
            "type": "gtin"
          }
        ],
        "hsCodes": [
          {
            "country": "AU",
            "code": "39269000"
          }
        ],
        "countryOfOrigin": "AU",
        "weightGrams": 240,
        "packedSize": {
          "lengthMm": 120,
          "widthMm": 80,
          "heightMm": 60
        },
        "ownPackaging": false,
        "accounts": {
          "inventory": "1400",
          "revenue": "4000",
          "expense": "5000"
        },
        "taxClass": "standard",
        "stock": [
          {
            "locationId": "loc_019cadd3-8330-7e12-aa44-2cd5f05da74a",
            "onHand": 140,
            "reserved": 10,
            "damaged": 2,
            "awaitingIdentification": 0,
            "inTransit": 0,
            "incoming": 24
          },
          {
            "locationId": "loc_019cd06e-3b38-7e92-b496-c92f8184a3aa",
            "onHand": 18,
            "reserved": 0,
            "damaged": 0,
            "awaitingIdentification": 0,
            "inTransit": 6,
            "incoming": 0
          }
        ],
        "backordered": 0,
        "cost": {
          "costCents": 1250,
          "source": "receipt",
          "at": "2026-10-22T01:20:03.000Z"
        },
        "createdAt": "2026-03-10T01:02:03.000Z",
        "updatedAt": "2026-10-22T02:05:00.000Z"
      },
      "levels": {
        "sku": "WIDGET-BLUE",
        "onHand": 158,
        "reserved": 10,
        "available": 148,
        "damaged": 2,
        "awaitingIdentification": 0,
        "inTransit": 6,
        "incoming": 24,
        "backordered": 0,
        "projected": 178,
        "byLocation": [
          {
            "locationId": "loc_019cadd3-8330-7e12-aa44-2cd5f05da74a",
            "fulfillable": true,
            "onHand": 140,
            "reserved": 10,
            "available": 130,
            "damaged": 2,
            "awaitingIdentification": 0,
            "inTransit": 0,
            "incoming": 24
          },
          {
            "locationId": "loc_019cd06e-3b38-7e92-b496-c92f8184a3aa",
            "fulfillable": true,
            "onHand": 18,
            "reserved": 0,
            "available": 18,
            "damaged": 0,
            "awaitingIdentification": 0,
            "inTransit": 6,
            "incoming": 0
          }
        ],
        "asOf": "2026-10-22T05:30:01.000Z"
      }
    },
    {
      "item": {
        "id": "itm_019cd545-fa38-7989-b4f0-ed0cdbf68cff",
        "sku": "WIDGET-RED",
        "name": "Widget, red",
        "tracking": "none",
        "costingMethod": "fifo",
        "kind": "stock",
        "counted": true,
        "sellable": true,
        "barcodes": [
          {
            "value": "9300000000026",
            "type": "gtin"
          }
        ],
        "hsCodes": [
          {
            "country": "AU",
            "code": "39269000"
          }
        ],
        "countryOfOrigin": "AU",
        "weightGrams": 240,
        "packedSize": {
          "lengthMm": 120,
          "widthMm": 80,
          "heightMm": 60
        },
        "ownPackaging": false,
        "accounts": {
          "inventory": "1400",
          "revenue": "4000",
          "expense": "5000"
        },
        "taxClass": "standard",
        "stock": [
          {
            "locationId": "loc_019cadd3-8330-7e12-aa44-2cd5f05da74a",
            "onHand": 0,
            "reserved": 0,
            "damaged": 0,
            "awaitingIdentification": 0,
            "inTransit": 0,
            "incoming": 0
          }
        ],
        "backordered": 4,
        "cost": {
          "costCents": 1250,
          "source": "set",
          "at": "2026-03-14T06:00:00.000Z"
        },
        "createdAt": "2026-03-10T01:04:19.000Z",
        "updatedAt": "2026-10-19T03:55:12.000Z"
      },
      "levels": {
        "sku": "WIDGET-RED",
        "onHand": 0,
        "reserved": 0,
        "available": 0,
        "damaged": 0,
        "awaitingIdentification": 0,
        "inTransit": 0,
        "incoming": 0,
        "backordered": 4,
        "projected": -4,
        "byLocation": [
          {
            "locationId": "loc_019cadd3-8330-7e12-aa44-2cd5f05da74a",
            "fulfillable": true,
            "onHand": 0,
            "reserved": 0,
            "available": 0,
            "damaged": 0,
            "awaitingIdentification": 0,
            "inTransit": 0,
            "incoming": 0
          }
        ],
        "asOf": "2026-10-22T05:30:01.000Z"
      }
    },
    {
      "composite": {
        "sku": "WIDGET-PAIR",
        "name": "Widget twin pack",
        "productId": "prd_019d4cb8-c230-7235-aee3-dcb05170df0e",
        "productTitle": "Widget twin pack",
        "variantId": "var_019d4cb8-c618-7383-84f4-8228073621c6",
        "components": [
          {
            "sku": "WIDGET-BLUE",
            "quantity": 1
          },
          {
            "sku": "WIDGET-RED",
            "quantity": 1
          }
        ]
      },
      "availability": {
        "variantId": "var_019d4cb8-c618-7383-84f4-8228073621c6",
        "sku": "WIDGET-PAIR",
        "kind": "composite",
        "onHand": 0,
        "available": 0,
        "projected": -4,
        "components": [
          {
            "sku": "WIDGET-BLUE",
            "quantity": 1,
            "available": 148,
            "kits": 148
          },
          {
            "sku": "WIDGET-RED",
            "quantity": 1,
            "available": 0,
            "kits": 0
          }
        ],
        "limitedBy": [
          "WIDGET-RED"
        ]
      }
    }
  ],
  "total": 3,
  "limit": 50,
  "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
CatalogNotFound catalogId 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