GET /api/v1/public/vendors/vnd_abc123/catalog/items?status=ACTIVE&include=tags&limit=20
x-api-key: boh_live_xxxxxxxx
{
"items": [
{
"id": "itm_01j5k...",
"account_id": "acc_01j...",
"external_item_id": "SKU-001",
"code": "FLOUR-KG",
"name": "All-purpose flour",
"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": "WEEKLY",
"created_at": "2026-01-10T09:00:00.000Z",
"updated_at": "2026-07-01T12:00:00.000Z",
"tags": [
{ "id": "tag_dry_01...", "code": "DRY-GOODS", "name": "Dry goods" }
]
}
],
"total": 1,
"limit": 20,
"offset": 0
}
Catalog Items
List items
Returns inventory items for a vendor with optional filters. Supports offset and cursor pagination.
GET
/
api
/
v1
/
public
/
vendors
/
{vendorId}
/
catalog
/
items
GET /api/v1/public/vendors/vnd_abc123/catalog/items?status=ACTIVE&include=tags&limit=20
x-api-key: boh_live_xxxxxxxx
{
"items": [
{
"id": "itm_01j5k...",
"account_id": "acc_01j...",
"external_item_id": "SKU-001",
"code": "FLOUR-KG",
"name": "All-purpose flour",
"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": "WEEKLY",
"created_at": "2026-01-10T09:00:00.000Z",
"updated_at": "2026-07-01T12:00:00.000Z",
"tags": [
{ "id": "tag_dry_01...", "code": "DRY-GOODS", "name": "Dry goods" }
]
}
],
"total": 1,
"limit": 20,
"offset": 0
}
string
required
BOH API key with
catalog:read scope.string
required
Vendor UUID.
string
Partial match on item name or code (1–256 characters).
string
default:"ACTIVE"
Filter by status:
ACTIVE, ARCHIVED, or ALL.string
PURCHASED, PRODUCED, or PURCHASED_AND_PRODUCED.string
DAILY, WEEKLY, or MONTHLY.string
UUID of an item tag — returns only items that belong to that tag.
string
UUID of a BOH store — filters items visible to that store.
string
Comma-separated sideloads:
tags, unit_group, memberships.integer
default:"50"
Page size (1–200).
integer
default:"0"
Offset for page-based pagination. Mutually exclusive with
cursor.string
Opaque cursor for cursor-based pagination. Mutually exclusive with
offset.object[]
Array of item summaries.
integer
Total matching items. Present only in offset mode.
integer
Page size applied.
integer
Offset applied. Present only in offset mode.
string | null
Cursor for the next page. Present only in cursor mode;
null when no more pages.boolean
true when more pages are available. Present only in cursor mode.GET /api/v1/public/vendors/vnd_abc123/catalog/items?status=ACTIVE&include=tags&limit=20
x-api-key: boh_live_xxxxxxxx
{
"items": [
{
"id": "itm_01j5k...",
"account_id": "acc_01j...",
"external_item_id": "SKU-001",
"code": "FLOUR-KG",
"name": "All-purpose flour",
"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": "WEEKLY",
"created_at": "2026-01-10T09:00:00.000Z",
"updated_at": "2026-07-01T12:00:00.000Z",
"tags": [
{ "id": "tag_dry_01...", "code": "DRY-GOODS", "name": "Dry goods" }
]
}
],
"total": 1,
"limit": 20,
"offset": 0
}