アカウント管理
アカウント管理ガイド
概要
Account Management APIを使用することで、開発者はアカウント設定、ユーザー設定、およびアカウント構成を管理し、eBayでのセラー体験を向上させることができます。これらのAPIには、ビジネスポリシーやカスタムポリシーの作成・管理、セラーへのペイアウト(支払金)やその他の金銭取引データの取得、配送料金テーブルの管理を行うメソッドが含まれており、セラーがeBayの要件に準拠し、業務を最適化することを可能にします。
APIのユースケース
- ビジネスポリシーの管理
- カスタムポリシーの管理
- セラーの財務管理
- 配送料金テーブルの管理
- サブスクリプションおよび広告適格性の取得
- 消費税設定の管理
- ユーザーアカウント情報の取得と設定
- オプトインプログラムの管理
ビジネスポリシーの管理
Account Management APIを使用すると、セラーは支払い、返品、フルフィルメント(配送)に関するビジネスポリシーを定義および管理できます。これらのビジネスポリシーは、リクエストペイロード内でそのIDを参照することにより、Listing Management API経由で出品に適用できます。
- 新しいビジネスポリシーを定義するには、createFulfillmentPolicy、createPaymentPolicy、および createReturnPolicy を使用します。
- マーケットプレイスのすべてのビジネスポリシーを取得するには、getFulfillmentPolicies、getPaymentPolicies、および getReturnPolicies を使用します。
- 名前で特定のビジネスポリシーを取得するには、getFulfillmentPolicyByName、getPaymentPolicyByName、および getReturnPolicyByName を使用します。
- IDで特定のビジネスポリシーを取得するには、getFulfillmentPolicy、getPaymentPolicy、および getReturnPolicy を使用します。
- 既存のビジネスポリシーを変更するには、updateFulfillmentPolicy、updatePaymentPolicy、および updateReturnPolicy を使用します。
- 未使用のビジネスポリシーを削除するには、deleteFulfillmentPolicy、deletePaymentPolicy、および deleteReturnPolicy を使用します。
- 配送料の定額割引やプロモーション割引などの配送割引ルールを設定または更新するには SetShippingDiscountProfile を使用します。その後、これらの割引をフルフィルメントビジネスポリシーに適用できます。
- 有効な配送割引プロファイルの詳細を取得するには GetShippingDiscountProfiles を使用します。
カスタムポリシーの管理
セラーは、規制や通関の要件を満たすために、製品コンプライアンスやテイクバック(回収)ポリシーなどのカスタムポリシーを管理できます。これらのポリシーは、リクエストペイロード内でそのIDを参照することにより、Listing Management API経由で出品に適用できます。
- 製品コンプライアンスやテイクバックポリシーを含む新しいカスタムポリシーを定義するには、createCustomPolicy メソッドを使用します。
- 製品コンプライアンスやテイクバックポリシーを含む既存のすべてのカスタムポリシーを取得するには、getCustomPolicies メソッドを使用します。
- IDで特定のカスタムポリシーの詳細を取得するには、getCustomPolicy メソッドを使用します。
- 製品コンプライアンスやテイクバックポリシーを含む既存のカスタムポリシーを変更するには、updateCustomPolicy メソッドを使用します。
セラーの財務管理
Finances API は、セラーとeBay間の金銭取引およびペイアウト(支払金)の包括的なビューを提供します。手数料、請求、クレジットを含むすべての取引の詳細を取得するには、Finances API を使用します。
- セラーに発行されたペイアウトのリストを取得するには getPayouts を使用します。特定のペイアウトの詳細情報を取得するには getPayout を使用します。
- セラーのペイアウト設定を構成および取得するには、Account API v2の getPayoutSettings および updatePayoutPercentage を使用します。これらのメソッドは、中国本土を拠点とするセラーにのみ適用されます。
- 販売、eBay配送ラベルの購入、出品手数料、バイヤーへの返金、セラークレジットなどの金銭取引を取得するには getTransactions を使用します。
- セラーのペイアウト資金の概要(利用可能額、保留中、処理中の金額を含む)を取得し、財務の効果的な追跡と管理に役立てるには getSellerFundsSummary を使用します。
- eBayとセラー間の特定の資金移動の詳細(金額、ステータス、通貨、日付、追跡と照合のための関連メタデータなど)を取得するには getTransfer を使用します。
- セラーの口座残高、手数料、請求書情報を取得するには GetAccount を使用します。
EUおよび英国の決済規制要件に準拠するため、EU/英国在住のセラーに代わって行われる特定のAPI呼び出しにはデジタル署名を含める必要があります。これらの要件は、安全な取引を保証するために強力な顧客認証(SCA)規制の下で義務付けられています。
デジタル署名が必要なアカウント管理APIおよびメソッド:
- Finances API: すべてのメソッド
- Trading API: GetAccount 呼び出し
配送料金テーブルの管理
配送料金テーブルを使用すると、セラーはバイヤーの所在地などのさまざまな要因に基づいて配送料を定義できます。セラーは、多様な配送ニーズに対応するために、国内および海外の配送料金テーブルを作成できます。これらのテーブルは、Listing Management APIで料金テーブルIDを参照することにより、出品に適用できます。
- すべての配送料金テーブルのリストを取得するには、Account API v1の getRateTables を使用します。
- 配送料情報を含む特定の料金テーブルを取得するには、Account API v2の getRateTable を使用します。
- 既存の配送料金テーブル内のコストを変更するには、Account API v2の updateShippingCost を使用します。
サブスクリプションおよび広告適格性の取得
Account Management APIには、サブスクリプションの詳細、広告の適格性、およびアカウントレベルの権限を取得するためのメソッドが含まれています。
- 新しいセラーが登録を完了したかを確認し、取引数や総売上高などの1日あたりの販売制限を表示するには getPrivileges を使用します。
- セラーのサブスクリプション詳細を取得するには getSubscription を使用します。
- さまざまな広告プログラムに対するセラーの適格性を確認するには getAdvertisingEligibility を使用します。
消費税設定の管理
セラーは、米国およびカナダのマーケットプレイスにおける特定の税管轄区域の消費税率を設定および管理できます。
- 構成済みのすべての消費税設定を取得するには getSalesTaxes を使用します。
- 特定の管轄区域の消費税設定を取得するには getSalesTax を使用します。
- 管轄区域の税設定を追加または変更するには createOrReplaceSalesTax を使用します。
- 特定の管轄区域の税設定を削除するには deleteSalesTax を使用します。
- 米国およびカナダの管轄区域の消費税設定を設定または更新するには SetTaxTable を使用します。
- セラーが設定したすべての管轄区域の税設定を取得するには GetTaxTable を使用します。
ユーザーアカウント情報の取得と設定
eBay APIは、アカウント設定、配送割引、本人確認など、特定のアカウント詳細を管理するための不可欠なメソッドを提供します。
- フィードバックスコアや登録詳細など、セラーのアカウントに関する詳細情報を取得するには GetUser を使用します。
- セラーのアカウント設定を更新するには SetUserPreferences を使用します。
- ビジネスポリシー、在庫切れ管理設定、配送締め切り時間、未払い商品アシスタント設定などのセラーアカウント設定を取得するには GetUserPreferences を使用します。
- eBayの確認ポリシーへの準拠を保証するために、セラーのアカウントレベルの本人確認情報を検証および管理するには Identity API を使用します。
オプトインプログラムの管理
セラーは特定のeBayプログラムにオプトイン(参加)またはオプトアウト(辞退)して、アカウント体験を調整できます。現在サポートされているプログラムには、在庫切れ管理(Out-of-Stock control)、ビジネスポリシーのオプトイン、Motors Dealersプログラムが含まれます。
- アカウントがオプトインしているプログラムを表示するには getOptedInPrograms を使用します。
- 特定のプログラムにオプトインするには optInToProgram を使用します。
- 特定のプログラムからオプトアウトするには optOutOfProgram を使用します。
コードサンプル
米国マーケットプレイスのフルフィルメントビジネスポリシーを取得する
curl -X GET "https://api.ebay.com/sell/account/v1/fulfillment_policy?marketplace_id=EBAY_US" -H "Authorization:Bearer OAUTH_token"
米国マーケットプレイスのセラーペイアウトのリストを取得する
curl -X GET "https://apiz.ebay.com/sell/finances/v1/payout" -H "Authorization:Bearer OAUTH_token" -H "X-EBAY-C-MARKETPLACE-ID:EBAY_US"
エラーハンドリング
- APIリクエストで指定されたマーケットプレイスIDが無効な場合は、eBay Marketplace IDs documentationを参照して有効なマーケットプレイスIDのリストを確認し、リクエストで正しいマーケットプレイスIDが渡されていることを確認してください。
- 必須フィールドの欠落によりポリシーを作成または更新するAPI呼び出しが失敗した場合は、name、marketplaceId、および特定のコンプライアンスやポリシーの詳細(例:description、categoryTypes)が含まれており、かつそれらが有効であることを確認してください。APIドキュメントでエンドポイント固有のフィールド要件を参照し、API呼び出しを行う前にリクエストペイロードを検証してください。
- 同じ名前のポリシーがすでに存在するために新しいポリシーの作成に失敗した場合は、getPolicies メソッドを使用して既存のポリシーを取得し、新しいポリシー名が一意であることを確認してください。
ベストプラクティス
- 定期的にビジネスポリシーを取得し、システムとeBayのアカウント設定との整合性を確保してください。
- ポリシーや税設定などの頻繁に使用されるデータにはキャッシュを実装し、冗長なAPI呼び出しを削減してください。