# 機能設計書 49-在庫レベル管理

## 概要

本ドキュメントは、Medusaコマースプラットフォームにおける在庫レベル管理機能の設計を記述する。在庫レベル（InventoryLevel）は、特定の在庫アイテムと特定のロケーションにおける在庫数量を管理するエンティティであり、在庫数（stocked_quantity）、予約数（reserved_quantity）、入荷予定数（incoming_quantity）を追跡する。

### 本機能の処理概要

**業務上の目的・背景**：ECサイトにおいて、商品の在庫を複数の倉庫・ロケーションで管理する必要がある。在庫レベル管理は、各ロケーションにおける在庫数量を個別に追跡し、利用可能数量の計算、在庫調整、ロケーション間での在庫移動の基盤を提供する。

**機能の利用シーン**：
- ロケーションに在庫を追加する場合
- 在庫数量を調整する場合（入荷、出荷、棚卸し）
- ロケーション別の在庫状況を確認する場合
- 利用可能在庫数を取得する場合

**主要な処理内容**：
1. 在庫レベルの作成（createInventoryLevels）
2. 在庫レベルの更新（updateInventoryLevels）
3. 在庫レベルの削除（deleteInventoryLevel）
4. 在庫調整（adjustInventory）
5. 利用可能数量の取得（retrieveAvailableQuantity）
6. 在庫数量の取得（retrieveStockedQuantity）
7. 予約数量の取得（retrieveReservedQuantity）

**関連システム・外部連携**：
- 在庫アイテム管理（親エンティティ）
- 在庫予約管理（予約時のreserved_quantity更新）
- 在庫ロケーション管理

**権限による制御**：管理画面からの操作は管理者権限が必要。

## 関連画面

| 画面No | 画面名 | 関連種別 | 関連する操作・処理 |
|--------|--------|----------|------------------|
| 13 | 商品在庫編集画面 | 補助機能 | ロケーション別在庫数量の設定 |
| 25 | バリアント在庫管理画面 | 補助機能 | 在庫数量の設定 |
| 47 | 返品受領画面 | 補助機能 | 返品在庫の戻し処理 |
| 93 | 在庫詳細画面 | 補助機能 | ロケーション別在庫の表示 |
| 96 | 在庫ロケーション管理画面 | 主機能 | 在庫のロケーション設定 |
| 97 | 在庫調整画面 | 主機能 | 在庫数量の調整 |
| 98 | 在庫一括更新画面 | 主機能 | 在庫の一括更新 |

## 機能種別

CRUD操作、在庫計算

## 入力仕様

### 入力パラメータ

| パラメータ名 | 型 | 必須 | 説明 | バリデーション |
|-------------|-----|-----|------|---------------|
| inventory_item_id | string | Yes | 在庫アイテムID | 存在チェック |
| location_id | string | Yes | ロケーションID | 必須 |
| stocked_quantity | BigNumber | No | 在庫数量 | デフォルト: 0 |
| reserved_quantity | BigNumber | No | 予約数量（内部用） | デフォルト: 0、直接更新不可 |
| incoming_quantity | BigNumber | No | 入荷予定数量 | デフォルト: 0 |
| metadata | object | No | カスタムメタデータ | JSON形式 |

### 制約事項

- reserved_quantityは予約アイテムの作成・削除時に自動更新される（直接更新不可）
- inventory_item_idとlocation_idの組み合わせはユニーク

### 入力データソース

- 管理画面からのフォーム入力
- Admin API経由
- 在庫予約処理からの自動更新

## 出力仕様

### 出力データ

| 項目名 | 型 | 説明 |
|--------|-----|------|
| id | string | 在庫レベルID（ilev_xxx形式） |
| inventory_item_id | string | 在庫アイテムID |
| location_id | string | ロケーションID |
| stocked_quantity | BigNumber | 在庫数量 |
| reserved_quantity | BigNumber | 予約数量 |
| incoming_quantity | BigNumber | 入荷予定数量 |
| available_quantity | BigNumber | 利用可能数量（計算フィールド） |
| metadata | object | メタデータ |
| created_at | datetime | 作成日時 |
| updated_at | datetime | 更新日時 |

### 出力先

- API Response（JSON形式）
- DBテーブル：inventory_level

## 処理フロー

### 処理シーケンス

```
1. 入力データの受信
   └─ 在庫レベル情報を含む

2. 入力データのサニタイズ
   └─ sanitizeInventoryLevelInput()でreserved_quantityを除去

3. 在庫レベルの存在確認
   └─ ensureInventoryLevels()で存在チェック

4. 在庫レベルの作成/更新
   └─ inventoryLevelService_.create/update()

5. シリアライズとレスポンス返却
```

### フローチャート

