ITEMOM API Documentation

Simple API documentation for the ITEMOM platform.

ITEMOM API

A REST API for the ITEMOM item organization platform.

Version: 1.0.0
OpenAPI: 3.0.3
Base URL: http://localhost:3000/api

API Endpoints

POST/auth/logout

Logout user

Logs out the current user by invalidating their session server-side.

GET/categories

List hierarchical categories

Retrieves all categories for the authenticated user, ordered by name.

POST/categories

Create new category

Creates a new category with optional parent relationship for hierarchical structure.

GET/items

List items with filters and search

Retrieves items for the authenticated user with optional filtering and search.

POST/items

Create new item

Creates a new item with optional custom attributes and dimensions.

GET/stock

List stock entries

Retrieves stock entries with optional filtering by item and expiry warnings.

POST/stock

Add stock batch

Creates a new stock batch for an item with optional expiry and cost information.

POST/stock/{id}/allocate

Allocate stock to a location

Allocate a specific quantity of stock to a location.

POST/stock-locations/{id}/move

Move stock between locations

Move stock allocation from one location to another.

POST/stock-locations/{id}/deduct

Deduct stock from allocation

Deduct stock from allocation and update total stock quantity.

GET/locations

List hierarchical locations

Retrieves locations for the authenticated user with optional filtering.

POST/locations

Create new location

Creates a new location with optional parent relationship for hierarchical structure.

GET/transactions

Get audit trail

Retrieves transaction history with optional filtering by entity type, action type, and date range.

View Raw OpenAPI Specification

Access the full OpenAPI specification at:

GET /api/docs