*MCP › Reference › Catalog & inventory › 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).

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.

TOOL `filmo_availability_check` · `availability:read` · 120/min · + 30/min availability · Server annotation: Read-only · Server annotation: Idempotent

## Arguments

| Name | Type | Required | Description |
| --- | --- | --- | --- |
| `items` | object[] | Yes | Batch of items to check (between 1 and 100). |
| `items.itemId` | string | Yes | Identifier of the item to check. Required. |
| `items.variantId` | string | No | Identifier of the specific variant to check; omit for the base item. |
| `items.transactionType` | string | No | Type of transaction to check: rental or sale. Defaults to rental. `rental`, `sale` |
| `items.quantity` | integer | No | Units you intend to book. Drives `available`, `shortfall`, `status` and `conflictingPeriods`. Defaults to 1. |
| `startDate` | string<date-time> | Yes | Start of the range to check (ISO 8601 with offset), shared by the whole batch. |
| `endDate` | string<date-time> | Yes | 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`.

*Call · filmo_availability_check*

```json
{
  "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"
    }
  }
}
```

*Result (generated from the schema)*

```json
{
  "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
      }
    }
  }
}
```

## Sample prompts

*Prompt*

```text
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`](https://docs.filmo.io/rest-api/endpoint-reference/availability/check-item-availability).

---

Canonical URL: https://docs.filmo.io/mcp/tools/availability/filmo-availability-check  
Last updated: 2026-10-25