*REST API › Endpoint 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.

`POST /api/v1/availability/check` — scope `availability:read`

Scope: `availability:read` · 120/min · +30/min availability · MCP: `filmo_availability_check`

## Authorizations

Bearer API key with the scope below. `availability:read`

## Body

Body schema: `AvailabilityCheckBody`

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

## Request examples

*Check item availability*

**cURL**

```bash
curl https://app.filmo.io/api/v1/availability/check \
  --request POST \
  --header "Authorization: Bearer $FILMO_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "items": [
    {
      "itemId": "itm_9f3a2b",
      "variantId": "var_rojo",
      "transactionType": "rental",
      "quantity": 4
    },
    {
      "itemId": "itm_camara_a7"
    }
  ],
  "startDate": "2026-09-01T08:00:00+02:00",
  "endDate": "2026-09-05T20:00:00+02:00"
}'
```

**Node.js**

```javascript
fetch('https://app.filmo.io/api/v1/availability/check', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer YOUR_FILMO_API_KEY',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    items: [
      {
        itemId: 'itm_9f3a2b',
        variantId: 'var_rojo',
        transactionType: 'rental',
        quantity: 4
      },
      {
        itemId: 'itm_camara_a7'
      }
    ],
    startDate: '2026-09-01T08:00:00+02:00',
    endDate: '2026-09-05T20:00:00+02:00'
  })
})
```

**Python**

```python
import requests

requests.post(
    "https://app.filmo.io/api/v1/availability/check",
    headers={
      "Authorization": "Bearer YOUR_FILMO_API_KEY",
      "Content-Type": "application/json"
    },
    json={
      "items": [
        {
          "itemId": "itm_9f3a2b",
          "variantId": "var_rojo",
          "transactionType": "rental",
          "quantity": 4
        },
        {
          "itemId": "itm_camara_a7"
        }
      ],
      "startDate": "2026-09-01T08:00:00+02:00",
      "endDate": "2026-09-05T20:00:00+02:00"
    }
)
```

## Response

Response schema: `AvailabilityCheckEntryDto`

| Status | Description |
| --- | --- |
| 200 | Successful response. |
| 400 | Invalid request (validation_error): malformed query or body. `errors[]` lists every offending field with its stable code. |
| 401 | Authentication failed (unauthorized, api_key_invalid, api_key_revoked, api_key_expired, api_key_owner_inactive, api_key_owner_not_admin). |
| 403 | Not allowed (insufficient_scope: the API key does not have the required scope, named in `requiredScope`; forbidden: the owner of the key lacks the permission the operation requires). `insufficient_scope` is answered before the request counts against the rate limit, so it carries no `RateLimit-*` headers; `forbidden` does. |
| 404 | Resource not found (not_found): it does not exist or is outside the scope of the API key. |
| 409 | Conflict (conflict): the current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |
| 429 | Rate limit exceeded (rate_limited): retry after `Retry-After` seconds; `RateLimit-*` says which quota ran out. |
| 500 | Internal error (internal_error). |

**200**

| Name | Type | Description |
| --- | --- | --- |
| `data` | object[] |  |
| `meta` | object | Additional information about the response. |
| `meta.warnings` | object[] | Lifecycle warnings; present only when the operation is deprecated. |
| `meta.warnings.code` | string | Stable warning code. `deprecated` |
| `meta.warnings.message` | string | For people: what is deprecated, until when, and what to use. |
| `meta.warnings.sunset` | string | Day (YYYY-MM-DD) the operation stops being served. |
| `meta.warnings.replacement` | string | `operationId` of the operation to use instead, or null if there is none. |
| `meta.warnings.link` | string | Where the deprecation is documented (the changelog). |

*Example response · 200*

```json
{
  "data": [
    {
      "itemId": "item_9f3a2b",
      "variantId": "variant_9f3a2b",
      "itemName": "Example item name",
      "quantity": 1,
      "available": true,
      "status": "ok",
      "totalStock": 1,
      "reserved": 1,
      "minRemaining": 1,
      "shortfall": 1,
      "temporaryAvailable": 1,
      "conflictingPeriods": [
        "Example conflicting periods"
      ],
      "commitments": [
        {
          "orderId": "order_9f3a2b",
          "orderNumber": "2026-0001",
          "quantity": 1,
          "startDate": "2026-09-01T08:00:00.000Z",
          "endDate": "2026-09-01T08:00:00.000Z"
        }
      ],
      "checkedAt": "2026-09-01T08:00:00.000Z"
    }
  ]
}
```

## Errors

| Status | Codes | Meaning |
| --- | --- | --- |
| 400 | `validation_error` | Malformed query or body. `errors[]` lists every offending field with its stable code. |
| 404 | `not_found` | It does not exist or is outside the scope of the API key. |
| 409 | `conflict` | The current state of the resource prevents the operation, a request with that Idempotency-Key is already in progress, or another conditional write (`If-Match`) held the resource for more than five seconds. `errors[0].code` says which: `in_progress` and `lock_timeout` are solved by retrying; `invalid_state` is not, because the state of the resource forbids the operation. |

## Deprecation

This operation is not deprecated. Deprecations are announced with a Deprecation header and a sunset date.

---

Canonical URL: https://docs.filmo.io/rest-api/endpoint-reference/availability/check-item-availability  
Last updated: 2026-10-25