Archive Inventory item

Set an existing item to archived and return only an ok acknowledgement. The item and ledger remain readable, disappear from active dashboard counts, and refuse subsequent movement creation.

Outcome

Set an existing item to archived and return only an ok acknowledgement. The item and ledger remain readable, disappear from active dashboard counts, and refuse subsequent movement creation.

Before you start

Verify the authenticated identity, exact environment and pinned approved organization context before preparing an action.
The published application permission is workspace:write. Discover a granted Inventory workspace and bind that exact resource. Supplied identifiers do not grant access.
Authorize the documented inventory, review, import, notification, metering, privacy or archival effects before CLI --confirm or MCP confirm:true.

Discover the target

topolo whoami --json
topolo actions get app_topolo_inventory.items.archive --detail --json
topolo resources topolo-inventory --json
topolo workspaces list topolo-inventory --json

Select the exact granted workspace id as INVENTORY_WORKSPACE_ID. Fixture ids authorize no live operation.
Discover item ids through items.list or the reviewed items.create response in this workspace.

Request

DELETE /api/items/{itemId}

Save action input as payload.json. Inspect the plan for the exact path, query and body. Set INVENTORY_WORKSPACE_ID from granted resource discovery.

Inspect and test this action in the signed action console, then perform the verification below.

Input fields

Field	Required	Type	Constraints
`itemId`	Required	string	Existing item id to archive in the granted workspace.; {"minLength":1}

View the complete input schema in the action console. The same schema is available through CLI and MCP action discovery.

Effects

Updates status archived and updatedAt without deleting the item or movement history. Repeated archival can update the timestamp again.
New movement creation refuses archived items. Existing stock deltas and historical movement entries remain.

Interpret the response

The response is only {ok:true}; it contains no itemId. Use the already authorized input.itemId for items.get verification.

Expect {ok:true}; do not read an itemId from the acknowledgement. Use input.itemId with items.get and confirm status archived.

The success schema was checked against captured handler responses. Delegated Auth profile and canonical widget context fields can vary; exact Inventory projections and all six raw SQL export stores are source-reviewed. Error examples retain their actual refusal shapes.

View the complete success schema in the action console. The worked examples below retain complete captured responses; action discovery supplies the exact schema.

Worked examples

Captured exported Worker responses use both real local SQLite D1 databases with all six committed migrations, synthetic Auth/workspace grants and simulated Notify/Nexus/archive transport. They prove local handler shapes and scoped behavior, not live authorization, notification delivery, metering acceptance or environment deployment. Large 100-row list/capped-dashboard captures are retained in local evidence; committed tests verify those limits while worked guides use smaller complete responses. Refused examples demonstrate boundaries and must not be executed as successful workflows.

Successful request

Actual exported Worker response with both local SQLite D1 databases and all committed migrations; synthetic Auth/grants and simulated Notify/Nexus/archive transport. No live delivery, billing or environment deployment proof. Captured scenario: items.archive.

Input · payload.json:

{
  "itemId": "invitem_1b7ebfd7-0d3d-4130-a550-2dc160b0e80a"
}

CLI:

topolo actions validate app_topolo_inventory.items.archive --data @payload.json --json
topolo actions plan app_topolo_inventory.items.archive --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_inventory.items.archive --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_inventory.items.archive",
    "input": {
      "itemId": "invitem_1b7ebfd7-0d3d-4130-a550-2dc160b0e80a"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "ok": true
}

HTTP 200. Expect {ok:true}; do not read an itemId from the acknowledgement. Use input.itemId with items.get and confirm status archived.

Another supported request

Input · payload.json:

{
  "itemId": "invitem_b29c4494-14e0-43dd-87e6-e33856f732af"
}

CLI:

topolo actions validate app_topolo_inventory.items.archive --data @payload.json --json
topolo actions plan app_topolo_inventory.items.archive --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_inventory.items.archive --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_inventory.items.archive",
    "input": {
      "itemId": "invitem_b29c4494-14e0-43dd-87e6-e33856f732af"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "ok": true
}

