Skip to main content
マーチャント通知 —— 新規注文、新規サブスクリプション、更新、キャンセル、支払い遅延 —— はストアに設定された受信者へ配信されます。各受信者は独自のアドレスと独自のイベント別購読トグルを持つため、同じストアの 2 人が別々のイベントを購読できます。受信者が 1 件も設定されていない場合、そのストアはマーチャント通知を一切送信しません —— フォールバック先のアドレスはありません。

イベントカタログ

上記 10 個のトグルはすべて受信者ごとです —— notifySubscriptionPlanChanged と notifyChargeback も含みます。同じストアの 2 人が別々のイベントを購読でき、update-recipient は 10 キーのいずれも受け付けます。10 個のうち 9 個は既定でオンです。notifyChargeback だけが例外で既定はオフであり、そのフラグが明示的に true の受信者だけがチャージバックメールを受け取ります。保存済みの受信者にキーが無い場合は既定値として読み出されるため、送信を省略してもチャージバックメールがオンになることはありません。配信先アドレスは受信者リストに従います:マーチャント通知は設定された受信者へ送られ、supportEmail へは送られません。リストが空の間は何も送信されず、別のアドレスに差し替えられることもありません。

制限

各ストアの受信者は最大 5 件です。上限を超えると 400 を返します。下限はなく、空のリストはそのまま無音を意味します:すべて削除すると、そのストアはマーチャント通知を一切送信しなくなります(次節参照)。消費者向けのトランザクションメール(注文レシート、サブスクリプション確認)は別系統であり、影響を受けません。

プライマリ受信者

新規ストアには受信者が 1 件シードされます —— マーチャントのアカウントメール —— で、isPrimary: true が付きます。このフラグは出自を示すだけです:この行に特権はなく、他の受信者と同じ挙動で、同じように削除できます。また update-store のストアレベル notify* 互換書き込みがミラーされる行でもあります。 プライマリを含めて受信者をすべて削除することは許容されます:以降そのストアはマーチャント通知を送信せず、代わりのエントリが合成されることもありません。アドレスを追加すれば配信が再開します。

環境

受信者は環境で分かれません。リクエストは従来どおり X-Environment を付けて構いませんが、受信者の読み書きのフィルタや加工には使われません —— 同じストアは test でも prod でも同じリストを返します。

受信者の一覧取得

list-recipients エンドポイントはありません —— 受信者リストの取得は GraphQL のトップレベルクエリ storeNotificationRecipients を使います。ストアに受信者がいない場合、このクエリは [] を返します:

エンドポイント

受信者を追加

マーチャント通知を受け取るアドレスを追加します。

受信者を更新

受信者が購読するイベントを変更します。

受信者を削除

リストから受信者を削除します。