Items

List items

Returns the inventory item catalog, cursor-paginated.

Tool
filmo_items_list
Access: Read

Result

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

generated from the schema

Strict per-subscription tenancy.

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, name, sku, salePrice, depositValue, serializedItemsCount, collectionName. 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

querystring

Free-text search (currently ILIKE over name, SKU, synonyms and serialized item codes). Semantics are NOT contractual: they may evolve without notice.

Limits: max length 200

stockTypestring

Filter by stock calculation method: serialized (by serialized items) or bulk (in bulk).

Available options: serialized, bulk

stockTypesstring[]

Filter by stockType, 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: serialized, bulk

Limits: min 1 items, max 50 items

collectionIdstring

Filter by identifier of the collection the item belongs to.

Limits: max length 100

collectionIdsstring[]

Filter by collectionId, 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 max length 100

idsstring

Batch lookup by comma-separated identifiers (between 1 and 100), intended for synchronization.

Limits: max length 4000

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

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

Sample prompts

Find the items in the camera category that contain “cinema” in their name.

The same operation by REST

This tool runs GET /api/v1/items.

  • Items

    List items

    Returns the inventory item catalog, cursor-paginated.

  • 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.