Catalog & inventory

Item

The item, as returned by the API.

Schemas: ItemDto, ItemDetailDto

{
  "id": "id_8f2a1c",
  "name": "Example",
  "sku": "string",
  "description": "string",
  "orderInfo": "string",
  "ean": "string",
  "itemType": "fixed",
  "stockCalculationMethod": "bulk",
  "collectionId": "string",
  "collectionName": "Example",
  "images": [
    "string"
  ],
  "salePrice": "1234.50",
  "depositValue": "1234.50",
  "minStock": 1,
  "serializedItemsCount": 1,
  "pricingSettings": {
    "type": "periodPrice",
    "price": "1234.50",
    "period": "hour"
  },
  "insuranceEnabled": true,
  "discountEnabled": true,
  "bufferBefore": 1,
  "bufferBeforeUnit": "hour",
  "bufferAfter": 1,
  "bufferAfterUnit": "hour",
  "physicalProperties": {
    "weight": 1,
    "width": 1,
    "height": 1,
    "length": 1,
    "volume": 1,
    "current": 1,
    "power": 1
  },
  "variants": [
    {
      "variantId": "string",
      "variantName": "Example",
      "variantPrice": "1234.50",
      "salePrice": "1234.50",
      "ean": "string"
    }
  ],
  "tags": [
    {
      "id": "id_8f2a1c",
      "name": "Example"
    }
  ],
  "customFields": {
    "key": "string"
  },
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z",
  "replacementValue": "1234.50",
  "accessoryIds": [
    "string"
  ],
  "alternativeIds": [
    "string"
  ]
}

Generated from the schema

A piece of equipment in the catalog, with its SKU, pricing, buffers, variants, physical properties and the collection it belongs to. Each item can have physical serialized units. Items are bounded to the subscription that owns the key. The SKU is optional on create: the server assigns the next available one. The detail read, GET /api/v1/items/{itemId}, adds the replacement value and the identifiers of the accessories and alternatives.

Attributes

idstring

Unique identifier of the item.

namestring

Item name.

skustring | null

SKU reference of the item; null if not recorded.

descriptionstring | null

Item description; null if not recorded.

orderInfostring | null

Additional information for the order (preparation/delivery notes); null if not recorded.

eanstring | null

EAN/barcode; null if not recorded.

itemTypestring

Item type: fixed (simple item) or variant (item with variants).

Available options: fixed, variant

stockCalculationMethodstring

Stock calculation method: bulk (in bulk, by quantity) or serialized (by serialized items).

Available options: bulk, serialized

collectionIdstring | null

Identifier of the collection it belongs to; null if it is in none.

collectionNamestring | null

Name of the collection it belongs to; null if it is in none.

imagesstring[]

URLs of the item images.

salePricestring | null

Sale price as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none.

Limits: pattern ^-?\d+\.\d{2}$

depositValuestring | null

Deposit amount as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none.

Limits: pattern ^-?\d+\.\d{2}$

minStocknumber | null

Minimum stock configured for alerts; null if not configured.

serializedItemsCountnumber

Number of serialized items registered for the item.

pricingSettingsobject | null

Rental pricing configuration; null if not configured.

Show child attributes

pricingSettings.typestring | null

Pricing mode: periodPrice (price per period), fixedPrice (fixed price) or pricingStructure (pricing structure); null if the item has none configured.

Available options: periodPrice, fixedPrice, pricingStructure

pricingSettings.pricestring | null

Base rental price as a decimal string "1234.50" (ROUND_HALF_UP); null if not applicable.

Limits: pattern ^-?\d+\.\d{2}$

pricingSettings.periodstring | null

Period unit of the price: hour, day, week or month; null if the item has none configured.

Available options: hour, day, week, month

insuranceEnabledboolean

Whether the item allows insurance.

discountEnabledboolean

Whether the item allows discounts.

bufferBeforenumber | null

Buffer time reserved before the rental; null if not applicable.

bufferBeforeUnitstring | null

Unit of the buffer before: hour or day; null if not applicable.

Available options: hour, day

bufferAfternumber | null

Buffer time reserved after the rental; null if not applicable.

bufferAfterUnitstring | null

Unit of the buffer after: hour or day; null if not applicable.

Available options: hour, day

physicalPropertiesobject | null

Physical properties (weight and dimensions); null if not recorded.

Show child attributes

physicalProperties.weightnumber | null

Item weight in kilograms; null if not recorded.

physicalProperties.widthnumber | null

Item width in centimeters; null if not recorded.

physicalProperties.heightnumber | null

Item height in centimeters; null if not recorded.

physicalProperties.lengthnumber | null

Item length in centimeters; null if not recorded.

physicalProperties.volumenumber | null

Item volume in cubic meters (m³); null if not recorded.

physicalProperties.currentnumber | null

Current draw in amperes; null if not recorded.

physicalProperties.powernumber | null

Power in watts; null if not recorded.

variantsobject[]

Item variants (empty if the item is of type fixed).

Show child attributes

variants.variantIdstring

Unique identifier of the variant.

variants.variantNamestring

Variant name.

variants.variantPricestring

Rental price of the variant as a decimal string "1234.50" (ROUND_HALF_UP).

Limits: pattern ^-?\d+\.\d{2}$

variants.salePricestring | null

Sale price of the variant as a decimal string "1234.50" (ROUND_HALF_UP); null if it has none.

Limits: pattern ^-?\d+\.\d{2}$

variants.eanstring | null

EAN/barcode of the variant; null if not recorded.

tagsobject[]

Tags associated with the item.

Show child attributes

tags.idstring

Unique identifier of the tag.

tags.namestring

Tag name.

customFieldsobject<string, any>

Custom field values by custom field identifier; the definitions are in /api/v1/custom-fields.

createdAtstring<date-time>

Creation date in ISO 8601 with offset.

updatedAtstring<date-time>

Last update date in ISO 8601 with offset.

replacementValuestring | nullonly in the detail

Replacement value of the item as a decimal string "1234.50" (ROUND_HALF_UP); null if not recorded.

Limits: pattern ^-?\d+\.\d{2}$

accessoryIdsstring[]only in the detail

Identifiers of the items configured as accessories of this one.

alternativeIdsstring[]only in the detail

Identifiers of the items configured as alternatives of this one.

Values

itemType: fixed, variant
stockCalculationMethod: bulk, serialized
bufferBeforeUnit: hour, day
bufferAfterUnit: hour, day

Returned by

GET /api/v1/items — List items
GET /api/v1/items/{itemId} — Get an item

Modified by

POST /api/v1/items — Create an item
PATCH /api/v1/items/{itemId} — Update an item
PATCH /api/v1/items/{itemId}/physical-properties — Update weight and dimensions
PATCH /api/v1/items/{itemId}/pricing — Update the pricing of an item
PUT /api/v1/items/{itemId}/accessories — Update the accessories of an item
PUT /api/v1/items/{itemId}/alternatives — Update the alternatives of an item
PATCH /api/v1/items/{itemId}/variants/{variantId} — Update a variant of an item

Was this page helpful?