Order API

Order API 概要 (Order API Overview)

バージョン：2.1.2

注: これは ゲストチェックアウト の支払いフローをサポートする Order API の v2 バージョンです。eBay 会員ログインを伴うチェックアウトフローをサポートする必要がある場合は、Order API の v1_beta バージョン を使用してください。

Order API は eBay Buy API の一部です。商品の購入および購入注文（注文書）の追跡に使用されます。Order API は、完全なゲストチェックアウトプロセスをサポートしています。この API を他の Buy API 群と組み合わせることで、ゲストユーザーが eBay サイトにアクセスすることなく eBay セラーから商品を購入できるアプリケーションを作成できます。Buy API は、アプリやウェブサイト内から eBay 商品を購入する機能を提供します。

注: これは限定リリース (Limited Release) APIであり、ビジネスユニットによって承認された一部の開発者のみが利用可能です。本番環境（Production）でのアクセス権取得方法については、Buy API Requirements を参照してください。

技術概要 (Technical overview)

Order API は eBay の ゲストチェックアウト をサポートしています。ゲストチェックアウトでは、ユーザーは Checkout with eBay ウィジェット を使用して商品を購入します。

チェックアウトを完了するには一連のステップがあります。チェックアウトが開始された後、配送フルフィルメントのステータスを含む注文詳細を取得できます。

ヒント: 新しい Checkout with eBay ウィジェット の詳細については、Buying Integration Guide の Order API セクションを参照してください。

この API は以下のリソースを使用します：

  • guest_checkout_session – ゲストチェックアウトに関する以下のすべての詳細を含みます：
    • 品目（ラインアイテム）：各アイテムの識別子、支払いステータス、純価格、配送サービス詳細、セラー、数量。
    • 価格サマリー：商品のコスト、割引、税金、およびクーポン割引。
    • 配送先住所。
  • guest_purchase_order – ゲストチェックアウトの購入注文に関する以下のすべての詳細を含みます：
    • 購入された品目：各アイテムの識別子、配送詳細、セラー、価格、数量。
    • 価格サマリー：商品のコスト、割引、税金、およびクーポン割引。
    • 支払いおよび注文のステータス。

ビジネスユースケース (Business use cases)

Order API の主なユースケースは以下の通りです：

チェックアウトの開始

これはチェックアウトプロセスの最初のステップです。プロセスを開始し、商品を含むカートを作成します。

品目情報の更新

注文内の任意の品目の数量や配送オプションを追加または変更できます。これにより、買い物客は品目ごとに配送コストや配送スピードを選択できるようになります。

注文配送情報の更新

注文の配送先住所を変更できます。1つの注文につき、配送先住所は1つだけ設定可能です。

チェックアウトおよび注文詳細の取得

チェックアウトセッションの詳細や、注文の処理ステータスを表示できます。

注文の支払い

eBay ゲストが注文の支払いを行うには、新しい Checkout with eBay ウィジェット を使用します。

API制限 (API restrictions)

Order API に関する制約事項は以下の通りです：

API の依存関係

Order API は、一貫性のある購買アプリケーションを作成するために、他の Buy API 群と併用するように設計されています。Order API で使用される識別子（ID）は、Buy API 間でのみ互換性があります。

識別子の非互換性

Buy API の商品および注文の識別子は、eBay サイトやバイヤー宛のメールで使用されている識別子とは一致しません。そのため、Buy API の識別子を Finding API などの eBay レガシー API で使用することはできません。詳細は Buying Integration Guide の Legacy API compatibility を参照してください。

なお、Order API を使用してレガシーな注文 ID を取得することは可能です。

地域/サイトの制約

すべての Buy API がサポートされている eBay サイトのリストについては、Buy API Support by Marketplace を参照してください。

サイトを指定するには、X-EBAY-C-MARKETPLACE-ID リクエストヘッダーにサイトを設定します。例：
X-EBAY-C-MARKETPLACE-ID = EBAY_GB

セキュリティおよびサンドボックスの要件

本番環境（Production）での Buy API の使用は制限されています。サンドボックス環境では誰でも Buy API を試用できますが、Order API だけはサンドボックスでも制限されています。

制限付き API にアクセスするには、標準の適格性要件を満たし、eBay サポート組織からの承認を得て、eBay と契約を締結する必要があります。

ゲストチェックアウト メソッドへのアクセスが必要な開発者は、Developer Technical Support (DTS) またはビジネスユニットの担当者に連絡して承認をリクエストしてください。承認されると、サンドボックスでのゲストチェックアウトメソッドの使用権限も付与されます。

チェックアウトセッションの制限

チェックアウトセッションは initiateGuestCheckoutSession メソッドによって作成されます。このメソッドはセッション ID を返し、他のすべてのゲストチェックアウトメソッドのリクエストパラメータとして使用されます。以下の制限があります：

  • マーケットプレイス ID の一致: セッションに影響を与えるすべてのメソッドは、セッション作成時と同じ X-EBAY-C-MARKETPLACE-ID 値を使用しなければなりません。
  • App ID の一致: 同一リソース内のすべてのメソッドで、同じ開発者 App ID を使用しなければなりません。

eBay Bucks とクーポン

Order API は eBay Bucks をサポートしていません。クーポンはサポートしていますが、この機能の使用には個別の認可が必要です。

レート制限

Order API は、アプリケーションに代わって 1 日に行える呼び出し回数を制限しています。現在のアプリケーションレート制限については、eBay API Call Limits ページを参照してください。

トップに戻る