JavaScript SDKModulesInventory
Results
Result shapes returned by Inventory SDK methods.
inventory.list()
Returns a page-like list response.
type Result = {
data: InventoryItemSummary[];
organizationId: string;
count: number;
};Example:
{
"data": [
{
"_id": "item_123",
"_creationTime": 1710000000000,
"organizationId": "org_123",
"name": "Camera Kit",
"sku": "CAM-001",
"status": "Active",
"quantity": 12,
"tags": ["production"]
}
],
"organizationId": "org_123",
"count": 1
}With selected fields:
const result = await karybase.inventory.list({
fields: ["_id", "name"] as const,
});
// result.data is Array<Pick<InventoryItemSummary, "_id" | "name">>inventory.get()
Returns one inventory item model.
const item = await karybase.inventory.get({
itemId: "item_123",
});With selected fields:
const item = await karybase.inventory.get({
itemId: "item_123",
fields: ["_id", "name", "customFields"] as const,
});
// item is Pick<InventoryItem, "_id" | "name" | "customFields">Missing items reject with KarybaseApiError status 404.