Account v2 API ドキュメント
アカウント v2 API(Account v2 API)
Account v2 API を使用すると、販売者はカスタム配送料率表を取得・管理できます。また、中国本土の販売者には、2 つの支払い手段間で分割支払いを設定する機能も提供します。
バージョン: 2.1.0
ベースURL: https://api.ebay.com/sell/account/v2
認証(OAuth スコープ)
この API は 認可コード(Authorization Code) フローを使用します。
| スコープ | 説明 |
|---|---|
https://api.ebay.com/oauth/api_scope/sell.account | アカウント設定の表示と管理 |
https://api.ebay.com/oauth/api_scope/sell.account.readonly | アカウント設定の表示 |
https://api.ebay.com/oauth/api_scope/sell.finances | 支払いおよび注文情報の表示と管理 |
リソース一覧
Account v2 API は以下の 2 リソース、合計 4 エンドポイント(2 GET + 2 POST)で構成されています。
| リソース | 説明 | 数 |
|---|---|---|
| payout_settings | 分割支払い設定の管理(中国本土の販売者向け) | 2 |
| rate_table | 配送料率表の取得と更新 | 2 |
payout_settings — 分割支払い(2 エンドポイント)
重要: 分割支払い機能は中国本土の販売者にのみ利用可能で、Payoneer アカウントと銀行口座の間で支払いを分割できます。
GET /payout_settings
getPayoutSettings — 販売者のアカウントで定義されている 2 つの支払い手段の詳細(ID、タイプ、ステータス、ニックネーム、支払い率など)を返します。
レスポンス: 200 / 500
POST /payout_settings/update_percentage
updatePayoutPercentage — 2 つの支払い手段の分割支払い率を設定します。合計は常に 100% である必要があります。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
Content-Type | ヘッダー | 必須 | application/json |
レスポンス: 204 / 400 / 500
rate_table — 配送料率表(2 エンドポイント)
GET /rate_table/{rate_table_id}
getRateTable — 指定された配送料率表の詳細を取得します。US、CA、UK、DE、AU、FR、IT、ES のマーケットプレイスをサポート。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
rate_table_id | パス | 必須 | 配送料率表の一意の識別子。Account v1 の getRateTables で取得。 |
レスポンス: 200 / 400 / 404 / 500
POST /rate_table/{rate_table_id}/update_shipping_cost
updateShippingCost — 既存の配送料率表の shippingCost および/または additionalCost を更新します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
rate_table_id | パス | 必須 | 配送料率表の一意の識別子。 |
Content-Type | ヘッダー | 必須 | application/json |
レスポンス: 204 / 400 / 404 / 409 / 500
エンドポイント一覧(全 4 エンドポイント)
| メソッド | エンドポイント | operationId | 説明 |
|---|---|---|---|
| GET | /payout_settings | getPayoutSettings | 支払い手段の詳細を取得 |
| POST | /payout_settings/update_percentage | updatePayoutPercentage | 分割支払い率を更新 |
| GET | /rate_table/{rate_table_id} | getRateTable | 配送料率表を取得 |
| POST | /rate_table/{rate_table_id}/update_shipping_cost | updateShippingCost | 配送料を更新 |
スキーマ数: 11(詳細は OpenAPI 仕様を参照)