Skip to main content
PUT
Update Stock

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Body

application/json
name
string
required

Name of the stock

unit
enum<string>
required

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,
TUBES,
UNITS,
VIALS,
TREATMENTS,
SESSIONS,
PULSES,
JOULES,
CENTIMETERS,
THREAD_COUNT,
INJECTIONS,
WRINKLE_UNITS,
POUNDS,
FEET,
INCHES
id
string

Unique identifier for the stock

description
string | null

Optional description of the stock

notes
string | null

Notes about the stock

category
string | null

Category name (references category.name)

isArchived
boolean
default:false

Whether the stock is archived

shipments
Shipment · object[] | null

Shipments in the stock

items
ItemStock · object[] | null

Items in the stock

locationSummaries
StockLocationSummary · object[] | null

Stock quantities grouped by location

note
string | null

Optional note for inventory log when updating stock

Response

Successful Response

name
string
required

Name of the stock

unit
enum<string>
required

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,
TUBES,
UNITS,
VIALS,
TREATMENTS,
SESSIONS,
PULSES,
JOULES,
CENTIMETERS,
THREAD_COUNT,
INJECTIONS,
WRINKLE_UNITS,
POUNDS,
FEET,
INCHES
id
string

Unique identifier for the stock

description
string | null

Optional description of the stock

notes
string | null

Notes about the stock

category
string | null

Category name (references category.name)

isArchived
boolean
default:false

Whether the stock is archived

shipments
Shipment · object[] | null

Shipments in the stock

items
ItemStock · object[] | null

Items in the stock

locationSummaries
StockLocationSummary · object[] | null

Stock quantities grouped by location

note
string | null

Optional note for inventory log when updating stock