Open Inventory / Docs
EndpointsInventory structureInventory typesKey

Archive an inventory type

The API runs on your application instance. Schemas and field names come directly from the OpenAPI specification. Session-authenticated requests require a session on that instance.

DELETE
/inventory-types/{key}

Requires an authenticated administrator browser session. Existing inventory records retain their type; the fallback type cannot be archived.

Authorization

adminSession
cookieauthjs.session-token<token>

Authenticated Auth.js browser session cookie; each operation declares its required permission. Not restricted to administrators. HTTPS deployments use the secure-prefixed cookie variant.

Path Parameters

key*string

Stable key of an administrator-configurable inventory type.

Match^[a-z][a-z0-9_-]{0,63}$
Length1 <= length <= 64

Header Parameters

X-Organization-ID?string

Organization membership selected for this request. User-bound credentials may select any active membership; standalone tokens may only repeat their pinned organization ID.

Formatuuid

Response Body

Inventory type archived

application/json
  1. response
type*
Example Request
curl -X DELETE 'https://inventory.example.com/api/v1/inventory-types/string'
Example Response
{  "type": {    "key": "string",    "label": "string",    "description": "string",    "color": "string",    "icon": "string",    "canContain": true,    "spatialContainment": true,    "position": 0,    "isSystem": true,    "createdBy": "string",    "updatedBy": "string",    "createdAt": "2019-08-24T14:15:22Z",    "updatedAt": "2019-08-24T14:15:22Z",    "archivedAt": "2019-08-24T14:15:22Z"  }}