Skip to main content

Inventory

Base path: /api/data/inventory

All inventory CRUD endpoints are registered but not yet implemented — handlers are empty stubs.

POST /api/data/inventory

Create a new inventory record.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.

Inventory Snapshot Schema Reference

FieldTypeRequiredDescription
tenantIdstringYesTenant identifier
productIdstringYesAssociated product ID
quantityAvailablenumberYesAvailable quantity (integer)
quantityReservednumberYesReserved quantity (integer)
updatedAtdateYesLast update timestamp

Inventory Transaction Schema Reference

FieldTypeRequiredDescription
tenantIdstringYesTenant identifier
productIdstringYesAssociated product ID
orderIdstringNoAssociated order ID
typeenumYesADJUSTMENT, RESERVE, RELEASE, SALE, RESTOCK
quantityDeltanumberYesChange in quantity (integer, positive or negative)
reasonstringNoReason for the transaction
createdAtdateYesTransaction timestamp

GET /api/data/inventory/:id

Retrieve an inventory record by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


PATCH /api/data/inventory/:id

Update an inventory record by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.


DELETE /api/data/inventory/:id

Delete an inventory record by ID.

Auth: Session cookie required Tenant: Scoped via x-tenant-id header

Not yet implemented — returns no response.