Catalog Items
Create item
Creates a new catalog item. Items are the physical supplies and ingredients tracked in BOH.
POST
string
required
BOH API key with
catalog:write scope.string
required
Vendor UUID.
string
required
Display name (1–256 characters).
string
required
Item type:
INGREDIENT, PACKAGING, SUPPLY, PREPARED_ITEM, or FINISHED_GOOD.string
required
How the item is obtained:
PURCHASED, PRODUCED, or PURCHASED_AND_PRODUCED.string
required
UUID of the unit group (e.g. mass, volume, count). Cannot be changed after creation.
string
required
UUID of the base unit within the group (e.g. grams within mass). Cannot be changed after creation.
string
Your system’s identifier for this item (1–128 characters). Used for sync reconciliation.
string
Short alphanumeric code (1–64 characters). Must be unique within the vendor.
boolean
default:"true"
Whether BOH tracks stock movements for this item.
string | null
Suggested physical count cycle:
DAILY, WEEKLY, MONTHLY, or null.object
Free-form key-value store for your system’s extra data.
string
ID of the user performing this action in your system (for audit).
string
BOH-assigned UUID.
string
Account UUID.
string
Your system’s identifier.
string
Short alphanumeric code.
string
Display name.
string
Item type.
string
Procurement type.
string
UUID of the unit group.
string
UUID of the base unit.
boolean
Whether stock movements are recorded.
boolean
false when archived.string | null
Suggested count cycle.
object
Free-form extra data.
string
ISO 8601 creation timestamp.
string
ISO 8601 last-update timestamp.