provider
inventory
List Stocks
get/inventory/stocks/list
Query parameters
pageinteger nullable
per_pageinteger nullable
sort_bystring nullable
sort_direction'asc' | 'desc' nullable
location_idstring nullable
Optional ID of the location to filter shipments by
Optional ID of the location to filter shipments by
namestring nullable
Optional name of the stock
Optional name of the stock
idsstring[] nullable
Optional IDs of the stock
Optional IDs of the stock
item_idstring nullable
Optional ID of the item
Optional ID of the item
categorystring nullable
Optional category name to filter by (references category.name)
Optional category name to filter by (references category.name)
remaining_quantitynumber[] nullable
Optional remaining quantity of the stock
Optional remaining quantity of the stock
unit'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' | 'TUBES' | 'UNITS' | 'VIALS' | 'TREATMENTS' | 'SESSIONS' | 'PULSES' | 'JOULES' | 'CENTIMETERS' | 'THREAD_COUNT' | 'INJECTIONS' | 'WRINKLE_UNITS' | 'POUNDS' | 'FEET' | 'INCHES'
Optional unit of measurement
is_archivedboolean nullable
Optional filter for archived status
Optional filter for archived status
Headers
TENANTstring required
The tenant you are making this request on behalf of
API-KEYstring required
Your api key
Response
Successful Response
Changes
No recorded changes to this endpoint across all 1 revision of this API.