# 通知設計書 23-Order Delivery State (Returned Partially)

## 概要

本ドキュメントは、Shopwareの注文配送ステータスが「一部返品済み（Returned Partially）」に変更された際に送信されるメール通知の設計書である。

### 本通知の処理概要

本通知は、顧客が注文した商品のうち一部が返品された際に、配送ステータスの変更を顧客に通知するメール送信機能を提供する。

**業務上の目的・背景**：ECサイトにおいて、顧客が注文の一部商品のみを返品する場合がある。このような部分返品処理が完了した際に顧客へ通知することで、どの商品が返品処理されたかを確認してもらい、残りの商品については引き続き保持していることを認識してもらう。また、部分返金処理などの後続処理への期待を設定する。

**通知の送信タイミング**：注文配送（OrderDelivery）エンティティのステートマシンにおいて、配送ステータスが`returned_partially`に遷移した時点でイベント`state_enter.order_delivery.state.returned_partially`が発火し、Flowによってメール送信がトリガーされる。

**通知の受信者**：注文を行った顧客（OrderCustomer）のメールアドレス宛に送信される。顧客の氏名・敬称情報も取得し、パーソナライズされた宛名で送信する。

**通知内容の概要**：配送ステータスの変更通知として、注文番号、注文日時、新しい配送ステータス名（Returned Partially/一部返品済み）、および注文詳細確認用のディープリンクURLが含まれる。アクセシビリティ対応のHTMLドキュメントがある場合はそのリンクも含まれる。

**期待されるアクション**：顧客は通知を受け取り、一部商品の返品処理が完了したことを認識する。必要に応じて提供されたリンクから注文詳細を確認し、返品された商品と残りの商品を確認する。部分返金の状況も追跡する。

## 通知種別

メール通知

## 送信仕様

### 基本情報

| 項目 | 内容 |
|-----|------|
| 送信方式 | 非同期（Flow経由） |
| 優先度 | 中 |
| リトライ | Flowの設定に依存 |

### 送信先決定ロジック

`OrderStateMachineStateChangeEvent`クラスの`getMailStruct()`メソッドにより、注文に紐づく顧客（`order.orderCustomer`）のメールアドレスと氏名を取得して送信先とする。

## 通知テンプレート

### メール通知の場合

| 項目 | 内容 |
|-----|------|
| 送信元アドレス | SalesChannelの設定による |
| 送信元名称 | SalesChannelの設定による |
| 件名 | テンプレートで定義（デフォルト: 配送ステータス変更通知） |
| 形式 | HTML/テキスト両対応 |

### 本文テンプレート

```twig
{% if order.orderCustomer.salutation %}{{ order.orderCustomer.salutation.translated.letterName ~ ' ' }}{% endif %}{{ order.orderCustomer.firstName }} {{ order.orderCustomer.lastName }},

the status of your delivery at {{ salesChannel.translated.name }} (Number: {{ order.orderNumber }}) on {{ order.orderDateTime|format_datetime('medium', 'short', locale='en-GB') }} has changed.
The new status is as follows: {{ order.deliveries.first.stateMachineState.translated.name }}.

You can check the current status of your order on our website under "My account" - "My orders" anytime: {{ rawUrl('frontend.account.order.single.page', { 'deepLinkCode': order.deepLinkCode }, salesChannel.domains|first.url) }}
However, in case you have purchased without a registration or a customer account, you do not have this option.

{% if a11yDocuments %}
For better accessibility we also provide an HTML version of the documents here:
{% for a11y in a11yDocuments %}
- {{ rawUrl('frontend.account.order.single.document.a11y', {...}, salesChannel.domains|first.url) }}
{% endfor %}
{% endif %}
```

### 添付ファイル

| ファイル名 | 形式 | 条件 | 説明 |
|----------|------|------|------|
| - | - | - | 基本的に添付ファイルなし（Flowで設定可能） |

## テンプレート変数

