Buy Offer API ドキュメント

購入オファー API(Buy Offer API)

注: これは限定リリース API であり、ビジネスユニットによって承認された特定の開発者のみが利用できます。本番環境でこの API にアクセスする方法については、購入 API の要件を参照してください。

Buy Offer API を使用すると、パートナーは購入者に代わって代理入札を行い、購入者が入札しているオークションを取得できます。代理入札を行うことで、購入者はオークションに勝った場合にアイテムを購入することに同意します。

バージョン: v1_beta.0.1

ベースURL: https://api.ebay.com/buy/offer/v1_beta

認証(OAuth スコープ)

この API は 認可コード(Authorization Code) フローを使用します。ユーザーアクセストークンが必要です。

スコープ説明
https://api.ebay.com/oauth/api_scope/buy.offer.auctionオークション入札の表示と管理

リソース一覧

Buy Offer API は以下の 1 リソース、合計 2 エンドポイント(1 GET + 1 POST)で構成されています。

リソース説明
biddingオークション入札の取得と代理入札の実行2

bidding — オークション入札(2 エンドポイント)

GET /bidding/{item_id}

getBidding — 指定されたオークションの購入者に固有の入札詳細を取得します。購入者がすでに入札しているオークションである必要があります。

入札情報を取得するには、ユーザーアクセストークンを使用し、オークションのアイテム ID を渡します。Browse APIgetItems メソッドを使用して、オークションに関する一般的な入札詳細(最低入札価格や一意の入札者数など)を取得することもできます。

制限事項: サポートされているサイトとその他の制限事項については、API 制限事項を参照してください。

パラメータ場所必須説明
item_idパス必須購入者の入札情報を取得するアイテムの一意の eBay RESTful 識別子。Browse および Feed API メソッドによって返されます。
例: v1|2**********2|0
制限: 購入者はこのアイテムに入札している必要があります。
X-EBAY-C-MARKETPLACE-IDヘッダー必須購入者が拠点を置く eBay マーケットプレイスの ID。大文字と小文字が区別されます。
例: X-EBAY-C-MARKETPLACE-ID = EBAY_US

レスポンス: 200 / 400 / 404 / 500

POST /bidding/{item_id}/place_proxy_bid

placeProxyBidユーザーアクセストークンを使用して、特定のオークションアイテムに対して購入者の代理入札を行います。アイテムは buyingOptions の 1 つとして AUCTION を提供する必要があります。

入札を行うには、オークションのアイテム ID を URI パラメータとして渡し、購入者の最大入札額(maxAmount)をペイロードに渡します。代理入札を行うことで、購入者はオークションに勝った場合にアイテムを購入することに同意します。

この入札が行われた後、他の誰かが購入者よりも高い入札を行った場合、eBay は自動的に購入者の最大入札額まで再度入札します。入札額が購入者の最高入札額を超えると、eBay は購入者に入札額が上回ったことを通知します。

制限事項: サポートされているサイトとその他の制限事項については、API 制限事項を参照してください。

パラメータ場所必須説明
item_idパス必須入札するアイテムの一意の eBay RESTful 識別子。Browse および Feed Beta API メソッドによって返されます。
例: v1|2**********2|0
X-EBAY-C-MARKETPLACE-IDヘッダー必須購入者の拠点となる eBay マーケットプレイスの ID。大文字と小文字が区別されます。
例: X-EBAY-C-MARKETPLACE-ID = EBAY_US
Content-Typeヘッダー必須リクエスト本文の形式。application/json に設定する必要があります。

レスポンス: 200 / 400 / 404 / 409 / 500

スキーマ定義(全 8 スキーマ)

Bidding

フィールド説明
auctionEndDatestringオークション終了日時
auctionStatusstringオークションのステータス(ACTIVEENDED
bidCountinteger入札数
currentPriceAmount現在の価格
currentProxyBidProxyBid購入者の現在の代理入札
highBidderboolean購入者が最高入札者かどうか
itemIdstringアイテム ID
reservePriceMetboolean最低落札価格に達したかどうか
suggestedBidAmountsarray[Amount]推奨入札額

PlaceProxyBidRequest

フィールド説明
maxAmountAmount購入者の最大入札額
userConsentUserConsentユーザーの同意情報

PlaceProxyBidResponse

フィールド説明
proxyBidIdstring代理入札 ID

ProxyBid

フィールド説明
maxAmountAmount最大入札額
proxyBidIdstring代理入札 ID

UserConsent

フィールド説明
adultOnlyItemboolean成人向けアイテムの同意

Amount

フィールド説明
currencystring通貨コード
valuestring金額

Error / ErrorParameter

標準エラースキーマ(他の API と同一構造)。

エンドポイント一覧(全 2 エンドポイント)

メソッドエンドポイントoperationId説明
GET/bidding/{item_id}getBidding入札詳細取得
POST/bidding/{item_id}/place_proxy_bidplaceProxyBid代理入札の実行
トップに戻る