Available Operations

POST /inventories- Create a new inventory
GET /inventories- Get inventories
GET /inventories/{id} - Get inventory by ID
PATCH /inventories/{id} - Update inventory
DELETE /inventories/{id} - Delete inventory
GET /inventories/external-id/{externalId} - Get inventory by external ID

Data Models & Schemas

Inventory Entity

{
  "id": "string",
  "title": "string",
  "additionalInformation": "string",
  "productId": "string",
  "idNumber": "string",
  "specifications": [],
  "mediaId": "string",
  "authorId": "string",
  "organizationId": "string",
  "externalId": "string",
  "createdAt": "date-time",
  "updatedAt": "date-time",
  "stocks": [
    {
      "id": "string",
      "inventoryId": "string",
      "warehouseId": "string",
      "quantity": "number"
    }
  ],
  "generalStock": "number",
  "media": []
}

Field Descriptions:

id - A unique identifier (UUID) for the inventory record
title - The name or title of the inventory item. Required field used as the primary display name
additionalInformation - An optional free-text field for any extra details or notes about the inventory item
productId - A unique identifier (UUID) for the product associated with this inventory item. The referenced product must be of type INVENTORY. Can be null
idNumber - An optional identifier number for the inventory item (e.g., serial number, SKU, or internal tracking code)
specifications - A JSON array of specification objects containing additional technical or descriptive attributes of the inventory item
mediaId - A unique identifier (UUID) for the associated media file (e.g., image or document of the inventory item)
authorId - A unique identifier (string) representing the user who created the inventory record
organizationId - A unique identifier (string) for the organization that owns this inventory item
externalId - An optional identifier that connects this inventory record to external systems or databases, facilitating integration with other platforms. Must be unique
createdAt - Timestamp indicating when the inventory record was created, formatted in ISO 8601 standard (UTC)
updatedAt - Timestamp indicating when the inventory record was last updated, formatted in ISO 8601 standard (UTC)
stocks - An array of stock entries representing quantity per warehouse ( InventoryStockEntity )
media - An array of associated media files with signed URLs, populated on retrieval
generalStock - A readonly computed numerical value representing the total stock quantity across all (or filtered) warehouses

InventoryStock Entity

{
  "id": "string",
  "inventoryId": "string",
  "warehouseId": "string",
  "quantity": "number"
}

Field Descriptions:

id - A unique identifier (UUID) for the stock record
inventoryId - A unique identifier (UUID) referencing the parent inventory item
warehouseId - A unique identifier (UUID) for the warehouse where the stock is located
quantity - An integer representing the quantity of stock in this warehouse. Minimum value is 0

Error Response DTO

Standard error response format.

{
  "status": "number",
  "success": "boolean",
  "message": "string",
  "error": "string"
}

Field Descriptions:

status - HTTP status code (400-503)
success - Boolean indicating the operation failed (false)
message - Human-readable error message
error - Error code identifier