```mermaid
flowchart TD
    A[開始] --> B[入力データ受信]
    B --> C[sanitizeInventoryLevelInput]
    C --> D{操作種別}
    D -->|作成| E[inventoryLevelService_.create]
    D -->|更新| F[ensureInventoryLevels]
    D -->|調整| G[adjustInventory_]
    F --> H[levelMap作成]
    H --> I[inventoryLevelService_.update]
    G --> J[在庫レベル取得]
    J --> K[stocked_quantity計算]
    K --> L[inventoryLevelService_.update]
    E --> M[シリアライズ]
    I --> M
    L --> M
    M --> N[イベント発行]
    N --> O[レスポンス返却]
    O --> P[終了]
```

## ビジネスルール

### 業務ルール

| ルールNo | ルール名 | 内容 | 適用条件 |
|---------|---------|------|---------|
| BR-49-01 | ユニーク制約 | inventory_item_idとlocation_idの組み合わせはユニーク | 作成時 |
| BR-49-02 | reserved_quantity保護 | reserved_quantityは予約処理経由でのみ更新可能 | 更新時 |
| BR-49-03 | available_quantity計算 | available_quantity = stocked_quantity - reserved_quantity | 取得時 |
| BR-49-04 | デフォルト値 | stocked_quantity, reserved_quantity, incoming_quantityはデフォルト0 | 作成時 |

### 計算ロジック

- **利用可能数量（available_quantity）**: stocked_quantity - reserved_quantity
- **在庫調整（adjustInventory）**: stocked_quantity = stocked_quantity + adjustment

## データベース操作仕様

### 操作別データベース影響一覧

| 操作 | 対象テーブル | 操作種別 | 概要 |
|-----|-------------|---------|------|
| createInventoryLevels | inventory_level | INSERT | 新規在庫レベル作成 |
| updateInventoryLevels | inventory_level | UPDATE | 在庫レベル更新 |
| deleteInventoryLevel | inventory_level | DELETE | 在庫レベル削除 |
| adjustInventory | inventory_level | UPDATE | 在庫数量調整 |

### テーブル別操作詳細

#### inventory_level

| 操作 | 項目（カラム名） | 更新値・取得条件 | 備考 |
|-----|-----------------|-----------------|------|
| INSERT | id | 自動生成（ilev_xxx形式） | プライマリキー |
| INSERT | inventory_item_id | 在庫アイテムID | 外部キー、インデックスあり |
| INSERT | location_id | ロケーションID | インデックスあり |
| INSERT | stocked_quantity | 入力値（BigNumber） | デフォルト: 0 |
| INSERT | reserved_quantity | 入力値（BigNumber） | デフォルト: 0 |
| INSERT | incoming_quantity | 入力値（BigNumber） | デフォルト: 0 |
| INSERT | metadata | 入力値 | nullable, JSON |

### インデックス

| インデックス名 | カラム | 特性 |
|--------------|--------|------|
| IDX_inventory_level_inventory_item_id | inventory_item_id | deleted_at IS NULL |
| IDX_inventory_level_location_id | location_id | deleted_at IS NULL |
| IDX_inventory_level_location_id_inventory_item_id | inventory_item_id, location_id | unique, deleted_at IS NULL |

## エラー処理

### エラーケース一覧

| エラーコード | エラー種別 | 発生条件 | 対処方法 |
|------------|----------|---------|---------|
| NOT_FOUND | MedusaError | 在庫レベルが存在しない | inventory_item_idとlocation_idを確認 |
| NOT_FOUND | MedusaError | アイテムがロケーションにストックされていない | 先に在庫レベルを作成 |
| NOT_ALLOWED | MedusaError | 在庫が不足（バックオーダー無効時） | 在庫を補充するか、バックオーダーを許可 |

### リトライ仕様

トランザクションレベルでのリトライ対応。

## トランザクション仕様

- 作成・更新・削除は@InjectTransactionManager()デコレータによりトランザクション管理
- 予約との連携時もトランザクション内で実行

## パフォーマンス要件

- inventory_item_id、location_id、およびその複合キーにインデックス設定済み
- 複合ユニークインデックスにより高速な在庫レベル取得が可能

## セキュリティ考慮事項

- 管理者認証必須
- reserved_quantityの直接更新を防止

## 備考

- IDプレフィックスは「ilev」
- available_quantityは計算フィールドとして定義
- 在庫調整時はMathBN.addで精度を保持

---

## コードリーディングガイド

本機能を理解するために参照すべきファイルと、推奨する読み解き順序を以下に示す。

### 推奨読解順序

#### Step 1: データ構造を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | inventory-level.ts | `packages/modules/inventory/src/models/inventory-level.ts` | エンティティ定義 |
| 1-2 | inventory-item.ts | `packages/modules/inventory/src/models/inventory-item.ts` | 親エンティティとの関係 |

