Negotiation API ドキュメント

交渉 API(Negotiation API)

Negotiation API を使用すると、売り手は自分の出品に「興味」を示した購入者に積極的に割引オファーを送信できます。購入者がウォッチリストに追加したり、ショッピングカートに追加後に放棄した場合などに、販売者は割引オファーを送信して販売を促進できます。

バージョン: v1.1.0

ベースURL: https://api.ebay.com/sell/negotiation/v1

認証(OAuth スコープ)

この API は 認可コード(Authorization Code) フローを使用します。

スコープ 説明
https://api.ebay.com/oauth/api_scope/sell.inventory在庫とオファーの表示と管理
https://api.ebay.com/oauth/api_scope/sell.inventory.readonly在庫とオファーの表示

リソース一覧

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

リソース 説明
offer対象出品の検索と購入者へのオファー送信2

offer — 購入者へのオファー(2 エンドポイント)

GET /find_eligible_items

findEligibleItems — 販売者の現在の出品を評価し、購入者に割引オファーを開始する対象となる出品 ID のセットを返します。1 人以上の購入者が出品に「関心」を示した場合にのみ出品 ID が返されます。

パラメータ場所必須説明
X-EBAY-C-MARKETPLACE-IDヘッダー必須対象出品を検索する eBay マーケットプレイス。
limitクエリ任意ページあたりの最大件数。最小: 1、最大: 200、デフォルト: 10
offsetクエリ任意スキップする結果の数。デフォルト: 0

レスポンス: 200 → PagedEligibleItemCollection / 204 / 400 / 500

POST /send_offer_to_interested_buyers

sendOfferToInterestedBuyers — 出品に興味を示した購入者に割引価格でのオファーを送信します。出品価格から一定の割合で割引するか、新しい割引価格を設定できます。

パラメータ場所必須説明
X-EBAY-C-MARKETPLACE-IDヘッダー必須出品が掲載される eBay マーケットプレイス。
Content-Typeヘッダー必須application/json

リクエストボディ: CreateOffersRequest

レスポンス: 200 → SendOfferToInterestedBuyersCollectionResponse / 400 / 409 / 500

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

オファー

CreateOffersRequest

フィールド説明
allowCounterOfferboolean購入者のカウンターオファーを許可するかどうか
messagestring購入者へのメッセージ
offerDurationTimeDurationオファーの有効期間
offeredItemsarray[OfferedItem]オファーするアイテムの配列

OfferedItem

フィールド説明
listingIdstring出品 ID
priceAmount割引後の価格
discountPercentagestring割引率(%)
quantityinteger数量

Offer

フィールド説明
offerIdstringオファー ID
offerStatusstringオファーステータス
offerTypestringオファータイプ
allowCounterOfferbooleanカウンターオファー許可
messagestringメッセージ
offerDurationTimeDuration有効期間
offeredItemsarray[OfferedItem]オファーアイテム
buyerUser購入者情報
initiatedBystring開始者
creationDatestring作成日時
lastModifiedDatestring最終更新日時
revisionstringリビジョン

SendOfferToInterestedBuyersCollectionResponse

フィールド説明
offersarray[Offer]送信されたオファーの配列

対象アイテム

PagedEligibleItemCollection

フィールド説明
eligibleItemsarray[EligibleItem]対象アイテムの配列
hrefstring現在の結果の URI
nextstring次ページの URI
prevstring前ページの URI
offsetintegerオフセット
limitinteger最大件数
totalinteger総数

EligibleItem

フィールド説明
listingIdstring出品 ID

共通型

Amount

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

TimeDuration

フィールド説明
unitstring時間単位
valueinteger

User

フィールド説明
maskedUsernamestringマスクされたユーザー名

Error

フィールド説明
categorystringエラーカテゴリ
domainstringエラードメイン
errorIdintegerエラー ID
messagestring短いメッセージ
longMessagestring詳細メッセージ
inputRefIdsarray[string]入力参照 ID
outputRefIdsarray[string]出力参照 ID
parametersarray[ErrorParameter]エラーパラメータ
subdomainstringエラーサブドメイン

ErrorParameter

フィールド説明
namestringパラメータ名
valuestringパラメータ値

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

メソッド エンドポイント operationId 説明
GET/find_eligible_itemsfindEligibleItems対象出品を検索
POST/send_offer_to_interested_buyerssendOfferToInterestedBuyers購入者にオファーを送信
トップに戻る