| 変数名 | 説明 | データ取得元 | 必須 |
|--------|------|-------------|-----|
| order | 注文エンティティ | order テーブル | Yes |
| order.orderCustomer | 注文顧客情報 | order_customer テーブル | Yes |
| order.orderNumber | 注文番号 | order.order_number | Yes |
| order.orderDateTime | 注文日時 | order.order_date_time | Yes |
| order.deliveries | 配送情報コレクション | order_delivery テーブル | Yes |
| order.deliveries.first.stateMachineState | 配送ステータス | state_machine_state テーブル | Yes |
| order.deepLinkCode | ディープリンクコード | order.deep_link_code | Yes |
| salesChannel | 販売チャネル情報 | sales_channel テーブル | Yes |
| a11yDocuments | アクセシビリティドキュメント | コンテキストから | No |

## 送信トリガー・条件

### トリガー一覧

| トリガー種別 | トリガーイベント | 送信条件 | 説明 |
|------------|----------------|---------|------|
| ステートマシン遷移 | state_enter.order_delivery.state.returned_partially | Flowで設定 | 配送ステータスがreturned_partiallyに変更された時 |

### 送信抑止条件

| 条件 | 説明 |
|-----|------|
| Flowが無効 | 対応するFlowアクションが無効化されている場合 |
| メールテンプレート未設定 | テンプレートIDが設定されていない場合 |
| 受信者メールアドレスなし | 顧客のメールアドレスが取得できない場合 |

## 処理フロー

### 送信フロー

```mermaid
flowchart TD
    A[配送ステータス変更トリガー] --> B[StateMachineRegistry::transition]
    B --> C[StateMachineStateChangeEvent発火]
    C --> D[OrderStateChangeEventListener::onOrderDeliveryStateChange]
    D --> E[OrderStateMachineStateChangeEvent発火]
    E --> F[Flow処理開始]
    F --> G[SendMailAction::handleFlow]
    G --> H{メールテンプレート存在?}
    H -->|Yes| I[テンプレート展開]
    H -->|No| J[処理終了]
    I --> K[AbstractMailService::send]
    K --> L{送信結果}
    L -->|成功| M[送信完了]
    L -->|失敗| N[エラーログ記録]
    M --> O[終了]
    N --> O
    J --> O
```

## データベース参照・更新仕様

### 参照テーブル一覧

| テーブル名 | 用途 | 備考 |
|-----------|------|------|
| order | 注文情報取得 | |
| order_customer | 顧客情報取得 | メール宛先 |
| order_delivery | 配送情報取得 | ステータス確認 |
| state_machine_state | ステータス名取得 | 多言語対応 |
| sales_channel | 販売チャネル情報 | 送信元情報 |
| mail_template | メールテンプレート | 本文・件名 |

### テーブル別参照項目詳細

#### order

| 参照項目（カラム名） | 用途 | 取得条件 |
|-------------------|------|---------|
| id | 注文識別 | deliveryのorder_id経由 |
| order_number | 注文番号表示 | |
| order_date_time | 注文日時表示 | |
| deep_link_code | 詳細ページリンク | |
| sales_channel_id | 販売チャネル特定 | |

### 更新テーブル一覧

| テーブル名 | 操作 | 概要 |
|-----------|------|------|
| state_machine_history | INSERT | ステータス遷移履歴 |

#### 送信ログテーブル

| 操作 | 項目（カラム名） | 更新値 | 備考 |
|-----|-----------------|-------|------|
| INSERT | entity_name | 'order_delivery' | StateMachineRegistryで記録 |
| INSERT | from_state_id | 遷移前ステータスID | |
| INSERT | to_state_id | 遷移後ステータスID | |
| INSERT | transition_action_name | 'return_partially' | |

## エラー処理

### エラーケース一覧