HTTP 200. Expect {ok:true}; do not read an itemId from the acknowledgement. Use input.itemId with items.get and confirm status archived.

Another supported request

Input · payload.json:

{
  "itemId": "invitem_cf12df06-7056-4441-bef4-95d5c15ef1ed"
}

CLI:

topolo actions validate app_topolo_inventory.items.archive --data @payload.json --json
topolo actions plan app_topolo_inventory.items.archive --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json
topolo actions call app_topolo_inventory.items.archive --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --confirm --json

MCP tool and arguments:

{
  "tool": "topolo_call_action",
  "arguments": {
    "actionId": "app_topolo_inventory.items.archive",
    "input": {
      "itemId": "invitem_cf12df06-7056-4441-bef4-95d5c15ef1ed"
    },
    "resourceType": "workspace",
    "resourceId": "<identifier returned by granted resource discovery>",
    "confirm": true
  }
}

Captured local response · HTTP 200:

{
  "ok": true
}

HTTP 200. Expect {ok:true}; do not read an itemId from the acknowledgement. Use input.itemId with items.get and confirm status archived.

Refused request · HTTP 404

Input · payload.json:

{
  "itemId": "invitem_missing"
}

CLI:

topolo actions validate app_topolo_inventory.items.archive --data @payload.json --json
topolo actions plan app_topolo_inventory.items.archive --resource-type workspace --resource-id "$INVENTORY_WORKSPACE_ID" --data @payload.json --json

Captured local response · HTTP 404:

{
  "error": "not_found"
}

HTTP 404. The handler refused this request. Resolve its exact cause before retrying; input validation can reject an invalid fixture before it reaches the handler.

Verify the result

Expect {ok:true}; do not read an itemId from the acknowledgement.
Use input.itemId with items.get and confirm status archived.

Errors and recovery

invalid_action_input (HTTP 400): Correct only the exact fields reported by the published schema validator. An invalid input can be refused before its handler.
action_permission_required (HTTP 403): Stop when the verified credential lacks the published action permission. Resource identifiers and organization ownership do not grant that permission.
organization_required (HTTP 403): Use the specifically authorized organization context; personal scope cannot act on organization-owned Inventory data.
workspace_required (HTTP 400): Discover an authorized Inventory workspace and pass its exact separate resource binding; bootstrap does not select a workspace.
workspaces_unavailable (HTTP 503): Retain the request id and report unavailable canonical workspace discovery; do not invent a default workspace.
not_found (HTTP 404): Discover the resource through the appropriate authorized list or creation response; a foreign or absent identifier is not accessible.

Auth, action-input validation and platform resource resolution can refuse a request before its handler. Retain the exact error, request id and context; requesting another context is not a legitimate way to bypass a refusal.

Recovery boundary

Use items.update with status active if authorized to reactivate the item. Record the prior fields first; reactivation does not remove historical movements.

Get Inventory item: Read one item in the granted workspace with descriptive fields, archive status and quantityOnHand computed from all its movements. Archived items remain readable; missing or foreign items return not_found.
Update Inventory item: Update an existing item and return its aggregate stock. Descriptive fields omitted from input are preserved, but omitting status sets active and therefore reactivates an archived item.

Evidence

Captured exported Worker responses use both real local SQLite D1 databases with all six committed migrations, synthetic Auth/workspace grants and simulated Notify/Nexus/archive transport. They prove local handler shapes and scoped behavior, not live authorization, notification delivery, metering acceptance or environment deployment. Large 100-row list/capped-dashboard captures are retained in local evidence; committed tests verify those limits while worked guides use smaller complete responses. Capture digests and test scenarios are retained in the source fixture records.

Archive Inventory item

Outcome

Before you start

Discover the target

Request

Input fields

Effects

Interpret the response

Worked examples

Successful request

Another supported request

Another supported request

Refused request · HTTP 404

Verify the result

Errors and recovery

Recovery boundary

Related actions

Evidence