Skip to main content
POST
Create Item

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 item

price
integer
required

Price of the item in cents

id
string

Unique identifier for the item

brandName
string | null

Optional brand name of the item

description
string | null

Optional description of the item

category
string | null

Category name (references category.name)

unit
enum<string> | null

Unit of measurement for the item

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
isPhysical
boolean
default:true

Whether the item is physical

isArchived
boolean
default:false

Whether the item is archived

internalNotes
string | null

Optional internal notes for the item

taxable
boolean
default:false

Whether the item is subject to taxes

sortOrder
integer | null

Optional sort order for the item

allowCustomPricing
boolean
default:false

Whether custom pricing is allowed for this item

type
enum<string>
default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:
ITEM,
PRODUCT,
MEDICATION,
SERVICE,
PACKAGE,
MEMBERSHIP
stocks
ItemStock · object[] | null

Optional linked stocks for the item

Response

Successful Response

name
string
required

Name of the item

price
integer
required

Price of the item in cents

usageCount
integer | null
required

Number of times this item has been used

id
string

Unique identifier for the item

brandName
string | null

Optional brand name of the item

description
string | null

Optional description of the item

category
string | null

Category name (references category.name)

unit
enum<string> | null

Unit of measurement for the item

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
isPhysical
boolean
default:true

Whether the item is physical

isArchived
boolean
default:false

Whether the item is archived

internalNotes
string | null

Optional internal notes for the item

taxable
boolean
default:false

Whether the item is subject to taxes

sortOrder
integer | null

Optional sort order for the item

allowCustomPricing
boolean
default:false

Whether custom pricing is allowed for this item

type
enum<string>
default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:
ITEM,
PRODUCT,
MEDICATION,
SERVICE,
PACKAGE,
MEMBERSHIP
stocks
ItemStockDetail · object[] | null

Optional linked stocks for the item