通知 API（Notification API）

Notification API を使用すると、eBay 通知エクスペリエンス全体を管理できます。通知トピックの参照、宛先エンドポイントの作成・管理、サブスクリプションの構成・テスト、およびメッセージペイロードの整合性確認をサポートします。

バージョン: v1.6.2

ベースURL: https://api.ebay.com/commerce/notification/v1

認証（OAuth スコープ）

Client Credentials スコープ:

Authorization Code スコープ:

リソース一覧

Notification API は以下の 7 リソース、合計 21 エンドポイントで構成されています。

config — アプリケーション構成（2 エンドポイント）

GET /config

getConfig — 以前に作成された構成を取得します。

レスポンス: 200 → Config / 404 / 500

PUT /config

updateConfig — 新しい構成を作成または既存の構成を更新します。アラート設定が可能です。

リクエストボディ: Config

レスポンス: 204 / 400 / 500

destination — 宛先管理（5 エンドポイント）

GET /destination

getDestinations — 宛先リソースのページ分けされたコレクションを取得します。

レスポンス: 200 → DestinationSearchResponse / 400 / 500

POST /destination

createDestination — HTTP プッシュ通知を受信する宛先エンドポイントを作成します。エンドポイントは challengeResponse で応答する準備が必要です。

リクエストボディ: DestinationRequest

レスポンス: 201 / 400 / 409 / 500

GET /destination/{destination_id}

getDestination — 特定の宛先の詳細を取得します。

レスポンス: 200 → Destination / 400 / 404 / 500

PUT /destination/{destination_id}

updateDestination — 宛先を更新します。

リクエストボディ: DestinationRequest

レスポンス: 204 / 400 / 404 / 409 / 500

DELETE /destination/{destination_id}

deleteDestination — 宛先を削除します。アクティブな宛先は削除できません。サブスクリプションを無効にしてから削除してください。

レスポンス: 204 / 400 / 404 / 409 / 500

public_key — 公開キー取得（1 エンドポイント）

GET /public_key/{public_key_id}

getPublicKey — 通知の処理と検証に使用する公開キーを取得します。キー ID は通知の X-EBAY-SIGNATURE ヘッダーから取得されます。

重要: 取得した公開キーは一時的にキャッシュしてください（推奨: 1 時間）。通知ごとにリクエストすると API 呼び出し制限を超える可能性があります。

レスポンス: 200 → PublicKey / 400 / 404 / 500

subscription — サブスクリプション管理（5 エンドポイント）

GET /subscription

getSubscriptions — すべてのサブスクリプションのページ分けされたリストを取得します。

レスポンス: 200 → SubscriptionSearchResponse / 400 / 500

POST /subscription

createSubscription — トピックとスキーマバージョンのサブスクリプションを作成します。無効モードで作成し、テスト後に有効化できます。

リクエストボディ: CreateSubscriptionRequest

レスポンス: 201 / 400 / 403 / 409 / 500

GET /subscription/{subscription_id}

getSubscription — 指定されたサブスクリプションの詳細を取得します。

レスポンス: 200 → Subscription / 400 / 404 / 500

PUT /subscription/{subscription_id}

updateSubscription — サブスクリプションを更新します。

リクエストボディ: UpdateSubscriptionRequest

レスポンス: 204 / 400 / 404 / 409 / 500

DELETE /subscription/{subscription_id}

deleteSubscription — サブスクリプションを削除します（ステータスに関係なく削除可能）。

レスポンス: 204 / 400 / 404 / 500

subscription — 有効化/無効化（2 エンドポイント）

POST /subscription/{subscription_id}/disable

disableSubscription — サブスクリプションを無効にし、通知の配信を停止します。

レスポンス: 204 / 400 / 404 / 500

POST /subscription/{subscription_id}/enable

enableSubscription — 無効なサブスクリプションを有効にします。

レスポンス: 204 / 400 / 404 / 409 / 500

subscription filter — フィルター管理（3 エンドポイント）

POST /subscription/{subscription_id}/filter

createSubscriptionFilter — サブスクリプションのフィルターを作成します。指定した基準に一致する通知のみが配信されます。フィルターは JSON Schema（バージョン 2020-12 以降）で定義します。作成直後は PENDING ステータスで、確認後に ENABLED に移行します。

リクエストボディ: CreateSubscriptionFilterRequest

レスポンス: 201 / 400 / 403 / 404 / 500

GET /subscription/{subscription_id}/filter/{filter_id}

getSubscriptionFilter — 指定されたサブスクリプションフィルターの詳細を取得します。

レスポンス: 200 → SubscriptionFilter / 400 / 403 / 404 / 500

DELETE /subscription/{subscription_id}/filter/{filter_id}

deleteSubscriptionFilter — アクティブなフィルターを無効にします。PENDING ステータスのフィルターは無効にできません。

レスポンス: 204 / 400 / 403 / 404 / 500

subscription test — テスト（1 エンドポイント）

POST /subscription/{subscription_id}/test

testSubscription — モックテストペイロードをトリガーし、サブスクリプションをエンドツーエンドでテストします。テストペイロードと実際のペイロードを区別するには notificationId を使用します。

レスポンス: 202 / 400 / 404 / 500

topic — トピック参照（2 エンドポイント）

GET /topic

getTopics — サポートされているすべての通知トピックのページ分けされたコレクションを返します。スキーマバージョン、形式、メタデータを含みます。

レスポンス: 200 → TopicSearchResponse / 400 / 500

GET /topic/{topic_id}

getTopic — 指定されたトピックの詳細を取得します。

レスポンス: 200 → Topic / 400 / 404 / 500

スキーマ定義（全 18 スキーマ）

構成

Config

宛先

Destination

DestinationRequest

DeliveryConfig

DestinationSearchResponse

公開キー

PublicKey

サブスクリプション

Subscription

CreateSubscriptionRequest

UpdateSubscriptionRequest

SubscriptionPayloadDetail

SubscriptionSearchResponse

フィルター

CreateSubscriptionFilterRequest

SubscriptionFilter

トピック

Topic

PayloadDetail

TopicSearchResponse

共通スキーマ

Error

ErrorParameter

エンドポイント一覧（全 21 エンドポイント）