items

Update /items/{uuid}

Update an item by UUID (PATCH). Only sent fields are updated. Returns record with the detail projection.

PATCH

/items/{uuid}

curl --request PATCH \
  --url https://default.hannacrm.app/api/v4/items/{uuid} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": "<string>",
  "barcode": "<string>",
  "bruto": "<string>",
  "buy_rate": "<string>",
  "category": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "code": "<string>",
  "custom_fields": [
    {
      "slug": "<string>",
      "value": "<any>"
    }
  ],
  "delivery_term": "<string>",
  "description": "<string>",
  "description_de": "<string>",
  "description_en": "<string>",
  "ean_code": "<string>",
  "is_archived": "<string>",
  "is_product": "<string>",
  "is_serial_required": "<string>",
  "is_service": "<string>",
  "is_visible_portal": "<string>",
  "item_weight": "<string>",
  "long_description": "<string>",
  "long_description_de": "<string>",
  "long_description_en": "<string>",
  "manufacturer": "<string>",
  "min_sell_price": "<string>",
  "neto": "<string>",
  "organization": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "rate": "<string>",
  "supplier": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "supplier_code": "<string>",
  "tax": "<string>",
  "unit": "<string>",
  "unit_en": "<string>",
  "units_per_package": "<string>",
  "unlimited_balance": "<string>",
  "volume": "<string>"
}
'

{
  "record": {
    "active": "<string>",
    "balance": "<string>",
    "balance_by_warehouse": [
      {}
    ],
    "barcode": "<string>",
    "bruto": "<string>",
    "buy_rate": "<string>",
    "category": {
      "name": "<string>",
      "uuid": "<string>"
    },
    "code": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "created_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "custom_fields": [
      {
        "slug": "<string>",
        "value": "<any>"
      }
    ],
    "delivery_term": "<string>",
    "description": "<string>",
    "description_de": "<string>",
    "description_en": "<string>",
    "ean_code": "<string>",
    "guid": "<string>",
    "integration_code": "<string>",
    "is_archived": "<string>",
    "is_product": "<string>",
    "is_serial_required": "<string>",
    "is_service": "<string>",
    "is_visible_portal": "<string>",
    "item_weight": "<string>",
    "long_description": "<string>",
    "long_description_de": "<string>",
    "long_description_en": "<string>",
    "manufacturer": [
      {}
    ],
    "min_sell_price": "<string>",
    "neto": "<string>",
    "organization": {
      "name": "<string>",
      "uuid": "<string>"
    },
    "rate": "<string>",
    "serial_numbers": "<string>",
    "supplier": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "supplier_code": "<string>",
    "tax": {
      "rate": "<string>"
    },
    "unit": [
      {}
    ],
    "unit_en": "<string>",
    "units_per_package": "<string>",
    "unlimited_balance": "<string>",
    "updated_at": "2023-11-07T05:31:56Z",
    "updated_by": {
      "name": "<string>",
      "uuid": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    },
    "uuid": "<string>",
    "volume": "<string>"
  }
}

Authorizations

Authorizationstringheaderrequired

API key (Bearer token) created in Setup → API & MCP.

Body

activestring

Whether the item is active.

barcodestring

Barcode.

brutostring

Gross weight.

buy_ratestring

Buy / prime cost price.

categorystring

Item category UUID.

codestring

Unique item code / SKU.

custom_fieldsobject[]

Custom field values by slug.

Show child attributes

delivery_termstring

Delivery term.

descriptionstring

Item title / short description.

description_destring

Short description (German).

description_enstring

Short description (English).

ean_codestring

EAN code.

is_archivedstring

Whether the item is archived.

is_productstring

Whether the item is a product.

is_serial_requiredstring

Whether serial numbers are required.

is_servicestring

Whether the item is a service.

is_visible_portalstring

Whether the item is visible in the client portal.

item_weightstring

Item weight.

long_descriptionstring

Extended description (HTML allowed).

long_description_destring

Extended description (German).

long_description_enstring

Extended description (English).

manufacturerstring

Manufacturer name (picklist value text).

min_sell_pricestring

Minimum sell price.

netostring

Net weight.

organizationstring

Organization UUID.

ratestring

Sell price (excl. VAT).

supplierstring

Primary supplier client UUID.

supplier_codestring

Supplier item code.

taxstring

VAT rate percent (e.g. 21), or an object with rate (matches read response) or id (tax UUID, or the legacy numeric tenant tax row id).

unitstring

Unit of measure (e.g. vnt, h).

unit_enstring

Unit of measure (English).

units_per_packagestring

Number of units per package.

unlimited_balancestring

Whether stock is unlimited.

volumestring

Volume.

Fields enabled for this documentation instance (projection enabled: feature, option, subdomain, closures) plus account-level form field visibility. Role- and user-level field overrides are not applied here, so an API key whose staff user has such overrides may receive fewer fields. A disabled field is omitted from the response object entirely; a present key with a null value means the record simply has no value.

Show child attributes

Still need help? Ask the team

Update /items/{uuid}

Authorizations

Path Parameters

Body

Response