Inventory Items

GET /items

{
  "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
  }
}

GET /items

{
  "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
  }
}

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

GET /items

Retrieve all inventory items across all containers with optional aggregation filters.

string

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
  }
}

object

Container for response data

Show properties

array

Array of inventory item objects

Show item properties

integer

required

Unique identifier for the item

string

required

Item name

string

Detailed description of the item

string

Barcode or UPC code for market value syncing

integer

required

ID of the parent container

integer

required

ID of the asset type defining custom fields

integer

ID of the location where item is stored

integer

required

Current quantity in stock (default: 1)

integer

required

Minimum stock threshold for alerts (default: 1)

number

Current market value per unit (default: 0.0)

string

Currency code (default: “EUR”)

number

Total value (marketValue × quantity)

string

ISO 8601 timestamp of last price sync

object

Key-value pairs for custom field data defined by asset type

array

Array of image objects

Show image properties

integer

Image ID

string

Full URL to the image

string

Alternative text description

integer

Display order (0-based)

object

Location details if locationId is set

Show properties

integer

Location ID

string

Location name

string

Location description

string

ISO 8601 creation timestamp

string

ISO 8601 last update timestamp

integer

Total count of items in response

number

Sum of all totalMarketValue fields

List Scoped Items

GET /containers/{containerId}/asset-types/{assetTypeId}/items

Retrieve inventory items filtered by container and asset type.

integer

required

ID of the container

integer

required

ID of the asset type

string

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.

string

required

Item name

string

Item description

string

Barcode or UPC for market sync

integer

required

Parent container ID

integer

required

Asset type ID defining custom fields

integer

Storage location ID

integer

default:"1"

Initial quantity

integer

default:"1"

Minimum stock threshold

string

required

JSON-encoded object of custom field values matching asset type field definitionsExample: {"brand":"Apple","condition":"New"}

file[]

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.

integer

required

ID of the item to update

string

required

Updated item name

string

Updated description

string

Updated barcode

integer

required

Container ID (can be changed to move item)

integer

required

Asset type ID (can be changed to reclassify item)

integer

Updated location ID

integer

required

Updated quantity

integer

required

Updated minimum stock threshold

string

required

JSON-encoded custom field values

string

default:"[]"

JSON-encoded array of image IDs to deleteExample: [12, 45, 67]

file[]

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

DELETE /items/{itemId}

Permanently delete an inventory item and all associated images.

integer

required

ID of the item to delete

204 No Content

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.

integer

required

Container ID of the item to clone

integer

required

Asset type ID of the item to clone

object

required

Complete InventoryItem object to clone (from toJson())

Show properties

integer

Original item ID (will be replaced with new ID)

string

required

Item name

object

Custom field values to copy

array

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.

integer

required

Container ID where items will be created

integer

required

Asset type ID for all items

array

required

Array of item data objects to create

Show item object

string

required

Item name

string

Item description

string

Barcode/UPC

integer

default:"1"

Quantity

integer

default:"1"

Min stock threshold

integer

Location ID

object

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"
      }
    }
  ]
}

201 Created

Get Item Price History

GET /items/{itemId}/price-history

Retrieve the historical market value data points for an item.

integer

required

ID of the 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
  }
]

string

ISO 8601 timestamp of the price point

number

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.

integer

required

ID of the item to sync

{
  "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

GET /total-market-value

Calculate the total market value of all items across all containers.

{
  "totalMarketValue": 45678.90
}

number

Sum of all items’ totalMarketValue fields

Error Handling

All endpoints return standard HTTP status codes:

200 OK - Request successful
201 Created - Resource created successfully
204 No Content - Deletion successful
400 Bad Request - Invalid parameters or malformed request
401 Unauthorized - Authentication required
404 Not Found - Resource not found
500 Internal Server Error - Server error

Error responses include a message:

{
  "message": "Validation error description",
  "error": "Detailed error information"
}

Authentication

Inventory

Management

Data & Reports

Extensions

Overview

List Items

List Scoped Items

Create Item

Update Item

Delete Item

Clone Item

Batch Import Items

Get Item Price History

Sync Item with Market Data

Error Responses

Get Total Market Value

Error Handling

​Overview

​List Items

​List Scoped Items

​Create Item

​Update Item

​Delete Item

​Clone Item

​Batch Import Items

​Get Item Price History

​Sync Item with Market Data

​Error Responses

​Get Total Market Value

​Error Handling

Overview

List Items

List Scoped Items

Create Item

Update Item

Delete Item

Clone Item

Batch Import Items

Get Item Price History

Sync Item with Market Data

Error Responses

Get Total Market Value

Error Handling