Guides
Inventory
How to query inventory items via the Vetigen API.
Inventory Guide
Access clinic-scoped inventory items. Inventory endpoints require the clinic.inventory.view permission.
List Inventory Items
Retrieve the current stock of inventory items.
curl "https://api.vetigen.com/api/v1/inventory?page=1&page_size=20" \
-H "X-API-Key: sk_live_YOUR_KEY"Query Parameters
| Parameter | Type | Description |
|---|---|---|
page | integer | Page number (default: 1) |
page_size | integer | Items per page |
search | string | Search by product name or barcode |
product_fp | string | Filter by product fingerprint |
supplier_fp | string | Filter by supplier fingerprint |
location_fp | string | Filter by inventory location |
low_stock_only | boolean | Show only low-stock items |
Response
{
"success": true,
"data": {
"items": [
{
"fp": "inventory_01JQMKXXXXX",
"product": {
"fp": "product_01JQMKXXXXX",
"name": "Amoxicillin 250mg",
"barcode": "8690123456789",
"unit": "tablet",
"category": "MEDICATION"
},
"quantity": 150,
"unit": "tablet",
"expiry_date": "2027-06-30",
"batch_number": "AMX-2024-001",
"low_stock_threshold": 20,
"is_low_stock": false
}
],
"total": 87,
"page": 1,
"page_size": 20,
"has_more": true
},
"message": "OK"
}