Stock

Not authenticated— sign in to auto-fill your API key in code examples

List items

GET/v1/stock/items
ParameterRequiredDescription
pageinteger
optionalPage number (1-based).
limitinteger
optionalNumber of items per page.
searchstring
optionalFree-text search across SKU, name, and barcode.
warehouseIdstring
optionalFilter by warehouse.
Response200
{
  "ok": true,
  "items": [
    {
      "id": "stk_01HQXYZ",
      "sku": "WIDGET-42",
      "name": "Widget Model 42",
      "barcode": "3760012345678",
      "quantity": 1250,
      "warehouseId": "wh_01HQXYZ",
      "warehouseName": "Paris CDG",
      "updatedAt": "2026-03-30T18:00:00Z"
    },
    {
      "id": "stk_01HQABC",
      "sku": "GADGET-17",
      "name": "Gadget Series 17",
      "barcode": "3760098765432",
      "quantity": 340,
      "warehouseId": "wh_01HQXYZ",
      "warehouseName": "Paris CDG",
      "updatedAt": "2026-03-29T12:30:00Z"
    }
  ],
  "total": 580,
  "page": 1,
  "limit": 20
}
Response401
{
  "ok": false,
  "error": "Authentication required",
  "code": "UNAUTHORIZED",
  "details": {}
}