*REST API › Endpoint reference › Catalog & inventory › Items*

# Update an item

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

`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.

`PATCH /api/v1/items/{itemId}` — scope `items:write`

Scope: `items:write` · 120/min · Strict tenancy · Idempotency-Key · If-Match · MCP: `filmo_items_update`

## Authorizations

Bearer API key with the scope below. `items:write`

## Headers

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `Idempotency-Key` | string | No | Unique identifier of the request, chosen by the client (a UUID works). Between 1 and 255 characters: an empty header is rejected with 400 `validation_error`, because the client would believe itself protected. Repeating the same key with the SAME body within 24 h returns the stored response without executing again, with the `Idempotent-Replay: true` header. With a DIFFERENT body it returns 422. It is the safe way to retry after a network timeout. |
| `If-Match` | string | No | Optimistic locking: the `ETag` you read from the resource (or `*`). If the resource changed since, the write is rejected with `412 precondition_failed` before doing anything; read it again and retry. Without the header the write always proceeds. |

## Path parameters

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `itemId` | string | Yes | Item identifier. |

## Body

Body schema: `ItemUpdateBody`

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `name` | string | No | Item name. |
| `description` | string | No | Item description; null clears it. |
| `sku` | string | No | SKU reference. Unique within the account; null clears it. |
| `collectionId` | string | No | Collection it belongs to; null removes it from any collection. |
| `orderInfo` | string | No | Order information: preparation or delivery notes that do reach the customer; null clears it. |
| `synonyms` | string[] | No | Synonyms by which the item should be found in the search. Replaces the entire list. |
| `tags` | string[] | No | Tags, by identifier or by name; a name that does not exist creates the tag. Replaces the entire list. |

## Request examples

*Update an item*

**cURL**

```bash
curl https://app.filmo.io/api/v1/items/item_8f2a1c \
  --request PATCH \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header "Idempotency-Key: $(uuidgen 2>/dev/null || cat /proc/sys/kernel/random/uuid)" \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "Sony FX6 (cuerpo)",
  "description": "Cámara de cine digital full-frame, montura E.",
  "synonyms": [
    "FX6",
    "Sony cine full frame"
  ],
  "tags": [
    "Cámaras",
    "Cine"
  ]
}'
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/items/item_8f2a1c', {
  method: 'PATCH',
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY',
    'Idempotency-Key': crypto.randomUUID(),
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    name: 'Sony FX6 (cuerpo)',
    description: 'Cámara de cine digital full-frame, montura E.',
    synonyms: ['FX6', 'Sony cine full frame'],
    tags: ['Cámaras', 'Cine']
  })
})
```

**Python**

```python
import uuid
import requests

