Items

Update an item

Updates the catalog metadata of an item (send only the fields to change).

Tool

filmo_items_update

Writeitems:write

items:write
120/min
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_items_update",
    "arguments": {
      "itemId": "item_8f2a1c"
    }
  }
}

{
  "structuredContent": {
    "data": {
      "id": "id_8f2a1c",
      "name": "Example",
      "sku": "<sku>",
      "description": "<description>",
      "orderInfo": "<orderInfo>",
      "ean": "<ean>",
      "itemType": "fixed",
      "stockCalculationMethod": "bulk",
      "collectionId": "coll_8f2a1c",
      "collectionName": "Example",
      "images": [
        "<images>"
      ],
      "salePrice": "1234.50",
      "depositValue": "1234.50",
      "minStock": 1,
      "serializedItemsCount": 1,
      "pricingSettings": {
        "type": "periodPrice",
        "price": "1234.50",
        "period": "hour"
      },
      "insuranceEnabled": true,
      "discountEnabled": true,
      "bufferBefore": 1,
      "bufferBeforeUnit": "hour",
      "bufferAfter": 1,
      "bufferAfterUnit": "hour",
      "physicalProperties": {
        "weight": 1,
        "width": 1,
        "height": 1,
        "length": 1,
        "volume": 1,
        "current": 1,
        "power": 1
      },
      "variants": [
        {
          "variantId": "vari_8f2a1c",
          "variantName": "Example",
          "variantPrice": "1234.50",
          "salePrice": "1234.50",
          "ean": "<ean>"
        }
      ],
      "tags": [
        {
          "id": "id_8f2a1c",
          "name": "Example"
        }
      ],
      "customFields": {
        "key": "<key>"
      },
      "createdAt": "2026-09-01T08:00:00Z",
      "updatedAt": "2026-09-01T08:00:00Z",
      "replacementValue": "1234.50",
      "accessoryIds": [
        "acce_8f2a1c"
      ],
      "alternativeIds": [
        "alte_8f2a1c"
      ]
    },
    "meta": {
      "idempotencyKey": "<the key you sent, or the one the server generated>",
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

synonyms and tags replace the whole list. The stock method and the item type can NOT be changed here: they are destructive once there is stock or variants, and are set on create. Returns the updated item in detail.

Arguments

itemIdstringRequired

Item identifier.

Limits: min length 1

namestring

Item name.

Limits: min length 1

descriptionstring | null

Item description; null clears it.

skustring | null

SKU reference. Unique within the account; null clears it.

Limits: min length 1

collectionIdstring | null

Collection it belongs to; null removes it from any collection.

Limits: min length 1

orderInfostring | null

Order information: preparation or delivery notes that do reach the customer; null clears it.

synonymsstring[]

Synonyms by which the item should be found in the search. Replaces the entire list.

tagsstring[]

Tags, by identifier or by name; a name that does not exist creates the tag. Replaces the entire list.

Limits: max 50 items, each min length 1, each max length 100

idempotencyKeystring

Idempotency key chosen by the client (a UUID is recommended). Repeating the same key with the same arguments within 24 h returns the stored response without executing again; with different arguments it responds 422. It is the safe way to retry after a network failure.

Limits: min length 1, max length 255

ifMatchstring

Optimistic locking: the meta.etag you got from the detail read of this resource (or "*"). If the resource changed since, the call fails with 412 precondition_failed before writing anything; read it again and retry. Omit it to write unconditionally.

Limits: min length 1

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data

idstring

Unique identifier of the item.

namestring

Item name.

skustring | null

SKU reference of the item; null if not recorded.

descriptionstring | null

Item description; null if not recorded.

orderInfostring | null

Additional information for the order (preparation/delivery notes); null if not recorded.

eanstring | null

EAN/barcode; null if not recorded.

itemTypestring

Item type: fixed (simple item) or variant (item with variants).

Available options: fixed, variant

stockCalculationMethodstring

Stock calculation method: bulk (in bulk, by quantity) or serialized (by serialized items).

Available options: bulk, serialized

collectionIdstring | null

Identifier of the collection it belongs to; null if it is in none.

collectionNamestring | null

Name of the collection it belongs to; null if it is in none.

imagesstring[]

URLs of the item images.

salePricestring | null

Sale price as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none.

Limits: pattern ^-?\d+\.\d{2}$

depositValuestring | null

Deposit amount as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none.

Limits: pattern ^-?\d+\.\d{2}$

minStocknumber | null

Minimum stock configured for alerts; null if not configured.

serializedItemsCountnumber

Number of serialized items registered for the item.

pricingSettingsobject | null

Rental pricing configuration; null if not configured.

Show child attributes

pricingSettings.typestring | null

Pricing mode: periodPrice (price per period), fixedPrice (fixed price) or pricingStructure (pricing structure); null if the item has none configured.

Available options: periodPrice, fixedPrice, pricingStructure

pricingSettings.pricestring | null

Base rental price as a decimal string "1234.50" (ROUND_HALF_UP); null if not applicable.

Limits: pattern ^-?\d+\.\d{2}$

pricingSettings.periodstring | null

Period unit of the price: hour, day, week or month; null if the item has none configured.

Available options: hour, day, week, month

insuranceEnabledboolean

Whether the item allows insurance.

discountEnabledboolean

Whether the item allows discounts.

bufferBeforenumber | null

Buffer time reserved before the rental; null if not applicable.

bufferBeforeUnitstring | null

Unit of the buffer before: hour or day; null if not applicable.

Available options: hour, day

bufferAfternumber | null

Buffer time reserved after the rental; null if not applicable.

bufferAfterUnitstring | null

Unit of the buffer after: hour or day; null if not applicable.

Available options: hour, day

physicalPropertiesobject | null

Physical properties (weight and dimensions); null if not recorded.

Show child attributes

physicalProperties.weightnumber | null

Item weight in kilograms; null if not recorded.

physicalProperties.widthnumber | null

Item width in centimeters; null if not recorded.

physicalProperties.heightnumber | null

Item height in centimeters; null if not recorded.

physicalProperties.lengthnumber | null

Item length in centimeters; null if not recorded.

physicalProperties.volumenumber | null

Item volume in cubic meters (m³); null if not recorded.

physicalProperties.currentnumber | null

Current draw in amperes; null if not recorded.

physicalProperties.powernumber | null

Power in watts; null if not recorded.

variantsobject[]

Item variants (empty if the item is of type fixed).

Show child attributes

variants.variantIdstring

Unique identifier of the variant.

variants.variantNamestring

Variant name.

variants.variantPricestring

Rental price of the variant as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

variants.salePricestring | null

Sale price of the variant as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none.

Limits: pattern ^-?\d+\.\d{2}$

variants.eanstring | null

EAN/barcode of the variant; null if not recorded.

tagsobject[]

Tags associated with the item.

Show child attributes

tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

customFieldsobject<string, any>

Custom field values by custom field identifier; the definitions are in /api/v1/custom-fields.

createdAtstring<date-time>

Creation date in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

replacementValuestring | null

Replacement value of the item as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded.

Limits: pattern ^-?\d+\.\d{2}$

accessoryIdsstring[]

Identifiers of the items configured as accessories of this one.

alternativeIdsstring[]

Identifiers of the items configured as alternatives of this one.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs PATCH /api/v1/items/{itemId}.

Items
Update an item
Updates the catalog metadata of an item (send only the fields to change).
Guides
Safe writes
An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.
Guides
Errors
A tool error is a result with isError: true and the problem in the first text block. Branch on its code.

Was this page helpful?

Result

Arguments

Result

The same operation by REST

Related pages

Update an item

Safe writes

Errors