**読解のコツ**: InventoryLevelは在庫アイテムとロケーションの組み合わせを管理する。stocked_quantity、reserved_quantity、incoming_quantityの3つの数量フィールドを持ち、available_quantityは計算フィールドとして定義されている。

#### Step 2: 在庫レベルサービスを理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | inventory-level.ts | `packages/modules/inventory/src/services/inventory-level.ts` | 在庫レベルサービス |

**主要処理フロー**:
- **23-37行目**: `retrieveStockedQuantity()` - 在庫数量取得
- **39-53行目**: `getAvailableQuantity()` - 利用可能数量取得
- **55-69行目**: `getReservedQuantity()` - 予約数量取得

#### Step 3: モジュールサービスでの利用を理解する

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | inventory-module.ts | `packages/modules/inventory/src/services/inventory-module.ts` | 在庫レベル操作 |

**主要処理フロー**:
- **102-195行目**: `ensureInventoryLevels()` - 在庫レベル存在確認・バリデーション
- **199-209行目**: `sanitizeInventoryLevelInput()` - reserved_quantity除去
- **352-393行目**: `createInventoryLevels()` - 在庫レベル作成
- **480-543行目**: `updateInventoryLevels()` - 在庫レベル更新
- **460-478行目**: `deleteInventoryLevel()` - 在庫レベル削除
- **913-1000行目**: `adjustInventory()` - 在庫調整

### プログラム呼び出し階層図

```
InventoryModuleService
    │
    ├─ createInventoryLevels() [public]
    │      ├─ sanitizeInventoryLevelInput() [private]
    │      └─ createInventoryLevels_() [protected]
    │             └─ inventoryLevelService_.create()
    │
    ├─ updateInventoryLevels() [public]
    │      ├─ sanitizeInventoryLevelInput() [private]
    │      └─ updateInventoryLevels_() [protected]
    │             ├─ ensureInventoryLevels() [private]
    │             └─ inventoryLevelService_.update()
    │
    ├─ adjustInventory() [public]
    │      └─ adjustInventory_() [protected]
    │             ├─ inventoryLevelService_.list()
    │             └─ inventoryLevelService_.update()
    │                    └─ MathBN.add(stocked_quantity, adjustment)
    │
    └─ inventoryLevelService_ (InventoryLevelService)
           ├─ retrieveStockedQuantity()
           │      └─ inventoryLevelRepository.getStockedQuantity()
           │
           ├─ getAvailableQuantity()
           │      └─ inventoryLevelRepository.getAvailableQuantity()
           │
           └─ getReservedQuantity()
                  └─ inventoryLevelRepository.getReservedQuantity()
```

### データフロー図

```
[入力]                      [処理]                              [出力]

CreateInventoryLevelInput  InventoryModuleService             InventoryLevelDTO
         │                          │                                │
         ▼                          ▼                                ▼
    ┌──────────┐           ┌─────────────────┐              ┌──────────────┐
    │ API      │ ────────▶ │ sanitize +      │ ───────────▶ │ JSON Response│
    │ Request  │           │ create/update   │              │ (serialized) │
    └──────────┘           └─────────────────┘              └──────────────┘
                                   │
                                   ▼
                           ┌───────────────┐
                           │ inventory_    │
                           │ level table   │
                           └───────────────┘

[在庫調整フロー]

inventoryItemId            adjustInventory                    InventoryLevelDTO
locationId                         │                                │
adjustment                         ▼                                ▼
    │                     ┌─────────────────┐              ┌──────────────┐
    └────────────────────▶│ adjustInventory_│ ───────────▶ │ 更新された   │
                          │                 │              │ 在庫レベル   │
                          └─────────────────┘              └──────────────┘
                                   │
                                   ▼
                          ┌─────────────────┐
                          │ stocked_quantity│
                          │ += adjustment   │
                          └─────────────────┘

[利用可能数量計算]

stocked_quantity                                          available_quantity
        │                                                         │
        ▼                                                         ▼
   ┌─────────┐                                              ┌─────────┐
   │  100    │ ───────────────────────────────────────────▶ │   80    │
   └─────────┘                                              └─────────┘
        │                    ┌─────────┐
        │                    │ - 20    │ ◀── reserved_quantity
        └────────────────────┴─────────┘
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| inventory-module.ts | `packages/modules/inventory/src/services/inventory-module.ts` | ソース | モジュールサービス本体 |
| inventory-level.ts | `packages/modules/inventory/src/services/inventory-level.ts` | ソース | 在庫レベルサービス |
| inventory-level.ts | `packages/modules/inventory/src/models/inventory-level.ts` | ソース | 在庫レベルエンティティ |
| inventory-item.ts | `packages/modules/inventory/src/models/inventory-item.ts` | ソース | 親エンティティ |
