Update item

{
  "name": "All-purpose flour (premium)",
  "count_frequency": "DAILY",
  "external_user_id": "user_jane_42"
}

{
  "id": "itm_01j5k...",
  "account_id": "acc_01j...",
  "external_item_id": "SKU-001",
  "code": "FLOUR-KG",
  "name": "All-purpose flour (premium)",
  "type": "INGREDIENT",
  "procurement_type": "PURCHASED",
  "unit_group_id": "ug_mass_01...",
  "base_unit_id": "unit_g_01...",
  "is_inventory_tracked": true,
  "is_active": true,
  "count_frequency": "DAILY",
  "metadata": {},
  "created_at": "2026-01-10T09:00:00.000Z",
  "updated_at": "2026-08-07T15:00:00.000Z"
}

{
  "error": {
    "kind": "item_not_found",
    "message": "Item not found"
  }
}

PATCH

api

public

vendors

{vendorId}

catalog

items

{itemId}

{
  "name": "All-purpose flour (premium)",
  "count_frequency": "DAILY",
  "external_user_id": "user_jane_42"
}

{
  "id": "itm_01j5k...",
  "account_id": "acc_01j...",
  "external_item_id": "SKU-001",
  "code": "FLOUR-KG",
  "name": "All-purpose flour (premium)",
  "type": "INGREDIENT",
  "procurement_type": "PURCHASED",
  "unit_group_id": "ug_mass_01...",
  "base_unit_id": "unit_g_01...",
  "is_inventory_tracked": true,
  "is_active": true,
  "count_frequency": "DAILY",
  "metadata": {},
  "created_at": "2026-01-10T09:00:00.000Z",
  "updated_at": "2026-08-07T15:00:00.000Z"
}

{
  "error": {
    "kind": "item_not_found",
    "message": "Item not found"
  }
}

string

required

BOH API key with catalog:write scope.

string

required

Vendor UUID.

string

required

Item UUID.

string

New display name.

string

New item type (INGREDIENT, PACKAGING, SUPPLY, PREPARED_ITEM, FINISHED_GOOD).

string

New procurement type (PURCHASED, PRODUCED, PURCHASED_AND_PRODUCED).

boolean

Toggle stock tracking.

string | null

New count cycle (DAILY, WEEKLY, MONTHLY, or null).

object

Replaces the existing metadata object entirely.

string

Actor for audit trail.

{
  "name": "All-purpose flour (premium)",
  "count_frequency": "DAILY",
  "external_user_id": "user_jane_42"
}

{
  "id": "itm_01j5k...",
  "account_id": "acc_01j...",
  "external_item_id": "SKU-001",
  "code": "FLOUR-KG",
  "name": "All-purpose flour (premium)",
  "type": "INGREDIENT",
  "procurement_type": "PURCHASED",
  "unit_group_id": "ug_mass_01...",
  "base_unit_id": "unit_g_01...",
  "is_inventory_tracked": true,
  "is_active": true,
  "count_frequency": "DAILY",
  "metadata": {},
  "created_at": "2026-01-10T09:00:00.000Z",
  "updated_at": "2026-08-07T15:00:00.000Z"
}

{
  "error": {
    "kind": "item_not_found",
    "message": "Item not found"
  }
}

Overview

Identity

Stores

Suppliers

Catalog Items

Catalog Sync

Recipes

Goods Receipts

Stock Counts

Waste Events

Transfers

Production Batches

Tracking

Par Levels

Suggested Order

Purchase Orders

PO Lines

Webhooks