コンテンツにスキップ

Vendure プラグイン実装ガイド（目次）

このセクションでは、B2B要件に対応するVendureカスタムプラグインの実装方針と仕様をまとめます。

Vendureの基礎知識が必要な場合: プラグイン開発の前に、Vendure開発ハンドブックでアーキテクチャやコアコンセプトを理解することを推奨します。

プラグイン開発ガイド

プラグイン開発の基礎

プラグインの実装手順とベストプラクティス。@VendurePluginデコレーター、8ステップ実装ガイド、CLIコマンド（npx vendure add）、マイグレーション管理、ライフサイクルフック。

  • 対象者: 既存チームメンバー（Vendure基礎知識あり）
  • 内容: 実装手順、コード例、ディレクトリ構造
  • 目的: 「どう作るか」の実践的ガイド

プラグイン概要と設計方針

アーキテクチャパターン、設計原則、データモデル設計、統合パターン、パフォーマンス最適化、セキュリティベストプラクティス。

  • 対象者: アーキテクト、上級開発者
  • 内容: 設計原則、パターン、ベストプラクティス
  • 目的: 「なぜこう設計するか」の方針

Vendure機能リファレンス

API開発ツール

カスタムプラグイン

概要・設計方針

  • プラグイン概要と設計方針 - アーキテクチャパターン、設計原則、データモデル設計、統合パターン、パフォーマンス最適化、セキュリティベストプラクティス

コアビジネスロジック

顧客管理プラグイン

15種類の顧客ステータス管理と33カテゴリの商品アクセス制御を実現。階層的権限管理、ステータス変更履歴、一括ステータス更新機能を提供。

顧客拡張プラグイン

Shop API でログイン中の顧客自身に関する情報（顧客階層など）を提供する統合プラグイン。

顧客可視性プラグイン

顧客・顧客グループ・グローバルのスコープで、商品やキャンペーンなどの可視性を制御するプラグイン。リソースセット/サブジェクトセット/ポリシーを管理し、Shop API の可視性付きクエリを提供。

価格システムプラグイン

顧客別掛率（割引率）管理、月次割戻金計算（エクスビアンス商品）、段階的特別掛率適用、「特に安価な顧客」判定ロジックを実装。

配送計算プラグイン

ブランド別配送料金計算、直送モード（+10%サーチャージ）、配送ゾーン別料金設定、無料配送閾値管理、特別取り扱い料金に対応。

セット商品プラグイン

セット商品（顧客にはセットとして見せ、内部/SMILE 連携では構成品に分解して扱う）を実現するプラグイン。構成品数量の合算による在庫/購入制限判定にも対応。

キャンペーンエンジンプラグイン

6種類の複雑なキャンペーンタイプをサポート：購入金額ベースギフト、購入数量ベース割引・ギフト、複雑な条件判定、複数カテゴリ選択型、ハイブリッドキャンペーン。

ポイント・ギフト券・クーポンプラグイン

ギフト券コード登録によるポイント加算、ポイント残高/履歴取得、クーポン割引の仮想商品出力を提供。

サポート機能

在庫管理プラグイン

在庫予約システム（カート投入時の一時予約）、バックオーダー対応、複雑な数量制御ルール（最小/最大購入数、購入単位制限）、在庫有り/無し商品の混在注文対応。

同意システムプラグイン

グリコール酸・iMESO等の特定商品購入時の同意記録、法的保持期間管理（7年間）、デジタル署名対応、同意の有効性検証、GraphQL API提供。

決済方法ハンドラー

売掛決済、代引き決済、銀行振込/前入金の決済方法ハンドラーを実装。代引き手数料の自動計算・加算、請求書PDF自動発行（将来実装予定）、Vendure Dashboard上での設定管理に対応。

SMILE連携プラグイン

会計システム「SMILE V2」との連携。注文データ・顧客データのCSV出力（SHIFT_JIS対応）、納品先自動採番管理、バッチ処理、エラー追跡・復旧機能。連携要件とAPI仕様もこのページに統合済み。

お気に入りプラグイン

商品お気に入り登録・削除、お気に入り商品一覧取得、お気に入り状態確認機能を提供するシンプルなプラグイン。

購入共起レコメンドプラグイン

注文内の同時購入データから関連商品を自動抽出し、Shop API でレコメンドを取得できるプラグイン。

Customer Password Admin

管理者が顧客パスワードを再設定できる Admin API を提供。履歴記録とメール通知のトリガーまでを担う。

メールテンプレート運用

Vendure EmailPlugin のテンプレート構成、言語別テンプレートの運用、件名とプレビューの整合ルールをまとめる。

Dashboard運用拡張プラグイン

React Dashboard のアクションバー拡張を統合し、注文CSV・商品バリアントCSVのダウンロードを提供。SMILE連携と商品バリアント公開クエリを再利用し、権限に基づくボタン表示制御を実装。

Shop Product Variants プラグイン

Shop API に productVariants クエリを追加し、商品バリアント一覧を取得可能にするプラグイン。

セキュリティログプラグイン

顧客のログイン試行を詳細に記録し、不正アクセスの検知やカスタマーサポートの迅速化を実現。AES-256-GCM 暗号化、IP位置情報特定、ログイン失敗時のメール通知機能を提供。

Payment Eligibility Checkers

顧客ステータス、注文金額、直送フラグなどに応じて決済可否を判定するチェッカー群。

最新の設計は /docs/02-design/、運用・展開は /docs/03-implementation/infrastructure/ を参照してください。