Overview Inventory items represent individual assets tracked in your system. Each item belongs to a container and has an asset type that defines its custom fields. Items support multiple images, quantity tracking, custom field values, and market value tracking.
List Items Retrieve all inventory items across all containers with optional aggregation filters.
Comma-separated key:value pairs for filtering by custom field values. Example: brand:Apple,condition:New
{ "data" : { "items" : [ { "id" : 1 , "name" : "MacBook Pro 16 \" " , "description" : "M2 Max, 32GB RAM" , "barcode" : "123456789" , "containerId" : 5 , "assetTypeId" : 2 , "locationId" : 3 , "quantity" : 1 , "minStock" : 1 , "marketValue" : 2499.99 , "currency" : "EUR" , "totalMarketValue" : 2499.99 , "lastPriceUpdate" : "2026-03-07T10:30:00Z" , "customFieldValues" : { "brand" : "Apple" , "condition" : "New" , "serialNumber" : "FVFXK3G8Q05N" }, "images" : [ { "id" : 12 , "url" : "https://storage.example.com/item-1-photo.jpg" , "altText" : "Front view" , "order" : 0 } ], "location" : { "id" : 3 , "name" : "Office Shelf A" , "description" : "Main storage area" }, "createdAt" : "2026-01-15T08:20:00Z" , "updatedAt" : "2026-03-07T10:30:00Z" } ], "totalItems" : 1 , "totalMarketValue" : 2499.99 } }
Container for response data Array of inventory item objects Unique identifier for the item
Detailed description of the item
Barcode or UPC code for market value syncing
ID of the parent container
ID of the asset type defining custom fields
ID of the location where item is stored
Current quantity in stock (default: 1)
Minimum stock threshold for alerts (default: 1)
Current market value per unit (default: 0.0)
Currency code (default: “EUR”)
Total value (marketValue × quantity)
ISO 8601 timestamp of last price sync
Key-value pairs for custom field data defined by asset type
Array of image objects Alternative text description
Location details if locationId is set ISO 8601 creation timestamp
ISO 8601 last update timestamp
Total count of items in response
Sum of all totalMarketValue fields
List Scoped Items GET /containers/{containerId}/asset-types/{assetTypeId}/items
Retrieve inventory items filtered by container and asset type.
Comma-separated key:value pairs for custom field filtering
{ "data" : { "items" : [ { "id" : 42 , "name" : "iPhone 15 Pro" , "containerId" : 5 , "assetTypeId" : 2 , "quantity" : 2 , "customFieldValues" : { "color" : "Natural Titanium" , "storage" : "256GB" } } ], "totalItems" : 1 } }
Create Item POST /items Content-Type : multipart/form-data
Create a new inventory item with optional image uploads.
Barcode or UPC for market sync
Asset type ID defining custom fields
JSON-encoded object of custom field values matching asset type field definitions Example: {"brand":"Apple","condition":"New"}
Array of image files to upload. Field name must be “images” for each file.
{ "data" : { "data" : { "id" : 123 , "name" : "iPad Air" , "description" : "5th generation" , "barcode" : "194253912736" , "containerId" : 5 , "assetTypeId" : 3 , "locationId" : 7 , "quantity" : 1 , "minStock" : 1 , "customFieldValues" : { "color" : "Space Gray" , "storage" : "64GB" }, "images" : [ { "id" : 45 , "url" : "https://storage.example.com/uploads/item-123-0.jpg" , "altText" : null , "order" : 0 } ], "marketValue" : 0.0 , "currency" : "EUR" , "totalMarketValue" : 0.0 , "createdAt" : "2026-03-07T14:22:00Z" , "updatedAt" : "2026-03-07T14:22:00Z" } } }
Update Item PATCH /items/{itemId} Content-Type : multipart/form-data
Update an existing inventory item. Supports adding new images and removing existing ones.
Container ID (can be changed to move item)
Asset type ID (can be changed to reclassify item)
Updated minimum stock threshold
JSON-encoded custom field values
JSON-encoded array of image IDs to delete Example: [12, 45, 67]
New images to upload (appended to existing images)
{ "data" : { "id" : 123 , "name" : "iPad Air (Updated)" , "quantity" : 3 , "images" : [ { "id" : 46 , "url" : "https://storage.example.com/uploads/item-123-new.jpg" , "order" : 0 } ], "updatedAt" : "2026-03-07T15:10:00Z" } }
Delete Item Permanently delete an inventory item and all associated images.
Clone Item POST /containers/{containerId}/asset-types/{assetTypeId}/items/clone Content-Type : application/json
Create a duplicate of an existing item with all custom fields and image references.
Container ID of the item to clone
Asset type ID of the item to clone
Complete InventoryItem object to clone (from toJson()) Original item ID (will be replaced with new ID)
Custom field values to copy
Image references to copy (IDs will be reset)
{ "id" : 124 , "name" : "iPad Air" , "containerId" : 5 , "assetTypeId" : 3 , "customFieldValues" : { "color" : "Space Gray" , "storage" : "64GB" }, "images" : [ { "id" : 0 , "url" : "https://storage.example.com/uploads/item-123-0.jpg" } ] }
Batch Import Items POST /containers/{containerId}/asset-types/{assetTypeId}/items/batch Content-Type : application/json
Bulk create multiple inventory items in a single request. Useful for importing from spreadsheets or external systems.
Container ID where items will be created
Asset type ID for all items
Array of item data objects to create Custom field key-value pairs
{ "items" : [ { "name" : "iPhone 15 Pro #1" , "quantity" : 1 , "customFieldValues" : { "color" : "Natural Titanium" , "storage" : "256GB" } }, { "name" : "iPhone 15 Pro #2" , "quantity" : 1 , "customFieldValues" : { "color" : "Black Titanium" , "storage" : "512GB" } } ] }
Get Item Price History GET /items/{itemId}/price-history
Retrieve the historical market value data points for an item.
[ { "date" : "2026-01-15T00:00:00Z" , "value" : 2499.99 }, { "date" : "2026-02-01T00:00:00Z" , "value" : 2399.99 }, { "date" : "2026-03-01T00:00:00Z" , "value" : 2299.99 } ]
ISO 8601 timestamp of the price point
Market value at that date
Sync Item with Market Data POST /market/sync-item/{itemId}
Fetch current market value using the item’s barcode/UPC from external pricing APIs.
{ "data" : { "id" : 123 , "name" : "iPad Air" , "barcode" : "194253912736" , "marketValue" : 649.99 , "currency" : "EUR" , "totalMarketValue" : 649.99 , "lastPriceUpdate" : "2026-03-07T16:00:00Z" } }
Error Responses { "error" : "El ítem no tiene código de barras" }
Common errors:
"El ítem no tiene código de barras" - Item has no barcode set"No se encontró información de mercado para este código" - No market data found
Get Total Market Value Calculate the total market value of all items across all containers.
{ "totalMarketValue" : 45678.90 }
Sum of all items’ totalMarketValue fields
Error Handling All endpoints return standard HTTP status codes:
200 OK - Request successful201 Created - Resource created successfully204 No Content - Deletion successful400 Bad Request - Invalid parameters or malformed request401 Unauthorized - Authentication required404 Not Found - Resource not found500 Internal Server Error - Server error
Error responses include a message:
{ "message" : "Validation error description" , "error" : "Detailed error information" }
