The Leads API lets sellers return leads generated by their Classified Ad and includes any contact information that prospective buyers have submitted. A seller can retrieve leads for items listed under their own seller account for a specified marketplace optionally filtered by specified search criteria. Use this resource to retrieve sales-lead information for lead-generating classified ad listings.
Note:
This is a (Limited Release) API available only to select developers approved by business units. For information on how to obtain access to this API in production, please contact eBay support.
Technical overview
This API contains the following resource:
- classified_lead - Returns all leads generated by a seller's Classified Ad, or leads generated for a seller's specified Classified Ad.
Business use cases
The Leads API supports the following use case.
Seller retrieves the details of leads
By using the classified_lead methods, you can return leads generated by a seller's Classified Ad.
Requirements and restrictions
The following are the requirements and restrictions for the Sell Leads API.
Requirements
-
Seller can retrieve leads for items listed under their own seller account.
-
Seller can only return the leads generated by a Classified Ad and any contact information that prospective buyers have submitted.
Scope restrictions
The following scope supports retrieving the details of leads.
https://api.ebay.com/oauth/api_scope/sell.leads