Availability

Check item availability

Checks the availability of a batch of items (1-100) over a common date range, each with the quantity you intend to book (1 by default).

Tool

filmo_availability_check

Readavailability:read

availability:read
120/min + 30/min availability
Server annotation: Read-only
Server annotation: Idempotent

{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "filmo_availability_check",
    "arguments": {
      "items": [
        {
          "itemId": "item_8f2a1c",
          "variantId": "vari_8f2a1c",
          "transactionType": "rental",
          "quantity": 1
        }
      ],
      "startDate": "2026-09-01T08:00:00Z",
      "endDate": "2026-09-01T08:00:00Z"
    }
  }
}

{
  "structuredContent": {
    "data": [
      {
        "itemId": "item_8f2a1c",
        "variantId": "vari_8f2a1c",
        "itemName": "Example",
        "quantity": 1,
        "available": true,
        "status": "ok",
        "totalStock": 1,
        "reserved": 1,
        "minRemaining": 1,
        "shortfall": 1,
        "temporaryAvailable": 1,
        "conflictingPeriods": [
          "<conflictingPeriods>"
        ],
        "commitments": [
          {
            "orderId": "orde_8f2a1c",
            "orderNumber": "<orderNumber>",
            "quantity": 1,
            "startDate": "2026-09-01T08:00:00Z",
            "endDate": "2026-09-01T08:00:00Z"
          }
        ],
        "checkedAt": "2026-09-01T08:00:00Z"
      }
    ],
    "meta": {
      "rateLimit": {
        "limit": 120,
        "remaining": 119,
        "reset": 42
      }
    }
  }
}

generated from the schema

Idempotent query (POST because of the structured body). Shares the availability quota of 30 req/min. One entry per requested item, in request order: its availability (available, shortfall, conflictingPeriods for that quantity, and commitments: the orders that hold units of it in the window, with their number, peak quantity and dates) or a per-item error when the item does not exist in the account.

Arguments

itemsobject[]Required

Batch of items to check (between 1 and 100).

Limits: min 1 items, max 100 items

Show child attributes

items.itemIdstringRequired

Identifier of the item to check. Required.

Limits: min length 1, max length 100

items.variantIdstring

Identifier of the specific variant to check; omit for the base item.

Limits: min length 1, max length 100

items.transactionTypestring

Type of transaction to check: rental or sale. Defaults to rental.

Available options: rental, sale

items.quantityinteger

Units you intend to book. Drives available, shortfall, status and conflictingPeriods. Defaults to 1.

Limits: min 1, max 100000

startDatestring<date-time>Required

Start of the range to check (ISO 8601 with offset), shared by the whole batch.

endDatestring<date-time>Required

End of the range to check (ISO 8601 with offset), shared by the whole batch; must be later than startDate.

Result

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

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

Sample prompts

Are two units of this lens free from 15 to 17 January?

The same operation by REST

This tool runs POST /api/v1/availability/check.

Availability
Check item availability
Checks the availability of a batch of items (1-100) over a common date range, each with the quantity you intend to book (1 by default).
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.

Was this page helpful?

Result

Arguments

Result

Sample prompts

The same operation by REST

Related pages

Check item availability

Safe writes

Errors