チャリティー API（Charity API）
Charity API を使用すると、サードパーティの開発者はサポートされている慈善団体の詳細を検索してアクセスできます。キーワード検索、登録 ID 検索、および個別の慈善団体の詳細取得をサポートします。
バージョン: v1.2.1
ベースURL: https://api.ebay.com/commerce/charity/v1
認証（OAuth スコープ）
この API は クライアント資格情報（Client Credentials） フローを使用します。ユーザー認証は不要で、アプリケーショントークンのみで呼び出し可能です。
| スコープ |
説明 |
https://api.ebay.com/oauth/api_scope |
eBay の公開データを表示 |
リソース一覧
Charity API は以下の 1 リソース、合計 2 エンドポイント（すべて GET）で構成されています。
charity_org — 慈善団体（2 エンドポイント）
GET /charity_org
getCharityOrgs — サポートされている慈善団体を検索します。キーワードまたは登録 ID で検索でき、ページ分けされた検索結果を返します。
| パラメータ | 場所 | 必須 | 説明 |
|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。有効な値: EBAY_GB、EBAY_US |
q | クエリ | 条件付 | 名前、ミッションステートメント、または説明内のキーワードに一致するクエリ文字列。registration_ids と同時使用不可。 |
registration_ids | クエリ | 条件付 | 慈善団体登録 ID のカンマ区切りリスト。最大 20 件。q と同時使用不可。 |
limit | クエリ | 任意 | 1 ページに返されるアイテム数。有効な値: 1〜100、デフォルト: 20 |
offset | クエリ | 任意 | スキップするアイテム数。有効な値: 0〜10,000、デフォルト: 0 |
レスポンス: 200 → CharitySearchResponse / 400 / 500
GET /charity_org/{charity_org_id}
getCharityOrg — 慈善団体 ID を使用して、サポート対象の慈善団体に関する詳細情報を取得します。
| パラメータ | 場所 | 必須 | 説明 |
|---|
charity_org_id | パス | 必須 | 慈善団体の一意の ID |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。有効な値: EBAY_GB、EBAY_US |
レスポンス: 200 → CharityOrg / 400 / 404 / 500
スキーマ定義（全 8 スキーマ）
慈善団体
CharityOrg
| フィールド | 型 | 説明 |
|---|
charityOrgId | string | 慈善団体の一意の ID |
name | string | 慈善団体名 |
description | string | 説明 |
missionStatement | string | ミッションステートメント |
registrationId | string | 登録 ID |
website | string | ウェブサイト URL |
logoImage | Image | ロゴ画像 |
location | Location | 所在地 |
CharitySearchResponse
| フィールド | 型 | 説明 |
|---|
charityOrgs | array[CharityOrg] | 慈善団体の配列 |
href | string | 現在の結果セットの URI |
limit | integer | 1 ページの最大件数 |
next | string | 次ページの URI |
offset | integer | オフセット |
prev | string | 前ページの URI |
total | integer | 一致する慈善団体の総数 |
位置情報
Location
| フィールド | 型 | 説明 |
|---|
address | Address | 住所 |
geoCoordinates | GeoCoordinates | 地理座標 |
Address
| フィールド | 型 | 説明 |
|---|
city | string | 市区町村 |
stateOrProvince | string | 都道府県/州 |
postalCode | string | 郵便番号 |
country | string | 国コード |
GeoCoordinates
| フィールド | 型 | 説明 |
|---|
latitude | number | 緯度 |
longitude | number | 経度 |
共通スキーマ
Image
| フィールド | 型 | 説明 |
|---|
imageUrl | string | 画像の URL |
height | integer | 画像の高さ（ピクセル） |
width | integer | 画像の幅（ピクセル） |
Error
| フィールド | 型 | 説明 |
|---|
category | string | エラーカテゴリ |
domain | string | エラードメイン |
errorId | integer | エラー ID |
message | string | 短いメッセージ |
longMessage | string | 詳細メッセージ |
inputRefIds | array[string] | 入力参照 ID |
outputRefIds | array[string] | 出力参照 ID |
parameters | array[ErrorParameter] | エラーパラメータ |
subdomain | string | エラーサブドメイン |
ErrorParameter
| フィールド | 型 | 説明 |
|---|
name | string | パラメータ名 |
value | string | パラメータ値 |
エンドポイント一覧（全 2 エンドポイント）
| メソッド |
エンドポイント |
operationId |
説明 |
| GET | /charity_org | getCharityOrgs | 慈善団体を検索 |
| GET | /charity_org/{charity_org_id} | getCharityOrg | 慈善団体の詳細を取得 |