| エラー種別 | 発生条件 | 対処方法 |
|----------|---------|---------|
| 送信失敗 | SMTPエラー等 | ログ記録、リトライはFlow設定依存 |
| テンプレートエラー | Twig構文エラー | ログ記録、送信中断 |
| 宛先不正 | メールアドレス形式不正 | MailEventConfigurationException |

### リトライ仕様

| 項目 | 内容 |
|-----|------|
| リトライ回数 | Flowの遅延アクション設定に依存 |
| リトライ間隔 | Flowの遅延アクション設定に依存 |
| リトライ対象エラー | 一時的な送信失敗 |

## 配信設定

### レート制限

| 項目 | 内容 |
|-----|------|
| 1分あたり上限 | システム設定に依存 |
| 1日あたり上限 | システム設定に依存 |

### 配信時間帯

特に制限なし（イベント発生時に即時送信）

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

- 顧客のメールアドレス、氏名等の個人情報を扱うため、適切なアクセス制御が必要
- ディープリンクコードにより、ログインなしで注文詳細にアクセス可能なため、URLの漏洩に注意
- テンプレート内でのTwig変数は自動エスケープされる

## 備考

- メールテンプレートタイプ: `order_delivery.state.returned_partially`
- MailTemplateTypes定数: `MAILTYPE_STATE_ENTER_ORDER_DELIVERY_STATE_RETURNED_PARTIALLY`
- アクセシビリティ対応のHTMLドキュメント（a11yDocuments）が利用可能な場合、リンクが含まれる
- 一部返品処理完了後、通常は一部返金処理（order_transaction.state.refunded_partially）が後続する

---

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

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

### 推奨読解順序

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

まず、配送ステータスの定義とメールテンプレートタイプを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 1-1 | OrderDeliveryStates.php | `src/Core/Checkout/Order/Aggregate/OrderDelivery/OrderDeliveryStates.php` | 配送ステータスの定数定義（STATE_PARTIALLY_RETURNED = 'returned_partially'、行15） |
| 1-2 | MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | メールテンプレートタイプ定数（行60: MAILTYPE_STATE_ENTER_ORDER_DELIVERY_STATE_RETURNED_PARTIALLY） |

**読解のコツ**: 一部返品（returned_partially）は完全返品（returned）とは区別される。部分返品の場合、残りの商品は引き続き顧客の手元に残る。

#### Step 2: エントリーポイントを理解する

ステートマシン遷移時のイベント発火の仕組みを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 2-1 | StateMachineRegistry.php | `src/Core/System/StateMachine/StateMachineRegistry.php` | transition()メソッド（行113-216）でステータス遷移とイベント発火 |
| 2-2 | StateMachineStateChangeEvent.php | `src/Core/System/StateMachine/Event/StateMachineStateChangeEvent.php` | イベントクラスの構造、getStateEventName()（行44-47）でイベント名生成 |

**主要処理フロー**:
1. **行113-116**: transition()メソッド開始、システムスコープで実行
2. **行136-151**: 遷移先ステートの取得
3. **行153-165**: ステートマシン履歴の記録
4. **行167-169**: エンティティのステート更新
5. **行181-193**: STATE_MACHINE_TRANSITION_SIDE_LEAVE イベント発火
6. **行195-207**: STATE_MACHINE_TRANSITION_SIDE_ENTER イベント発火

#### Step 3: イベントリスナーを理解する

注文配送固有のイベント処理を理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 3-1 | OrderStateChangeEventListener.php | `src/Core/Checkout/Order/Listener/OrderStateChangeEventListener.php` | onOrderDeliveryStateChange()（行61-77）で配送ステータス変更をハンドリング |
| 3-2 | OrderStateMachineStateChangeEvent.php | `src/Core/Checkout/Order/Event/OrderStateMachineStateChangeEvent.php` | メール送信用のイベントクラス、MailAware実装 |

**主要処理フロー**:
- **行61-77**: onOrderDeliveryStateChange() - 配送エンティティから注文を取得し、OrderStateMachineStateChangeEventを発火
- **行157-162**: dispatchEvent() - 実際のイベントディスパッチ

