JavaScript SDKModulesInventory
Options
Options accepted by Inventory SDK methods.
inventory.list(options?)
const result = await karybase.inventory.list({
status: "Active",
search: "camera",
limit: 25,
fields: ["_id", "name", "quantity"] as const,
});| Option | Type | Required | Notes |
|---|---|---|---|
status | InventoryItemStatus | No | Draft, Active, Inactive, or Discontinued. |
search | string | No | Matches name, description, SKU, or barcode. |
limit | number | No | Positive maximum number of records. |
fields | readonly InventoryItemSummaryField[] | No | Selects returned summary fields. |
inventory.get(options)
const item = await karybase.inventory.get({
itemId: "item_123",
fields: ["_id", "name", "status", "customFields"] as const,
});| Option | Type | Required | Notes |
|---|---|---|---|
itemId | string | Yes | Inventory item id. |
fields | readonly InventoryItemField[] | No | Selects returned detail fields. |
The API key provides the organization scope. organizationId is still accepted as an optional legacy override, but new integrations should omit it.
Selection Standard
Use as const on fields so TypeScript can infer the exact keys and narrow the response type.
const item = await karybase.inventory.get({
itemId: "item_123",
fields: ["_id", "name"] as const,
});
// item is Pick<InventoryItem, "_id" | "name">