Inventory
Track stock items with SKU lookup and stock counts
Inventory items are physical goods you sell or use on jobs — replacement parts, accessories, consumables. Each item has an SKU, optional GTIN, weight, and a stock count that you can let Servicebay track for you.
Endpoints
- GET
/organisations/{orgId}/inventory— List inventory items (paginated) - POST
/organisations/{orgId}/inventory— Create inventory item - GET
/organisations/{orgId}/inventory/{itemId}— Get inventory item - PUT
/organisations/{orgId}/inventory/{itemId}— Update inventory item - DELETE
/organisations/{orgId}/inventory/{itemId}— Delete inventory item
Required scopes: inventory:read / inventory:write / inventory:delete.
weightUnit is grams / kilograms / ounces / pounds (not g/kg).
warrantyPeriod is plural (days/weeks/months/years). categoryId
must exist as an inventory category or the write is 400.
Server-side SKU lookup
Pass ?sku=BAT-001 to the list endpoint to perform an exact-match SKU
query in Firestore. This is much faster than fetching everything and
filtering client-side, and it doesn't count against the 100-row page limit.
List filters
| Query param | Description |
|---|---|
limit | Page size (max 100, default 50) |
startAfter | Cursor — pass the previous response's nextCursor |
search | Partial match on itemName, description, or sku |
sku | Exact SKU match (server-side query) |
categoryId | Filter to a single category |
Machine-readable version: OpenAPI spec.