#### Step 4: メール送信処理を理解する

Flowによるメール送信の仕組みを理解する。

| 順序 | ファイル | パス | 読解ポイント |
|-----|---------|------|-------------|
| 4-1 | SendMailAction.php | `src/Core/Content/Flow/Dispatching/Action/SendMailAction.php` | handleFlow()（行86-176）でメール送信処理を実行 |

**主要処理フロー**:
- **行86-96**: 設定の取得とスキップ判定
- **行100-111**: MailAwareデータの検証
- **行113-117**: メールテンプレートの取得
- **行126-134**: 受信者の決定
- **行136-155**: メールデータの構築
- **行175**: 実際のメール送信

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

```
管理画面 / API Controller / バッチ処理
    │
    └─ StateMachineRegistry::transition()
           │
           ├─ StateMachineStateChangeEvent 発火
           │      └─ OrderStateChangeEventListener::onOrderDeliveryStateChange()
           │             └─ OrderStateMachineStateChangeEvent 発火
           │                    └─ Flow Dispatcher
           │                           └─ SendMailAction::handleFlow()
           │                                  └─ AbstractMailService::send()
           │
           └─ StateMachineHistoryRepository::create() [履歴記録]
```

### データフロー図

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

OrderDelivery     ───▶  StateMachineRegistry          ───▶  state_machine_history
(stateId変更)            │                                   (遷移履歴INSERT)
                         ├─ transition()
                         │
                         ▼
                    StateMachineStateChangeEvent
                         │
                         ▼
                    OrderStateChangeEventListener
                         │
                         ├─ Order取得
                         │
                         ▼
                    OrderStateMachineStateChangeEvent  ───▶  メール送信
                         │                                   (顧客宛)
                         ▼
                    Flow / SendMailAction
                         │
                         ▼
                    AbstractMailService::send()
```

### 関連ファイル一覧

| ファイル | パス | 種別 | 役割 |
|---------|------|------|------|
| OrderDeliveryStates.php | `src/Core/Checkout/Order/Aggregate/OrderDelivery/OrderDeliveryStates.php` | ソース | 配送ステータス定数定義 |
| MailTemplateTypes.php | `src/Core/Content/MailTemplate/MailTemplateTypes.php` | ソース | メールテンプレートタイプ定数 |
| StateMachineRegistry.php | `src/Core/System/StateMachine/StateMachineRegistry.php` | ソース | ステートマシン遷移処理 |
| StateMachineStateChangeEvent.php | `src/Core/System/StateMachine/Event/StateMachineStateChangeEvent.php` | ソース | ステート変更イベント |
| OrderStateChangeEventListener.php | `src/Core/Checkout/Order/Listener/OrderStateChangeEventListener.php` | ソース | 注文ステート変更リスナー |
| OrderStateMachineStateChangeEvent.php | `src/Core/Checkout/Order/Event/OrderStateMachineStateChangeEvent.php` | ソース | 注文ステートマシンイベント |
| SendMailAction.php | `src/Core/Content/Flow/Dispatching/Action/SendMailAction.php` | ソース | メール送信アクション |
| en-html.html.twig | `src/Core/Migration/Fixtures/mails/order_delivery.state.returned_partially/en-html.html.twig` | テンプレート | 英語HTMLテンプレート |
| en-plain.html.twig | `src/Core/Migration/Fixtures/mails/order_delivery.state.returned_partially/en-plain.html.twig` | テンプレート | 英語プレーンテンプレート |
| de-html.html.twig | `src/Core/Migration/Fixtures/mails/order_delivery.state.returned_partially/de-html.html.twig` | テンプレート | ドイツ語HTMLテンプレート |
| de-plain.html.twig | `src/Core/Migration/Fixtures/mails/order_delivery.state.returned_partially/de-plain.html.twig` | テンプレート | ドイツ語プレーンテンプレート |