requests.patch(
    "https://app.filmo.io/api/v1/items/item_8f2a1c",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY",
      "Idempotency-Key": str(uuid.uuid4()),
      "Content-Type": "application/json"
    },
    json={
      "name": "Sony FX6 (cuerpo)",
      "description": "Cámara de cine digital full-frame, montura E.",
      "synonyms": [
        "FX6",
        "Sony cine full frame"
      ],
      "tags": [
        "Cámaras",
        "Cine"
      ]
    }
)
```

## Response

Response schema: `ItemDetailDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 409 | Conflict (conflict): the current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 412 | Precondition failed (precondition_failed): the `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 422 | Idempotency-Key reused (idempotency_key_reused): the same key was used before with a different body. Change the key. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object | The item in full, as returned by the API. |
| `data.id` | string | Unique identifier of the item. |
| `data.name` | string | Item name. |
| `data.sku` | string | SKU reference of the item; null if not recorded. |
| `data.description` | string | Item description; null if not recorded. |
| `data.orderInfo` | string | Additional information for the order (preparation/delivery notes); null if not recorded. |
| `data.ean` | string | EAN/barcode; null if not recorded. |
| `data.itemType` | string | Item type: fixed (simple item) or variant (item with variants). `fixed`, `variant` |
| `data.stockCalculationMethod` | string | Stock calculation method: bulk (in bulk, by quantity) or serialized (by serialized items). `bulk`, `serialized` |
| `data.collectionId` | string | Identifier of the collection it belongs to; null if it is in none. |
| `data.collectionName` | string | Name of the collection it belongs to; null if it is in none. |
| `data.images` | string[] | URLs of the item images. |
| `data.salePrice` | string | Sale price as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none. |
| `data.depositValue` | string | Deposit amount as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none. |
| `data.minStock` | number | Minimum stock configured for alerts; null if not configured. |
| `data.serializedItemsCount` | number | Number of serialized items registered for the item. |
| `data.pricingSettings` | object | Rental pricing configuration; null if not configured. |
| `data.pricingSettings.type` | string | Pricing mode: periodPrice (price per period), fixedPrice (fixed price) or pricingStructure (pricing structure); null if the item has none configured. `periodPrice`, `fixedPrice`, `pricingStructure` |
| `data.pricingSettings.price` | string | Base rental price as a decimal string "1234.50" (ROUND_HALF_UP); null if not applicable. |
| `data.pricingSettings.period` | string | Period unit of the price: hour, day, week or month; null if the item has none configured. `hour`, `day`, `week`, `month` |
| `data.insuranceEnabled` | boolean | Whether the item allows insurance. |
| `data.discountEnabled` | boolean | Whether the item allows discounts. |
| `data.bufferBefore` | number | Buffer time reserved before the rental; null if not applicable. |
| `data.bufferBeforeUnit` | string | Unit of the buffer before: hour or day; null if not applicable. `hour`, `day` |
| `data.bufferAfter` | number | Buffer time reserved after the rental; null if not applicable. |
| `data.bufferAfterUnit` | string | Unit of the buffer after: hour or day; null if not applicable. `hour`, `day` |
| `data.physicalProperties` | object | Physical properties (weight and dimensions); null if not recorded. |
| `data.physicalProperties.weight` | number | Item weight in kilograms; null if not recorded. |
| `data.physicalProperties.width` | number | Item width in centimeters; null if not recorded. |
| `data.physicalProperties.height` | number | Item height in centimeters; null if not recorded. |
| `data.physicalProperties.length` | number | Item length in centimeters; null if not recorded. |
| `data.physicalProperties.volume` | number | Item volume in cubic meters (m³); null if not recorded. |
| `data.physicalProperties.current` | number | Current draw in amperes; null if not recorded. |
| `data.physicalProperties.power` | number | Power in watts; null if not recorded. |
| `data.variants` | object[] | Item variants (empty if the item is of type fixed). |
| `data.variants.variantId` | string | Unique identifier of the variant. |
| `data.variants.variantName` | string | Variant name. |
| `data.variants.variantPrice` | string | Rental price of the variant as a decimal string "1234.50" (ROUND_HALF_UP). |
| `data.variants.salePrice` | string | Sale price of the variant as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none. |
| `data.variants.ean` | string | EAN/barcode of the variant; null if not recorded. |
| `data.tags` | object[] | Tags associated with the item. |
| `data.tags.id` | string | Unique identifier of the tag. |
| `data.tags.name` | string | Tag name. |
| `data.customFields` | object<string, any> | Custom field values by custom field identifier; the definitions are in `/api/v1/custom-fields`. |
| `data.createdAt` | string<date-time> | Creation date in ISO 8601 with offset. |
| `data.updatedAt` | string<date-time> | Last update date in ISO 8601 with offset. |
| `data.replacementValue` | string | Replacement value of the item as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded. |
| `data.accessoryIds` | string[] | Identifiers of the items configured as accessories of this one. |
| `data.alternativeIds` | string[] | Identifiers of the items configured as alternatives of this one. |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": {
    "id": "item_9f3a2b",
    "name": "Example item",
    "sku": "CAM-FX6-01",
    "description": "Example text.",
    "orderInfo": "Example order info",
    "ean": "0000000000000",
    "itemType": "fixed",
    "stockCalculationMethod": "bulk",
    "collectionId": "collection_9f3a2b",
    "collectionName": "Example collection name",
    "images": [
      "Example images"
    ],
    "salePrice": "120.00",
    "depositValue": "120.00",
    "minStock": 1,
    "serializedItemsCount": 1,
    "pricingSettings": {
      "type": "periodPrice",
      "price": "120.00",
      "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": "variant_9f3a2b",
        "variantName": "Example variant name",
        "variantPrice": "120.00",
        "salePrice": "120.00",
        "ean": "0000000000000"
      }
    ],
    "tags": [
      {
        "id": "tag_9f3a2b",
        "name": "Example tag"
      }
    ],
    "customFields": {
      "example": "example"
    },
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z",
    "replacementValue": "120.00",
    "accessoryIds": [
      "accessory_9f3a2b"
    ],
    "alternativeIds": [
      "alternative_9f3a2b"
    ]
  }
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |
| 409 | `conflict` | The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 412 | `precondition_failed` | The `If-Match` entity tag does not match the current representation. Read the resource again and retry. |
| 422 | `idempotency_key_reused` | The same key was used before with a different body. Change the key. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/items/update-an-item  
Last updated: 2026-10-25