Catalog & inventory

Serialized item

Specific physical unit of an item, with its serial number and where it is.

Schemas: SerializedItemDto, SerializedItemDetailDto

{
  "id": "id_8f2a1c",
  "code": "string",
  "serialNumber": "string",
  "status": "string",
  "itemId": "string",
  "itemName": "Example",
  "itemSku": "string",
  "itemCollectionName": "Example",
  "createdAt": "2026-09-01T08:00:00Z",
  "updatedAt": "2026-09-01T08:00:00Z"
}

Generated from the schema

A specific physical unit of an item, with its serial number, its code, its condition and where it is. When it is out, it points to the order that holds it. List the units of one item by filtering with itemId. Serialized items are bounded to the subscription that owns the key. The detail read adds the name of the collection of the item.

Attributes

idstring

Unique identifier of the physical unit.

codestring

Internal code of the unit.

serialNumberstring | null

Manufacturer serial number; null if not registered.

statusstring

Current status of the unit within the inventory cycle.

conditionstring | null

Condition; null if not assessed.

inventoryTypestring

"regular" for own stock, "temporary" for stock brought in for a specific job.

itemIdstring

Identifier of the catalog item this unit belongs to.

itemNamestring

Name of the catalog item.

itemSkustring | null

SKU of the item; null if it has none.

variantIdstring | null

Variant identifier; null if the item has no variants.

variantNamestring | null

Variant name; null if not applicable.

currentOrderIdstring | null

Order that holds the unit once it is prepared, picked up, sold or returned; null otherwise. A unit that is only reserved on an order is not committed yet: it stays available and this is null (the reservation is read from the serial numbers of the order line).

currentOrderNumberstring | null

Number of that order; null if the unit is free.

projectIdstring | null

Project associated with the current order; null if not applicable.

contactIdstring | null

Customer of the current order; null if not applicable.

createdAtstring<date-time>

Creation date in ISO 8601 UTC.

updatedAtstring<date-time>

Last modification date in ISO 8601 UTC.

itemCollectionNamestring | nullonly in the detail

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

Returned by

GET /api/v1/serialized-items — List serialized items
GET /api/v1/serialized-items/{serializedItemId} — Get a serialized item

Modified by

PATCH /api/v1/serialized-items/{serializedItemId} — Update a serialized item

Was this page helpful?