Account v1 API ドキュメント
アカウント v1 API(Account v1 API)
Account v1 API を使用すると、セラーは eBay セラーアカウントの設定を管理できます。ビジネスポリシー(フルフィルメント、支払い、返品ポリシー)の管理、カスタムポリシーの作成、セラープログラムのオプトイン/オプトアウト、売上税テーブルの設定、アカウント情報の取得が含まれます。
バージョン: v1.9.3
ベースURL: https://api.ebay.com/sell/account/v1
認証(OAuth スコープ)
この API は 認可コード(Authorization Code) フローを使用します。
| スコープ | 説明 |
|---|---|
https://api.ebay.com/oauth/api_scope/sell.account | アカウント設定の表示と管理 |
https://api.ebay.com/oauth/api_scope/sell.account.readonly | アカウント設定の表示 |
リソース一覧
Account v1 API は以下のリソース、合計 37 エンドポイントで構成されています。
| リソース | 説明 | 数 |
|---|---|---|
| advertising_eligibility | 広告プログラムの適格性確認 | 1 |
| custom_policy | カスタムポリシーの管理 | 4 |
| fulfillment_policy | フルフィルメントポリシーの管理 | 6 |
| kyc | KYC オンボーディング状況 | 1 |
| payment_policy | 支払いポリシーの管理 | 6 |
| payments_program | 支払いプログラムのステータス | 2 |
| privilege | セラー権限の取得 | 1 |
| program | セラープログラムのオプトイン/オプトアウト | 3 |
| rate_table | 配送料率表の取得 | 1 |
| return_policy | 返品ポリシーの管理 | 6 |
| sales_tax | 売上税テーブルの管理 | 5 |
| subscription | サブスクリプションの取得 | 1 |
advertising_eligibility(1 エンドポイント)
GET /advertising_eligibility
getAdvertisingEligibility — eBay 広告プログラムに対する販売者の適格性ステータスを確認します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | eBay マーケットプレイス ID。 |
program_types | クエリ | 任意 | 広告プログラムのカンマ区切りリスト。 |
レスポンス: 200 / 400 / 500
custom_policy — カスタムポリシー(4 エンドポイント)
GET /custom_policy/
getCustomPolicies — 販売者のカスタムポリシーリストを取得します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
policy_types | クエリ | 任意 | カスタムポリシーのタイプ(カンマ区切り)。 |
レスポンス: 200 / 400 / 500
POST /custom_policy/
createCustomPolicy — 新しいカスタムポリシーを作成します。タイプ: PRODUCT_COMPLIANCE(最大 60 個)、TAKE_BACK(最大 18 個)。
レスポンス: 201 / 400 / 409 / 500
GET /custom_policy/{custom_policy_id}
getCustomPolicy — 特定のカスタムポリシーを取得します。
レスポンス: 200 / 400 / 404 / 500
PUT /custom_policy/{custom_policy_id}
updateCustomPolicy — カスタムポリシーを更新します。name、label、description フィールドを常に含めてください。
レスポンス: 204 / 400 / 404 / 409 / 500
fulfillment_policy — フルフィルメントポリシー(6 エンドポイント)
GET /fulfillment_policy
getFulfillmentPolicies — 指定マーケットプレイスのすべてのフルフィルメントポリシーを取得。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | クエリ | 必須 | eBay マーケットプレイス ID。 |
Content-Language | ヘッダー | 任意 | マルチロケール対応(例: fr-CA)。 |
レスポンス: 200 / 400 / 500
POST /fulfillment_policy/
createFulfillmentPolicy — 新しいフルフィルメントポリシーを作成します。
レスポンス: 201 / 400 / 500
GET /fulfillment_policy/get_by_policy_name
getFulfillmentPolicyByName — ポリシー名でフルフィルメントポリシーを取得します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | クエリ | 必須 | eBay マーケットプレイス ID。 |
name | クエリ | 必須 | ポリシー名。 |
Content-Language | ヘッダー | 任意 | マルチロケール対応。 |
レスポンス: 200 / 400 / 500
GET /fulfillment_policy/{fulfillmentPolicyId}
getFulfillmentPolicy — 特定のフルフィルメントポリシーの詳細を取得します。
レスポンス: 200 / 400 / 404 / 500
PUT /fulfillment_policy/{fulfillmentPolicyId}
updateFulfillmentPolicy — フルフィルメントポリシーを更新します。完全なペイロードが必要です。
レスポンス: 200 / 400 / 404 / 500
DELETE /fulfillment_policy/{fulfillmentPolicyId}
deleteFulfillmentPolicy — フルフィルメントポリシーを削除します。
レスポンス: 204 / 400 / 404 / 409 / 500
kyc(1 エンドポイント)
GET /kyc
getKYC — KYC オンボーディング要件の確認。現在は全セラーがオンボーディング済みのため、204 No Content を返します。
レスポンス: 200 / 204 / 400 / 500
payment_policy — 支払いポリシー(6 エンドポイント)
GET /payment_policy
getPaymentPolicies — 指定マーケットプレイスのすべての支払いポリシーを取得。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | クエリ | 必須 | eBay マーケットプレイス ID。 |
Content-Language | ヘッダー | 任意 | マルチロケール対応。 |
レスポンス: 200 / 400 / 500
POST /payment_policy
createPaymentPolicy — 新しい支払いポリシーを作成します。
レスポンス: 201 / 400 / 500
GET /payment_policy/get_by_policy_name
getPaymentPolicyByName — ポリシー名で支払いポリシーを取得します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | クエリ | 必須 | eBay マーケットプレイス ID。 |
name | クエリ | 必須 | ポリシー名。 |
Content-Language | ヘッダー | 任意 | マルチロケール対応。 |
レスポンス: 200 / 400 / 500
GET /payment_policy/{payment_policy_id}
getPaymentPolicy — 特定の支払いポリシーの詳細を取得します。
レスポンス: 200 / 400 / 404 / 500
PUT /payment_policy/{payment_policy_id}
updatePaymentPolicy — 支払いポリシーを更新します。完全なペイロードが必要です。
レスポンス: 200 / 400 / 404 / 500
DELETE /payment_policy/{payment_policy_id}
deletePaymentPolicy — 支払いポリシーを削除します。
レスポンス: 204 / 400 / 404 / 409 / 500
payments_program — 支払いプログラム(2 エンドポイント)
GET /payments_program/{marketplace_id}/{payments_program_type}
getPaymentsProgram — 指定した支払いプログラムへのオプトイン状況を返します。
注: 全セラーで新しい支払いフローが有効のため、現在は適用されません。
レスポンス: 200 / 400 / 404 / 500
GET /payments_program/{marketplace_id}/{payments_program_type}/onboarding
getPaymentsProgramOnboarding — 支払いプログラムのオンボーディングステータスを取得します。
レスポンス: 200 / 400 / 404 / 500
privilege(1 エンドポイント)
GET /privilege
getPrivileges — セラーの現在の権限セット(登録完了状況、販売制限)を取得します。
レスポンス: 200 / 400 / 500
program — セラープログラム(3 エンドポイント)
GET /program/get_opted_in_programs
getOptedInPrograms — オプトイン済みのセラープログラムリストを取得します。
レスポンス: 200 / 400 / 404 / 500
POST /program/opt_in
optInToProgram — セラーを eBay セラープログラムにオプトインします。処理に最大 24 時間かかる場合があります。
レスポンス: 200 / 400 / 404 / 409 / 500
POST /program/opt_out
optOutOfProgram — セラープログラムからオプトアウトします。
レスポンス: 200 / 400 / 404 / 409 / 500
rate_table(1 エンドポイント)
GET /rate_table
getRateTables — 配送料率表を取得します。US、CA、UK、DE、AU、FR、IT、ES のマーケットプレイスをサポート。セラーはアカウントに最大 40 個の料率表を定義できます。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
country_code | クエリ | 任意 | ISO 3166 国コード。省略時は全マーケットプレイスの料率表を返します。 |
レスポンス: 200 / 400 / 500
return_policy — 返品ポリシー(6 エンドポイント)
GET /return_policy
getReturnPolicies — 指定マーケットプレイスのすべての返品ポリシーを取得。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | クエリ | 必須 | eBay マーケットプレイス ID。 |
Content-Language | ヘッダー | 任意 | マルチロケール対応。 |
レスポンス: 200 / 400 / 500
POST /return_policy
createReturnPolicy — 新しい返品ポリシーを作成します。自動車の出品には適用されません。
レスポンス: 201 / 400 / 500
GET /return_policy/get_by_policy_name
getReturnPolicyByName — ポリシー名で返品ポリシーを取得します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
marketplace_id | クエリ | 必須 | eBay マーケットプレイス ID。 |
name | クエリ | 必須 | ポリシー名。 |
Content-Language | ヘッダー | 任意 | マルチロケール対応。 |
レスポンス: 200 / 400 / 500
GET /return_policy/{return_policy_id}
getReturnPolicy — 特定の返品ポリシーの詳細を取得します。
レスポンス: 200 / 400 / 404 / 500
PUT /return_policy/{return_policy_id}
updateReturnPolicy — 返品ポリシーを更新します。完全なペイロードが必要です。
レスポンス: 200 / 400 / 404 / 500
DELETE /return_policy/{return_policy_id}
deleteReturnPolicy — 返品ポリシーを削除します。
レスポンス: 204 / 400 / 404 / 409 / 500
sales_tax — 売上税テーブル(5 エンドポイント)
注: 売上税テーブルは US と CA のマーケットプレイスでのみ使用可能。米国では eBay が全 50 州 + DC の売上税を自動処理するため、セラーは一部の米国領土(AS、GU、MP、PW、VI)のみ設定可能です。
GET /sales_tax
getSalesTaxes — 特定の国のすべての売上税テーブルエントリを取得します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
country_code | クエリ | 必須 | ISO 3166 国コード(US / CA)。 |
レスポンス: 200 / 400 / 500
POST /bulk_create_or_replace_sales_tax
bulkCreateOrReplaceSalesTax — 売上税テーブルエントリを一括作成/更新します(OpenAPI のみ)。
レスポンス: 200 / 207 / 400 / 500
GET /sales_tax/{countryCode}/{jurisdictionId}
getSalesTax — 特定の税管轄区域のエントリを取得します。
レスポンス: 200 / 204 / 400 / 404 / 500
PUT /sales_tax/{countryCode}/{jurisdictionId}
createOrReplaceSalesTax — 税管轄区域のエントリを作成/更新します。
レスポンス: 204 / 400 / 404 / 500
DELETE /sales_tax/{countryCode}/{jurisdictionId}
deleteSalesTax — 税管轄区域のエントリを削除します。
レスポンス: 204 / 400 / 404 / 500
subscription(1 エンドポイント)
GET /subscription
getSubscription — セラーアカウントに関連するサブスクリプションリストを取得します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
limit | クエリ | 任意 | 将来使用のために予約。 |
continuation_token | クエリ | 任意 | 将来使用のために予約。 |
レスポンス: 200 / 400 / 500
エンドポイント一覧(全 37 エンドポイント)
| メソッド | エンドポイント | operationId | 説明 |
|---|---|---|---|
| GET | /advertising_eligibility | getAdvertisingEligibility | 広告適格性を確認 |
| POST | /bulk_create_or_replace_sales_tax | bulkCreateOrReplaceSalesTax | 売上税を一括作成/更新 |
| GET | /custom_policy/ | getCustomPolicies | カスタムポリシー一覧 |
| POST | /custom_policy/ | createCustomPolicy | カスタムポリシー作成 |
| GET | /custom_policy/{custom_policy_id} | getCustomPolicy | カスタムポリシー取得 |
| PUT | /custom_policy/{custom_policy_id} | updateCustomPolicy | カスタムポリシー更新 |
| GET | /fulfillment_policy | getFulfillmentPolicies | フルフィルメントポリシー一覧 |
| POST | /fulfillment_policy/ | createFulfillmentPolicy | フルフィルメントポリシー作成 |
| GET | /fulfillment_policy/get_by_policy_name | getFulfillmentPolicyByName | 名前でフルフィルメントポリシー取得 |
| GET | /fulfillment_policy/{fulfillmentPolicyId} | getFulfillmentPolicy | フルフィルメントポリシー取得 |
| PUT | /fulfillment_policy/{fulfillmentPolicyId} | updateFulfillmentPolicy | フルフィルメントポリシー更新 |
| DELETE | /fulfillment_policy/{fulfillmentPolicyId} | deleteFulfillmentPolicy | フルフィルメントポリシー削除 |
| GET | /kyc | getKYC | KYC ステータス確認 |
| GET | /payment_policy | getPaymentPolicies | 支払いポリシー一覧 |
| POST | /payment_policy | createPaymentPolicy | 支払いポリシー作成 |
| GET | /payment_policy/get_by_policy_name | getPaymentPolicyByName | 名前で支払いポリシー取得 |
| GET | /payment_policy/{payment_policy_id} | getPaymentPolicy | 支払いポリシー取得 |
| PUT | /payment_policy/{payment_policy_id} | updatePaymentPolicy | 支払いポリシー更新 |
| DELETE | /payment_policy/{payment_policy_id} | deletePaymentPolicy | 支払いポリシー削除 |
| GET | /payments_program/{marketplace_id}/{payments_program_type} | getPaymentsProgram | 支払いプログラムステータス |
| GET | /payments_program/.../onboarding | getPaymentsProgramOnboarding | オンボーディングステータス |
| GET | /privilege | getPrivileges | セラー権限取得 |
| GET | /program/get_opted_in_programs | getOptedInPrograms | オプトイン済みプログラム |
| POST | /program/opt_in | optInToProgram | プログラムにオプトイン |
| POST | /program/opt_out | optOutOfProgram | プログラムからオプトアウト |
| GET | /rate_table | getRateTables | 配送料率表取得 |
| GET | /return_policy | getReturnPolicies | 返品ポリシー一覧 |
| POST | /return_policy | createReturnPolicy | 返品ポリシー作成 |
| GET | /return_policy/get_by_policy_name | getReturnPolicyByName | 名前で返品ポリシー取得 |
| GET | /return_policy/{return_policy_id} | getReturnPolicy | 返品ポリシー取得 |
| PUT | /return_policy/{return_policy_id} | updateReturnPolicy | 返品ポリシー更新 |
| DELETE | /return_policy/{return_policy_id} | deleteReturnPolicy | 返品ポリシー削除 |
| GET | /sales_tax | getSalesTaxes | 売上税テーブル取得 |
| GET | /sales_tax/{countryCode}/{jurisdictionId} | getSalesTax | 税管轄区域エントリ取得 |
| PUT | /sales_tax/{countryCode}/{jurisdictionId} | createOrReplaceSalesTax | 税エントリ作成/更新 |
| DELETE | /sales_tax/{countryCode}/{jurisdictionId} | deleteSalesTax | 税エントリ削除 |
| GET | /subscription | getSubscription | サブスクリプション取得 |
スキーマ数: 52(詳細は OpenAPI 仕様を参照)