Leads API ドキュメント

リード API（Sell Leads API）

Leads API により、セラーはクラシファイド広告リスティングから生成されたリード情報を取得できます。見込みバイヤーが送信した連絡先情報も含まれます。セラーは指定されたマーケットプレイスのリスティングアイテムに対するリードを取得でき、オプションで検索条件によるフィルタリングも可能です。

⚠ Limited Release（限定リリース）: この API はビジネスユニットに承認された一部のデベロッパーのみが利用可能です。本番環境でのアクセス取得については、eBay サポートにお問い合わせください。

バージョン: v1.0.0

ベースURL: https://apiz.ebay.com/sell/leads/v1

認証（OAuth スコープ）

スコープ	説明
`https://api.ebay.com/oauth/api_scope/sell.leads`	クラシファイド広告リードの取得

リソース一覧

Sell Leads API は 1 リソース（classified_lead）、合計 2 エンドポイント（すべて GET）で構成されています。

リソース	説明	数
classified_lead	クラシファイド広告リードの取得	2

classified_lead — リード管理（2 エンドポイント）

GET `/classified_lead`

getAllClassifiedLeads — セラーのすべてのアクティブなクラシファイド広告リスティングに対するリードを取得します。オプションでフィルタ条件に一致するもののみ返すことも可能です。

Limited Release: ビジネスユニットに承認された一部のデベロッパーのみ利用可能。

パラメータ	場所	必須	説明
`startTime`	クエリ	任意	開始時間（ISO 8601）。この日時以降に作成されたリードのみ。`endTime` と独立使用可。
`endTime`	クエリ	任意	終了時間（ISO 8601）。この日時以前に作成されたリードのみ。`startTime` と独立使用可。
`status`	クエリ	任意	リードステータス: `Answered` / `Unanswered`
`includeMessages`	クエリ	任意	`true` でメッセージを含む。デフォルト: `false`
`Content-Type`	ヘッダー	必須	`application/json`
`Accept-Encoding`	ヘッダー	任意	`gzip`

レスポンス: 200 / 204 / 400 / 401 / 500

エラーコード（400）:

コード	説明
352003	無効な UTC 時間。形式: YYYY-MM-DDTHH:MM:SSZ
352004	無効な日付。日付は過去である必要があります。
352005	無効な日付範囲。endTime は startTime より後である必要があります。
352006	無効なステータス。有効値: Answered / Unanswered
352007	無効な includeMessages 値。有効値: true / false

GET `/classified_lead/{itemId}`

getClassifiedLeadsByItemId — 指定されたクラシファイド広告リスティングに対するリードを取得します。見込みバイヤーの連絡先情報も含まれます。

Limited Release: ビジネスユニットに承認された一部のデベロッパーのみ利用可能。

パラメータ	場所	必須	説明
`itemId`	パス	必須	リスティングの一意の識別子
`startTime`	クエリ	任意	開始時間（ISO 8601）。独立使用可。
`endTime`	クエリ	任意	終了時間（ISO 8601）。独立使用可。
`status`	クエリ	任意	リードステータス: `Answered` / `Unanswered`
`includeMessages`	クエリ	任意	メッセージを含むか。デフォルト: `true`
`Content-Type`	ヘッダー	必須	`application/json`
`Accept-Encoding`	ヘッダー	任意	`gzip`

レスポンス: 200 / 204 / 400 / 401 / 500

追加エラーコード（400）:

コード	説明
352002	無効なアイテム ID。有効なアイテム ID を指定してください。

主要スキーマ定義（全 11 スキーマ）

ClassifiedLeadsListResponse

フィールド	型	説明
`classifiedLeads`	array[ClassifiedLead]	アクティブなクラシファイド広告リスティングのリード配列
`totalItems`	integer	返されたリスティングの総数
`totalLeads`	integer	全リスティングのリード総数

ClassifiedLead

フィールド	型	説明
`itemId`	string	リスティングの一意の識別子
`itemTitle`	string	リスティングのタイトル（最大 80 文字）
`responses`	array[ClassifiedLeadResponses]	リードレスポンスの配列

ClassifiedLeadResponses

フィールド	型	説明
`additionalInformation`	string	見込みバイヤーからセラーへの最初のメッセージ
`contactInformation`	ContactInformation	見込みバイヤーの連絡先情報
`email`	string	eBay にログインしている見込みバイヤーのメールアドレス
`externalEmail`	string	リードフォームで入力されたメールアドレス（eBay Motors のみ）
`financingAnswer`	boolean	融資希望の有無（eBay Motors のみ）
`leadFee`	LeadFee	リードサービスの請求額
`leadStatus`	string	リードステータス（New / Responded 等）
`memberMessage`	MemberMessage	メールメッセージ内容（`includeMessages=true` の場合のみ）
`submittedTime`	string	リード送信日時（GMT）
`tradeInMake`	string	下取り車両のメーカー（eBay Motors のみ）
`tradeInModel`	string	下取り車両のモデル（eBay Motors のみ）
`tradeInYear`	string	下取り車両の年式（eBay Motors のみ）
`userId`	string	関心を持つバイヤーの eBay ユーザー ID

ContactInformation

フィールド	型	説明
`firstName`	string	名
`lastName`	string	姓
`phone`	string	電話番号
`postalCode`	string	郵便番号

LeadFee

フィールド	型	説明
`amount`	Amount	請求金額と通貨情報
`description`	string	特別手数料の説明

Amount

フィールド	型	説明
`currency`	string	ISO 4217 通貨コード
`value`	string	金額
`convertedFromCurrency`	string	変換前の通貨コード
`convertedFromValue`	string	変換前の金額

MemberMessage / MemberMessageExchange / Question

スキーマ	主なフィールド
MemberMessage	memberMessageExchange (array[MemberMessageExchange])
MemberMessageExchange	creationDate (string), question (Question), response (string)
Question	body (string), messageID (integer)

その他のスキーマ: Error, ErrorParameter

エンドポイント一覧（全 2 エンドポイント）

メソッド	エンドポイント	operationId	説明
GET	`/classified_lead`	getAllClassifiedLeads	全クラシファイド広告リードの取得
GET	`/classified_lead/{itemId}`	getClassifiedLeadsByItemId	指定アイテムのリード取得