provider

inventory

Create Item

post/inventory/items/create

Headers

TENANTstring required

The tenant you are making this request on behalf of

API-KEYstring required

Your api key

Request body

idstring

Unique identifier for the item

namestring required

Name of the item

brandNamestring nullable

Optional brand name of the item

descriptionstring nullable

Optional description of the item

priceinteger required

Price of the item in cents

categorystring nullable

Category name (references category.name)

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'

isPhysicalboolean

Whether the item is physical

isArchivedboolean

Whether the item is archived

internalNotesstring nullable

Optional internal notes for the item

taxableboolean

Whether the item is subject to taxes

sortOrderinteger nullable

Optional sort order for the item

allowCustomPricingboolean

Whether custom pricing is allowed for this item

type'ITEM' | 'PRODUCT' | 'MEDICATION' | 'SERVICE' | 'PACKAGE' | 'MEMBERSHIP'

Response

Successful Response

idstring

Unique identifier for the item

namestring required

Name of the item

brandNamestring nullable

Optional brand name of the item

descriptionstring nullable

Optional description of the item

priceinteger required

Price of the item in cents

categorystring nullable

Category name (references category.name)

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'

isPhysicalboolean

Whether the item is physical

isArchivedboolean

Whether the item is archived

internalNotesstring nullable

Optional internal notes for the item

taxableboolean

Whether the item is subject to taxes

sortOrderinteger nullable

Optional sort order for the item

allowCustomPricingboolean

Whether custom pricing is allowed for this item

type'ITEM' | 'PRODUCT' | 'MEDICATION' | 'SERVICE' | 'PACKAGE' | 'MEMBERSHIP'

usageCountinteger nullable required

Number of times this item has been used

Changes

No recorded changes to this endpoint across all 1 revision of this API.