Items

Update a serialized item

Changes the record of ONE serialized item: its status, where it is, its serial number or its warranty.

PATCH

/api/v1/serialized-items/{serializedItemId}

curl https://app.filmo.io/api/v1/serialized-items/seri_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 '{
  "status": "available",
  "active": true,
  "spaceId": "spc_almacen_central",
  "locationId": "loc_estante_b3",
  "orderInfo": "Revisada tras la reparación de septiembre"
}'

Node.jsfetch('https://app.filmo.io/api/v1/serialized-items/seri_8f2a1c', { method: 'PATCH', headers: { Authorization: 'Bearer YOUR_FILMO_API_KEY', 'Idempotency-Key': crypto.randomUUID(), 'Content-Type': 'application/json' }, body: JSON.stringify({ status: 'available', active: true, spaceId: 'spc_almacen_central', locationId: 'loc_estante_b3', orderInfo: 'Revisada tras la reparación de septiembre' }) })Pythonimport uuid import requests requests.patch( "https://app.filmo.io/api/v1/serialized-items/seri_8f2a1c", headers={ "Authorization": "Bearer YOUR_FILMO_API_KEY", "Idempotency-Key": str(uuid.uuid4()), "Content-Type": "application/json" }, json={ "status": "available", "active": True, "spaceId": "spc_almacen_central", "locationId": "loc_estante_b3", "orderInfo": "Revisada tras la reparación de septiembre" } )

{
  "data": {
    "id": "serialized_item_9f3a2b",
    "code": "Example code",
    "serialNumber": "2026-0001",
    "status": "Example status",
    "itemId": "item_9f3a2b",
    "itemName": "Example item name",
    "itemSku": "Example item sku",
    "itemCollectionName": "Example item collection name",
    "createdAt": "2026-09-01T08:00:00.000Z",
    "updatedAt": "2026-09-01T08:00:00.000Z"
  }
}

{
  "type": "https://docs.filmo.io/errors/validation_error",
  "title": "Validation error",
  "status": 400,
  "code": "validation_error",
  "detail": "2 validation errors",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "name",
      "code": "too_small",
      "message": "Must be at least 1 characters long"
    },
    {
      "path": "contactType",
      "code": "invalid_value",
      "message": "Value not allowed; expected company, person"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/unauthorized",
  "title": "Unauthorized",
  "status": 401,
  "code": "unauthorized",
  "detail": "Missing Authorization header: Bearer <api key>",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/insufficient_scope",
  "title": "Insufficient scope",
  "status": 403,
  "code": "insufficient_scope",
  "detail": "The API key does not have the required scope (orders:write)",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "requiredScope": "items:write"
}

{
  "type": "https://docs.filmo.io/errors/not_found",
  "title": "Not found",
  "status": 404,
  "code": "not_found",
  "detail": "Resource not found",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/conflict",
  "title": "Conflict",
  "status": 409,
  "code": "conflict",
  "detail": "The current state of the resource does not allow the operation",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "errors": [
    {
      "path": "",
      "code": "invalid_state",
      "message": "The current state of the resource does not allow the operation"
    }
  ]
}

{
  "type": "https://docs.filmo.io/errors/precondition_failed",
  "title": "Precondition failed",
  "status": 412,
  "code": "precondition_failed",
  "detail": "The resource changed since you read it: read it again and retry",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/idempotency_key_reused",
  "title": "Idempotency-Key reused",
  "status": 422,
  "code": "idempotency_key_reused",
  "detail": "The Idempotency-Key header was already used with a different body",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

{
  "type": "https://docs.filmo.io/errors/rate_limited",
  "title": "Rate limit exceeded",
  "status": 429,
  "code": "rate_limited",
  "detail": "Rate limit exceeded: retry in 30 seconds",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c",
  "retryAfter": 30
}

{
  "type": "https://docs.filmo.io/errors/internal_error",
  "title": "Internal error",
  "status": 500,
  "code": "internal_error",
  "detail": "Internal error",
  "requestId": "req_0b9f6c1d2e3a4f5a8b7c6d5e4f3a2b1c"
}

Generated from the schema

It is what a warehouse system needs to say "this one is back and operational". What the unit cost, the internal note and the subrent terms neither go in nor come out through this API. The item it belongs to is resolved by the server. Returns the full serialized item, the same projection as its GET.

Authorizations

Bearer API key with the scope below. items:write

Headers

Idempotency-Keystring

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.

Limits: min length 1, max length 255

Example:"9f1c2f4e-3a5b-4f6d-8e7a-0b1c2d3e4f5a"

If-Matchstring

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.

Example:"\"3sT3d9pBvZq4h2N0w8x1YkLmQ7c\""

Path parameters

serializedItemIdstringRequired

Serialized item identifier.

Limits: min length 1

Body

application/json

Body schema: SerializedItemUpdateBody

codestring

Internal code of the unit. It identifies the unit, so it cannot be empty.

Limits: min length 1, max length 200

serialNumberstring | null

Manufacturer serial number; null clears it.

Limits: max length 200

statusstring

Unit status.

Available options: available, prepared, picked_up, returned, broken, archived, sold

activeboolean

false removes the unit from the pool without deleting it.

orderInfostring

Information visible on the order and on the delivery note.

Limits: max length 1000

providerReferencestring

Reference by which the supplier identifies the unit.

Limits: max length 200

poNumberstring

Number of the purchase order that brought it in.

Limits: max length 200

purchaseDatestring<date-time>

Purchase date, in ISO 8601 with offset.

warrantyExpirationstring<date-time>

Warranty end, in ISO 8601 with offset.

spaceIdstring

Warehouse where the unit is located.

locationIdstring | null

Location within the warehouse; null clears it.

Response

application/json

Successful response.

Response schema: SerializedItemDetailDto

Envelope: SerializedItemDetailResponse. meta.warnings is present only when the operation is deprecated.

Headers: X-Request-Id · RateLimit-Limit · RateLimit-Remaining · RateLimit-Reset · ETag · Idempotent-Replay

dataobject

The serialized item in full, as returned by the API.

Show child attributes

data.idstring

Unique identifier of the physical unit.

data.codestring

Internal code of the unit.

data.serialNumberstring | null

Manufacturer serial number; null if not registered.

data.statusstring

Current status of the unit within the inventory cycle.

data.itemIdstring

Identifier of the catalog item this unit belongs to.

data.itemNamestring

Name of the catalog item.

data.itemSkustring | null

SKU of the item; null if it has none.

data.itemCollectionNamestring | null

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

data.createdAtstring<date-time> | null

Creation date in ISO 8601 UTC; null if not recorded.

data.updatedAtstring<date-time> | null

Last modification date in ISO 8601 UTC; null if not recorded.

metaobject

Additional information about the response.

Show child attributes

meta.warningsobject[]

Lifecycle warnings; present only when the operation is deprecated.

Show child attributes

meta.warnings.codestring

Stable warning code.

Available options: deprecated

meta.warnings.messagestring

For people: what is deprecated, until when, and what to use.

meta.warnings.sunsetstring

Day (YYYY-MM-DD) the operation stops being served.

meta.warnings.replacementstring | null

operationId of the operation to use instead, or null if there is none.

meta.warnings.linkstring

Where the deprecation is documented (the changelog).

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.

401, 403, 429, 500 can be returned by any operation. Errors

Deprecation

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

Catalog & inventory
Serialized item
Specific physical unit of an item, with its serial number and where it is.

Was this page helpful?

Request examples

Authorizations

Headers

Path parameters

Body

Response

Errors

Deprecation

Related

Related pages

Serialized item