List items

Operation ID: items

Group: Inventory › Items

Open in the interactive reference

GET /inventory/items

Read-only: Reads and returns; changes nothing.

Lists items. Each item comes back without standardCost, itemPurchasePrice, and currency. To read those, use GET inventory/items/:id or POST inventory/items/search.

The collection cannot filter on a missing weight or missing dimensions. For those, use POST inventory/items/search with missingWeight or missingDimensions.

Parameters

Query surface

• id — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• itemCode — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• externalItemId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• brandName — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• itemTypeId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• categoryId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• unitGroupId — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• valuationMethod — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• isBatch — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• isSerial — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• isInventory — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• isSalesItem — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• isPurchaseItem — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• active — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• countryOfOrigin — filter by eq, ne, gt, gte, lt, lte, in, notIn, between, like
• isPerishable — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• lastModifiedDate — filter by eq, ne, gt, gte, lt, lte, in, notIn, between
• Orderable: id, itemCode, valuationMethod, active, createdDate, lastModifiedDate
• Selectable: id, itemCode, itemName, externalItemId, brandName, notes, imageAvatar, itemTypeId, itemTypeName, categoryId, categoryName, inventoryUnitId, inventoryUnitCode, salesUnitId, salesUnitCode, purchaseUnitId, purchaseUnitCode, unitGroupId, unitGroupName, valuationMethod, isBatch, isSerial, isInventory, isSalesItem, isPurchaseItem, active, eccnNumber, htsCode, countryOfOrigin, minStockLevel, minimumTransactionQuantity, leadTime, weight, weightUnit, grossWeight, netWeight, length, width, height, volumePerUnit, volumeUnit, defaultAllocationMode, isPerishable, shelfLifeDays, minShelfLifeDaysOnReceipt, minShelfLifeDaysOnDispatch, bestBeforeOffsetDays, storageTempMin, storageTempMax, createdDate, lastModifiedDate
• page[size] — Page size
• page[cursor] — Opaque continuation cursor

Response

200 Success

Under data, an array of itemsRow:

{
  "data": [
    {
      "id": "517a93e4-cbb4-4571-9e3d-2343e56cfd84",
      "itemCode": "WIDGET-01",
      "itemName": "Standard widget",
      "externalItemId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "brandName": "<brandName>",
      "notes": "<notes>",
      "imageAvatar": "<imageAvatar>",
      "itemTypeId": "66aea173-07b8-4c4e-bc4a-5c35dedfdc16",
      "itemTypeName": "Stocked good",
      "categoryId": "6709e2bf-d6cf-4800-9ffa-d5a496ec4d0b",
      "categoryName": "Components",
      "inventoryUnitId": "77bd4c16-e1f0-426d-a98f-07b063df2d9c",
      "inventoryUnitCode": "EA",
      "salesUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "salesUnitCode": "<salesUnitCode>",
      "purchaseUnitId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "purchaseUnitCode": "<purchaseUnitCode>",
      "unitGroupId": "38b5454a-c3fe-452b-9754-61f9ead49e87",
      "unitGroupName": "Each",
      "valuationMethod": "movingAverage",
      "isBatch": false,
      "isSerial": false,
      "isInventory": true,
      "isSalesItem": true,
      "isPurchaseItem": true,
      "active": true,
      "eccnNumber": "<eccnNumber>",
      "htsCode": "<htsCode>",
      "countryOfOrigin": "<countryOfOrigin>",
      "minStockLevel": "19.99",
      "minimumTransactionQuantity": "19.99",
      "leadTime": "19.99",
      "weight": "1.4",
      "weightUnit": "Kg",
      "grossWeight": "19.99",
      "netWeight": "19.99",
      "length": "19.99",
      "width": "19.99",
      "height": "19.99",
      "volumePerUnit": "19.99",
      "volumeUnit": "<volumeUnit>",
      "defaultAllocationMode": "<defaultAllocationMode>",
      "isPerishable": true,
      "shelfLifeDays": 0,
      "minShelfLifeDaysOnReceipt": 0,
      "minShelfLifeDaysOnDispatch": 0,
      "bestBeforeOffsetDays": 0,
      "storageTempMin": "19.99",
      "storageTempMax": "19.99",
      "createdDate": "2026-01-15T09:30:00.000Z",
      "lastModifiedDate": "2026-08-18T09:14:22.517Z"
    }
  ],
  "pagination": {
    "hasMore": true,
    "nextCursor": "<nextCursor>"
  }
}

Statuses

• 400 — Invalid request or business failure
• 401 — The request carries no valid access token.
• 403 — Not authorized
• 404 — Not found
• 429 — Too many requests from this client address. The response has no body and no Retry-After header.
• 500 — Internal server error