Replace classification assignments

{
  "entity_type": "ITEM",
  "entity_id": "itm_01j5k...",
  "assignments": [
    {
      "classification_category_id": "cat_familia_01...",
      "classification_ids": ["val_proteinas_01..."]
    },
    {
      "classification_category_id": "cat_temp_01...",
      "classification_ids": ["val_refrigerado_01...", "val_congelado_01..."]
    }
  ],
  "external_user_id": "user_setup_01"
}

{
  "items": [
    {
      "id": "asgn_01...",
      "account_id": "acc_01...",
      "vendor_id": "vnd_01...",
      "classification_category_id": "cat_familia_01...",
      "classification_id": "val_proteinas_01...",
      "entity_type": "ITEM",
      "entity_id": "itm_01j5k...",
      "metadata": {},
      "created_at": "2026-08-07T14:30:00.000Z",
      "updated_at": "2026-08-07T14:30:00.000Z"
    }
  ]
}

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

PUT

api

public

vendors

{vendorId}

catalog

classifications

assignments

{
  "entity_type": "ITEM",
  "entity_id": "itm_01j5k...",
  "assignments": [
    {
      "classification_category_id": "cat_familia_01...",
      "classification_ids": ["val_proteinas_01..."]
    },
    {
      "classification_category_id": "cat_temp_01...",
      "classification_ids": ["val_refrigerado_01...", "val_congelado_01..."]
    }
  ],
  "external_user_id": "user_setup_01"
}

{
  "items": [
    {
      "id": "asgn_01...",
      "account_id": "acc_01...",
      "vendor_id": "vnd_01...",
      "classification_category_id": "cat_familia_01...",
      "classification_id": "val_proteinas_01...",
      "entity_type": "ITEM",
      "entity_id": "itm_01j5k...",
      "metadata": {},
      "created_at": "2026-08-07T14:30:00.000Z",
      "updated_at": "2026-08-07T14:30: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 or STORE.

string

required

UUID of the item or store being classified.

object[]

required

One entry per classification category:

Show assignment entry fields

string

required

UUID of the classification category.

string[]

required

UUIDs of the values to assign within this category. Pass [] to clear the category.

string

Actor for audit trail.

object[]

The complete list of assignments now in effect for the entity. Each entry: id, classification_category_id, classification_id, entity_type, entity_id.

This endpoint replaces all existing assignments for the entity. If you only want to update one category, you must include all other categories you want to keep.

{
  "entity_type": "ITEM",
  "entity_id": "itm_01j5k...",
  "assignments": [
    {
      "classification_category_id": "cat_familia_01...",
      "classification_ids": ["val_proteinas_01..."]
    },
    {
      "classification_category_id": "cat_temp_01...",
      "classification_ids": ["val_refrigerado_01...", "val_congelado_01..."]
    }
  ],
  "external_user_id": "user_setup_01"
}

{
  "items": [
    {
      "id": "asgn_01...",
      "account_id": "acc_01...",
      "vendor_id": "vnd_01...",
      "classification_category_id": "cat_familia_01...",
      "classification_id": "val_proteinas_01...",
      "entity_type": "ITEM",
      "entity_id": "itm_01j5k...",
      "metadata": {},
      "created_at": "2026-08-07T14:30:00.000Z",
      "updated_at": "2026-08-07T14:30: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

Replace classification assignments