---
title: "plm reservations"
description: "Part-number reservations"
---

{/* AUTO-GENERATED by packages/cli/scripts/generate-docs.ts — do not edit by hand. */}
## plm reservations

Part-number reservations

**Usage**

```bash
plm reservations
```

**Subcommands**

- [`list`](#plm-reservations-list)
- [`get`](#plm-reservations-get)
- [`create`](#plm-reservations-create)
- [`delete`](#plm-reservations-delete)
- [`consume`](#plm-reservations-consume)
- [`expire`](#plm-reservations-expire)

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm reservations",
  "description": "Part-number reservations",
  "arguments": [],
  "options": [],
  "subcommands": [
    "list",
    "get",
    "create",
    "delete",
    "consume",
    "expire"
  ]
}
```

</details>

### plm reservations list

**Usage**

```bash
plm reservations list
```

**Options**

- `-f, --filter <kv...>` — key=value filters
- `--workspace <id>` — override workspaceId (defaults to caller)
- `--page <n>` — page number (1-based)
- `--limit <n>` — results per page
- `--offset <n>` — row offset (alternative to --page)
- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm reservations list",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "-f, --filter <kv...>",
      "description": "key=value filters",
      "required": false,
      "default": null
    },
    {
      "flags": "--workspace <id>",
      "description": "override workspaceId (defaults to caller)",
      "required": false,
      "default": null
    },
    {
      "flags": "--page <n>",
      "description": "page number (1-based)",
      "required": false,
      "default": null
    },
    {
      "flags": "--limit <n>",
      "description": "results per page",
      "required": false,
      "default": null
    },
    {
      "flags": "--offset <n>",
      "description": "row offset (alternative to --page)",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reservations get

**Usage**

```bash
plm reservations get <partNumber>
```

**Options**

- `--workspace <id>` — override workspaceId (defaults to caller)
- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm reservations get",
  "description": null,
  "arguments": [
    {
      "name": "partNumber",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--workspace <id>",
      "description": "override workspaceId (defaults to caller)",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reservations create

**Usage**

```bash
plm reservations create
```

**Options**

- `--file <path>`
- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm reservations create",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reservations delete

**Usage**

```bash
plm reservations delete <partNumber>
```

**Options**

- `--workspace <id>` — override workspaceId (defaults to caller)
- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm reservations delete",
  "description": null,
  "arguments": [
    {
      "name": "partNumber",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--workspace <id>",
      "description": "override workspaceId (defaults to caller)",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reservations consume

**Usage**

```bash
plm reservations consume <partNumber>
```

**Options**

- `--file <path>`
- `--workspace <id>` — override workspaceId (defaults to caller)
- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm reservations consume",
  "description": null,
  "arguments": [
    {
      "name": "partNumber",
      "required": true,
      "variadic": false,
      "description": ""
    }
  ],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    },
    {
      "flags": "--workspace <id>",
      "description": "override workspaceId (defaults to caller)",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>

### plm reservations expire

**Usage**

```bash
plm reservations expire
```

**Options**

- `--file <path>`
- `--workspace <id>` — override workspaceId (defaults to caller)
- `--format <fmt>` — output format _(default: `"json"`)_

<details>
<summary>Agent-readable summary</summary>

```json
{
  "command": "plm reservations expire",
  "description": null,
  "arguments": [],
  "options": [
    {
      "flags": "--file <path>",
      "description": "",
      "required": false,
      "default": null
    },
    {
      "flags": "--workspace <id>",
      "description": "override workspaceId (defaults to caller)",
      "required": false,
      "default": null
    },
    {
      "flags": "--format <fmt>",
      "description": "output format",
      "required": false,
      "default": "json"
    }
  ],
  "subcommands": []
}
```

</details>