Get Stock Groups
List stock items grouped by the requested field, with cost-gated fields redacted per the caller’s permissions.
Headers
The tenant you are making this request on behalf of
Your api key
Query Parameters
Optional sort field. inventory_value requires inventory:cost.
asc, desc Optional name of the stock
Optional IDs of the stock
Optional ID of the item
Optional ID of the supplier to filter by
Optional category names to filter by (references category.name). Multiple values combine with OR. A single value (e.g. ?category=Foo) is accepted for backwards compatibility with the previous single-string filter.
Optional remaining quantity of the stock
Optional list of location IDs to filter shipments by
Optional unit of measurement
AMPOULES, APPLICATORS, BOTTLES, BOXES, CAPSULES, CUPS, DOSES, G_PER_ML, GRAMS, IU, IU_PER_ML, OUNCES, FLUID_OUNCES, KG, KITS, LITERS, MCG, MG, MG_PER_ML, ML, MMOL, MICROGRAM_PER_ML, PACKS, PAIRS, PATCHES, PERCENTAGE, PIECES, POUCHES, ROLLS, SACHETS, SHEETS, SPRAYS, STRIPS, SYRINGES, TABLETS, TABLETS_PER_DAY, TESTS, TROCHES, TUBES, UNITS, VIALS, TREATMENTS, SESSIONS, PULSES, JOULES, CENTIMETERS, THREAD_COUNT, INJECTIONS, WRINKLE_UNITS, POUNDS, FEET, INCHES Optional filter for archived status
Optional group by field
category, supplier When true, the category filter matches by exact name and skips the closure expansion. Used by the grouped-table per-group page query so a parent group doesn't pull in its descendants' stock (which would double-count rows).
Expiry range in days [lower_bound, upper_bound]
Filter by stock level status relative to min_stock_level
low, critical, out-of-stock 