Order API ドキュメント
注文 API（Order API）
Order API は、買い物客が商品の支払いを行えるインターフェイスを提供します。注文の支払いおよび配送ステータスも返します。
注: Order API (v2) は現在、ゲストの支払い/チェックアウト フローのみをサポートしています。メンバーの支払い/チェックアウト フローをサポートする必要がある場合は、Order API の v1_beta バージョンを使用してください。
注: これは限定リリース API であり、ビジネスユニットによって承認された特定の開発者のみが利用できます。
バージョン: v2.1.2
ベースURL: https://api.ebay.com/buy/order/v2
認証（OAuth スコープ）
この API は クライアント資格情報（Client Credentials） フローを使用します。
| スコープ | 説明 |
|---|---|
https://api.ebay.com/oauth/api_scope/buy.guest.order | ゲスト注文の表示と管理 |
リソース一覧
Order API は以下の 2 リソース、合計 8 エンドポイント（2 GET + 6 POST）で構成されています。
| リソース | 説明 | 数 |
|---|---|---|
| guest_checkout_session | ゲストチェックアウトセッションの作成・管理 | 7 |
| guest_purchase_order | ゲスト購入注文の詳細取得 | 1 |
guest_checkout_session — ゲストチェックアウト（7 エンドポイント）
POST /guest_checkout_session/initiate
initiateGuestCheckoutSession — eBay ゲストチェックアウトセッションを作成します。チェックアウトを実行する最初のステップです。後続のメソッドで使用する checkoutSessionId を返します。
レスポンスヘッダー X-EBAY-SECURITY-SIGNATURE は、Checkout with eBay ウィジェットを起動するために使用されるトークンです。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | 注文が行われる eBay マーケットプレイス。 |
X-EBAY-C-ENDUSERCTX | ヘッダー | 任意 | デバイス/ユーザーの deviceId。支払いゲートウェイの追跡用。 |
Content-Type | ヘッダー | 必須 | application/json |
レスポンス: 200 / 400 / 409 / 500
GET /guest_checkout_session/{checkoutSessionId}
getGuestCheckoutSession — 指定されたゲストチェックアウトセッションの詳細を返します。リクエストペイロードは不要です。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
checkoutSessionId | パス | 必須 | eBay が割り当てた一意のセッション ID。initiateGuestCheckoutSession で返されます。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | セッション作成時と同じマーケットプレイス ID。 |
X-EBAY-C-ENDUSERCTX | ヘッダー | 任意 | デバイス/ユーザーの deviceId。 |
レスポンス: 200 / 400 / 403 / 404 / 409 / 500
POST /guest_checkout_session/{checkoutSessionId}/apply_coupon
applyGuestCoupon — ゲストチェックアウトセッションにクーポンを追加し、注文内のすべての対象商品に適用します。クーポンの引き換えコードはペイロードに必須。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
checkoutSessionId | パス | 必須 | セッション ID。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | セッション作成時と同じマーケットプレイス ID。 |
Content-Type | ヘッダー | 必須 | application/json |
X-EBAY-C-ENDUSERCTX | ヘッダー | 任意 | デバイス/ユーザーの deviceId。 |
レスポンス: 200 / 400 / 403 / 404 / 409 / 500
POST /guest_checkout_session/{checkoutSessionId}/remove_coupon
removeGuestCoupon — ゲストチェックアウトセッションからクーポンを削除します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
checkoutSessionId | パス | 必須 | セッション ID。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | セッション作成時と同じマーケットプレイス ID。 |
Content-Type | ヘッダー | 必須 | application/json |
X-EBAY-C-ENDUSERCTX | ヘッダー | 任意 | デバイス/ユーザーの deviceId。 |
レスポンス: 200 / 400 / 403 / 404 / 409 / 500
POST /guest_checkout_session/{checkoutSessionId}/update_quantity
updateGuestQuantity — ゲストチェックアウトセッションで指定された明細項目の数量を変更します。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
checkoutSessionId | パス | 必須 | セッション ID。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | セッション作成時と同じマーケットプレイス ID。 |
Content-Type | ヘッダー | 必須 | application/json |
X-EBAY-C-ENDUSERCTX | ヘッダー | 任意 | デバイス/ユーザーの deviceId。 |
レスポンス: 200 / 400 / 403 / 404 / 409 / 500
POST /guest_checkout_session/{checkoutSessionId}/update_shipping_address
updateGuestShippingAddress — ゲストチェックアウトセッションで注文の配送先住所を変更します。注文内のすべての明細項目は同じ住所に配送する必要がありますが、配送方法は明細項目ごとに指定できます。
注: 送信された住所が検証できない場合は、警告メッセージが返されますが、メソッドの実行は妨げられません。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
checkoutSessionId | パス | 必須 | セッション ID。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | セッション作成時と同じマーケットプレイス ID。 |
Content-Type | ヘッダー | 必須 | application/json |
X-EBAY-C-ENDUSERCTX | ヘッダー | 任意 | デバイス/ユーザーの deviceId。 |
レスポンス: 200 / 400 / 403 / 404 / 409 / 500
POST /guest_checkout_session/{checkoutSessionId}/update_shipping_option
updateGuestShippingOption — ゲストチェックアウトセッションで指定された品目の配送方法を変更します。配送オプションは品目ごとに設定でき、買い物客が品目ごとに配送料を選択できます。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
checkoutSessionId | パス | 必須 | セッション ID。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 必須 | セッション作成時と同じマーケットプレイス ID。 |
Content-Type | ヘッダー | 必須 | application/json |
X-EBAY-C-ENDUSERCTX | ヘッダー | 任意 | デバイス/ユーザーの deviceId。 |
レスポンス: 200 / 400 / 403 / 404 / 409 / 500
guest_purchase_order — ゲスト購入注文（1 エンドポイント）
GET /guest_purchase_order/{purchaseOrderId}
getGuestPurchaseOrder — 特定のゲスト購入注文の詳細を取得します。購入注文のステータス、作成日と変更日、アイテムの数量と出品データ、支払いと配送の情報、価格、税金、割引、クレジットなどの明細項目を返します。
注: purchaseOrderId は、eBay 支払いウィジェットを通じて送信されるコールバック URL で返されます。
| パラメータ | 場所 | 必須 | 説明 |
|---|---|---|---|
purchaseOrderId | パス | 必須 | ゲスト購入者が作成した購入注文の一意の識別子。 |
X-EBAY-C-MARKETPLACE-ID | ヘッダー | 任意 | セッション作成時と同じマーケットプレイス ID。 |
X-EBAY-C-ENDUSERCTX | ヘッダー | 任意 | デバイス/ユーザーの deviceId。 |
レスポンス: 200 / 400 / 403 / 404 / 500
エンドポイント一覧（全 8 エンドポイント）
| メソッド | エンドポイント | operationId | 説明 |
|---|---|---|---|
| POST | /guest_checkout_session/initiate | initiateGuestCheckoutSession | ゲストチェックアウトセッション作成 |
| GET | /guest_checkout_session/{checkoutSessionId} | getGuestCheckoutSession | セッション詳細取得 |
| POST | /guest_checkout_session/{checkoutSessionId}/apply_coupon | applyGuestCoupon | クーポン適用 |
| POST | /guest_checkout_session/{checkoutSessionId}/remove_coupon | removeGuestCoupon | クーポン削除 |
| POST | /guest_checkout_session/{checkoutSessionId}/update_quantity | updateGuestQuantity | 数量変更 |
| POST | /guest_checkout_session/{checkoutSessionId}/update_shipping_address | updateGuestShippingAddress | 配送先住所変更 |
| POST | /guest_checkout_session/{checkoutSessionId}/update_shipping_option | updateGuestShippingOption | 配送方法変更 |
| GET | /guest_purchase_order/{purchaseOrderId} | getGuestPurchaseOrder | ゲスト購入注文詳細取得 |
スキーマ数: 32（詳細は OpenAPI 仕様を参照）