Skip to main content
GET
Get Item

Headers

TENANT
string
required

The tenant you are making this request on behalf of

API-KEY
string
required

Your api key

Path Parameters

item_id
string
required

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,
TROCHES,
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

sortOrder
integer | null

Optional sort order for the item

allowCustomPricing
boolean
default:false

Whether custom pricing is allowed for this item

showInCheckOut
boolean
default:true

Whether this item appears in checkout

type
enum<string>
default:PRODUCT

Type of item (PRODUCT, MEDICATION, etc.)

Available options:
ITEM,
SERVICE,
PRODUCT,
PACKAGE,
MEMBERSHIP,
MEDICATION,
SERVICE_FEE,
GIFT_CARD
externalId
string | null

Optional external ID for the item

exemptedTaxIds
string[] | null

List of tax IDs that this item is exempted from (excludes from scope-based taxes)

cost
integer | null

Cost of the item in cents

cashPrice
integer | null

Cash price of the item in cents (for dual pricing)

commissionable
boolean
default:true

Whether this item is eligible for commissions

tags
ItemTagSummary · object[]

Tags assigned to this item

hiddenInPatientPortal
boolean
default:false

Whether this item is hidden from the patient portal

hiddenInOnlineShop
boolean
default:true

Whether this item is hidden from the online shop

loyaltyPointsEarned
integer | null

Points earned when this item is purchased

Required range: x >= 0
defaultCptCode
string | null

Default CPT / HCPCS code for Super Bill autofill

defaultModifiers
string[] | null

Default procedure modifiers for Super Bill autofill

defaultIcd10Codes
string[] | null

Default ICD-10 codes for Super Bill autofill

defaultPlaceOfService
string | null

Default CMS Place of Service code for Super Bill autofill

stocks
ItemStockDetail · object[] | null

Optional linked stocks for the item