Items
Update a serialized item
Changes the record of ONE serialized item: its status, where it is, its serial number or its warranty.
items:writeitems:write- 120/min
- Server annotation: Idempotent
Result
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.
Arguments
Serialized item identifier.
Limits: min length 1
Internal code of the unit. It identifies the unit, so it cannot be empty.
Limits: min length 1, max length 200
Manufacturer serial number; null clears it.
Limits: max length 200
Unit status.
Available options: available, prepared, picked_up, returned, broken, archived, sold
false removes the unit from the pool without deleting it.
Information visible on the order and on the delivery note.
Limits: max length 1000
Reference by which the supplier identifies the unit.
Limits: max length 200
Number of the purchase order that brought it in.
Limits: max length 200
Purchase date, in ISO 8601 with offset.
Warranty end, in ISO 8601 with offset.
Warehouse where the unit is located.
Location within the warehouse; null clears it.
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
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
Unique identifier of the physical unit.
Internal code of the unit.
Manufacturer serial number; null if not registered.
Current status of the unit within the inventory cycle.
Identifier of the catalog item this unit belongs to.
Name of the catalog item.
SKU of the item; null if it has none.
Name of the collection of the item; null if it is in none.
Creation date in ISO 8601 UTC; null if not recorded.
Last modification date in ISO 8601 UTC; null if not recorded.
An error is a result with isError: true and the problem in content[0].; there is no structuredContent. See Errors.
The same operation by REST
This tool runs PATCH /api/v1/serialized-items/{serializedItemId}.
Related pages
Link to this section: Related pagesItems
Update a serialized item
Changes the record of ONE serialized item: its status, where it is, its serial number or its warranty.
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: trueand the problem in the first text block. Branch on itscode.
Was this page helpful?