Skip to main content
GET
Get Stock Groups

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Query Parameters

page
integer | null
per_page
integer | null
sort_by
string | null

Optional sort field. inventory_value requires inventory:cost.

sort_direction
enum<string> | null
Available options:
asc,
desc
location_id
string | null
name
string | null

Optional name of the stock

ids
string[] | null

Optional IDs of the stock

item_id
string | null

Optional ID of the item

supplier_id
string | null

Optional ID of the supplier to filter by

category
string[] | null

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.

remaining_quantity
(number | null)[] | null

Optional remaining quantity of the stock

location_ids
string[] | null

Optional list of location IDs to filter shipments by

unit
enum<string> | null

Optional unit of measurement

Available options:
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
is_archived
boolean | null

Optional filter for archived status

group_by
enum<string> | null

Optional group by field

Available options:
category,
supplier
category_exact
boolean
default:false

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).

expiring_within_days
(integer | null)[] | null

Expiry range in days [lower_bound, upper_bound]

stock_level_status
enum<string>[] | null

Filter by stock level status relative to min_stock_level

Available options:
low,
critical,
out-of-stock

Response

Successful Response

key
string
required
label
string
required
total
integer
required
depth
integer
default:0
parentKey
string | null
isSynthetic
boolean
default:false