Open Inventory / Docs
EndpointsInventory structureInventory types

Create 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.

POST
/inventory-types

Requires an authenticated administrator browser session. Type keys are stable identifiers used by inventory records.

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.

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

Request Body

application/json
  1. body
key*string

Stable key of an administrator-configurable inventory type.

Match^[a-z][a-z0-9_-]{0,63}$
Length1 <= length <= 64
label*string
Length1 <= length <= 120
description?string
Lengthlength <= 5000
Default""
color?string
Length1 <= length <= 32
Default"#635bff"
icon?string
Length1 <= length <= 80
Default"box"
canContain?boolean

Records of this type can be used as parents and structured stock locations.

Defaultfalse
spatialContainment?boolean

Automatically derive containment from map polygons. Requires canContain.

Defaultfalse
position?integer
Range0 <= value <= 100000
Default0

Response Body

Inventory type created

application/json
  1. response
type*
Example Request
curl -X POST 'https://inventory.example.com/api/v1/inventory-types' \  -H 'Content-Type: application/json' \  -d '{  "key": "string",  "label": "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"  }}

List configured inventory types GET

Requires the read scope. Active definitions are returned in configured display order. Administrators may include archived definitions.

Archive an inventory type DELETE

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