Items

List serialized items

Returns the specific physical units of the inventory with their serial number, their status and which order they are committed to right now.

Tool
filmo_serialized_items_list
Access: Read

Result

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_serialized_items_list",
    "arguments": {
      "limit": 20
    }
  }
}

generated from the schema

Filter by itemId to keep those of one catalog item. It is the piece that lets an external system know which unit is where. It emits no purchase prices or supplier agreements.

Arguments

limitintegerdefault:50

Page size (1-500). Defaults to 50.

Limits: min 1, max 500

cursorstring

Opaque cursor of the page to return. Pass the value of pagination.nextCursor from the previous response; treat it as opaque.

Limits: max length 200

sortstring

Sort order: up to 3 comma-separated fields, each with a leading "-" for descending (e.g. "-updatedAt,name"). Sortable fields: createdAt, updatedAt, code, serialNumber, status, condition, itemName. Defaults to "-createdAt". Ties are broken by id, so the order is stable across pages, and a cursor is bound to the sort it was issued with.

Limits: max length 200

itemIdstring

Filter by catalog item: returns only its physical units.

Limits: min length 1, max length 100

itemIdsstring[]

Filter by itemId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

spaceIdstring

Filter by warehouse or space where the unit is located.

Limits: min length 1, max length 100

spaceIdsstring[]

Filter by spaceId, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Limits: min 1 items, max 50 items, each min length 1, each max length 100

statusstring

Filter by unit status. If omitted, all are returned.

Available options: available, prepared, picked_up, returned, broken, archived, sold

statusesstring[]

Filter by status, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Available options: available, prepared, picked_up, returned, broken, archived, sold

Limits: min 1 items, max 50 items

inventoryTypestring

Filter by inventory type: "regular" is own stock, "temporary" is stock brought in for a specific job (subrent). If omitted, both are returned.

Available options: regular, temporary

inventoryTypesstring[]

Filter by inventoryType, as a list: repeat the parameter or separate the values with commas. Accepts up to 50 values and returns whatever matches any of them.

Available options: regular, temporary

Limits: min 1 items, max 50 items

includeTotalbooleandefault:false

Set it to true to include pagination.total, the number of results that match the filters across all pages. Off by default.

dateFiltersobject

Date filters by field. A bare day (YYYY-MM-DD) is read in the business timezone; an ISO 8601 instant with offset is applied as is by gte, lte, gt and lt, while on widens it to the whole business day that contains it. Fields: created, updated.

Show child attributes
dateFilters.createdobject

Show child attributes
dateFilters.created.gtestring

From this day or instant, inclusive.

dateFilters.created.ltestring

Up to this day or instant, inclusive.

dateFilters.created.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.created.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.created.onstring

Exactly that day; an instant means the whole business day that contains it.

dateFilters.updatedobject

Show child attributes
dateFilters.updated.gtestring

From this day or instant, inclusive.

dateFilters.updated.ltestring

Up to this day or instant, inclusive.

dateFilters.updated.gtstring

Strictly after; a bare day means after the end of that day.

dateFilters.updated.ltstring

Strictly before; a bare day means before the start of that day.

dateFilters.updated.onstring

Exactly that day; an instant means the whole business day that contains it.

Result

On success the result carries structuredContent with data and meta. These are the attributes of data.

Show the attributes of data
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.

An error is a result with isError: true and the problem in content[0].text; there is no structuredContent. See Errors.

The same operation by REST

This tool runs GET /api/v1/serialized-items.

  • Items

    List serialized items

    Returns the specific physical units of the inventory with their serial number, their status and which order they are committed to right now.

  • Guides

    Safe writes

    An assistant that can write can also write the wrong thing. Decide which tools need a person, retry without duplicating, and know what a write sets in motion.

  • Guides

    Errors

    A tool error is a result with isError: true and the problem in the first text block. Branch on its code.