Items
Delete an item
Deletes the item from the catalog and everything hanging from it: its serialized units, its notes, its files and its tasks; it is also removed from the alternatives of other items and from order import templates.
items:writeitems:write- 120/min
- Server annotation: Destructive
- Server annotation: Idempotent
- Requires human confirmation
- Not reversible
Result
generated from the schema
Not reversible
This tool cannot be undone.
Requires human confirmation
Put this tool on your client's “ask before running” list. The annotations are hints that the server declares, not guarantees: do not decide the approval from destructiveHint alone. The server flags this tool with _meta["anthropic, which clients that honor it use to ask a person before every call.
It is NOT reversible. 409 when the item cannot be deleted: it has units reserved or not yet returned in orders, it is included in a kit, it has active subrents, or it is an accessory or sub-item of another item — detail says which. Responds 204 with no body: the item no longer exists for the API (its GET responds 404).
Arguments
Item identifier.
Limits: min length 1
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.
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 DELETE /api/v1/items/{itemId}.
Related pages
Link to this section: Related pagesItems
Delete an item
Deletes the item from the catalog and everything hanging from it: its serialized units, its notes, its files and its tasks; it is also removed from the alternatives of other items and from order import templates.
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?