Classified Leads API — client.sell.leads¶
Version v1.0.0 · base path /sell/leads/v1 · async twin: the same methods on
AsyncEbayClient, awaited.
Operations¶
Bases: BaseResource
get_all_classified_leads ¶
get_all_classified_leads(*, end_time: str | None = None, include_messages: str | None = None, start_time: str | None = None, status: str | None = None, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_leads_models.ClassifiedLeadsListResponse
get_all_classified_leads(*, end_time: str | None = None, include_messages: str | None = None, start_time: str | None = None, status: str | None = None, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_all_classified_leads(*, end_time: str | None = None, include_messages: str | None = None, start_time: str | None = None, status: str | None = None, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_leads_models.ClassifiedLeadsListResponse | httpx.Response
This method retrieves leads for all of the seller's active classified ad listings. Optionally, just those matching specified filter criteria can be returned. 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.
get_classified_leads_by_item_id ¶
get_classified_leads_by_item_id(item_id: str, *, end_time: str | None = None, include_messages: str | None = None, start_time: str | None = None, status: str | None = None, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[False] = False) -> sell_leads_models.ClassifiedLead
get_classified_leads_by_item_id(item_id: str, *, end_time: str | None = None, include_messages: str | None = None, start_time: str | None = None, status: str | None = None, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: Literal[True]) -> httpx.Response
get_classified_leads_by_item_id(item_id: str, *, end_time: str | None = None, include_messages: str | None = None, start_time: str | None = None, status: str | None = None, accept_encoding: str | None = None, x_ebay_c_marketplace_id: str | None = None, raw_response: bool = False) -> sell_leads_models.ClassifiedLead | httpx.Response
This method returns a seller account's leads generated by the specified classified ad and includes any contact information that prospective buyers have submitted. Optionally, just those matching specified filter criteria can be returned. Note: This is a (Limited Release) API available only to select developers approved by business units.
Models¶
Amount ¶
Bases: EbayModel
converted_from_currency
class-attribute
instance-attribute
¶
converted_from_currency = Field(None, alias='convertedFromCurrency', description='A three-letter ISO 4217 code that indicates the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required and represents the pre-conversion currency.')
converted_from_value
class-attribute
instance-attribute
¶
converted_from_value = Field(None, alias='convertedFromValue', description='The monetary amount before any conversion is performed in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value in the currency specified by the currency field.')
currency
class-attribute
instance-attribute
¶
currency = Field(None, description='A three-letter ISO 4217 code that indicates the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.')
value
class-attribute
instance-attribute
¶
value = Field(None, description='The monetary amount in the currency specified in the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.')
ContactInformation ¶
Bases: EbayModel
first_name
class-attribute
instance-attribute
¶
first_name = Field(None, alias='firstName', description='The first name of the prospective buyer.')
last_name
class-attribute
instance-attribute
¶
last_name = Field(None, alias='lastName', description='The last name of the prospective buyer.')
phone
class-attribute
instance-attribute
¶
phone = Field(None, description="The prospective buyer's primary phone number.")
postal_code
class-attribute
instance-attribute
¶
postal_code = Field(None, alias='postalCode', description="The prospective buyer's postal code.")
ErrorParameter ¶
LeadFee ¶
Bases: EbayModel
amount
class-attribute
instance-attribute
¶
amount = Field(None, description='A container that returns the amount charged for the lead service with currency information.')
description
class-attribute
instance-attribute
¶
description = Field(None, description='An explanation of the special fee charged.')
LeadStatus ¶
Question ¶
Error ¶
Bases: EbayModel
category
class-attribute
instance-attribute
¶
category = Field(None, description='Identifies the type of erro.')
domain
class-attribute
instance-attribute
¶
domain = Field(None, description='Name for the primary system where the error occurred. This is relevant for application errors.')
error_id
class-attribute
instance-attribute
¶
error_id = Field(None, alias='errorId', description='A unique number to identify the error.')
input_ref_ids
class-attribute
instance-attribute
¶
input_ref_ids = Field(None, alias='inputRefIds', description='An array of request elements most closely associated to the error.')
long_message
class-attribute
instance-attribute
¶
long_message = Field(None, alias='longMessage', description='A more detailed explanation of the error.')
message
class-attribute
instance-attribute
¶
message = Field(None, description="Information on how to correct the problem, in the end user's terms and language where applicable.")
output_ref_ids
class-attribute
instance-attribute
¶
output_ref_ids = Field(None, alias='outputRefIds', description='An array of request elements most closely associated to the error.')
parameters
class-attribute
instance-attribute
¶
parameters = Field(None, description='An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned.')
subdomain
class-attribute
instance-attribute
¶
subdomain = Field(None, description='Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.')
MemberMessageExchange ¶
Bases: EbayModel
creation_date
class-attribute
instance-attribute
¶
creation_date = Field(None, alias='creationDate', description='This is the date the message was created. It is returned if the parent container is returned.')
question
class-attribute
instance-attribute
¶
question = Field(None, description='This contains all the information about the question being asked. It is returned if the parent container is returned.')
response
class-attribute
instance-attribute
¶
response = Field(None, description="This is an answer to the question. It contains the body of the seller's response message, if sent.")
MemberMessage ¶
Bases: EbayModel
member_message_exchange
class-attribute
instance-attribute
¶
member_message_exchange = Field(None, alias='memberMessageExchange', description='An array that provides detailed information about a member-to-member message.')
ClassifiedLeadResponses ¶
Bases: EbayModel
additional_information
class-attribute
instance-attribute
¶
additional_information = Field(None, alias='additionalInformation', description='This field shows the first message that was sent from the prospective buyer to the seller. This will be the same content as in the memberMessageExchange.question.body field, if returned. Note: Retrieve the memberMessageExchange container to retrieve the entire exchange between the seller and the prospective buyer (all messages).')
contact_information
class-attribute
instance-attribute
¶
contact_information = Field(None, alias='contactInformation', description='This container consists of contact information for the prospective buyer. Fields in this container are returned if provided. This container will not be returned if the buyer did not provide any contact information.')
email
class-attribute
instance-attribute
¶
email = Field(None, description='Email address for the prospective buyer, if that buyer was logged in to eBay.')
external_email
class-attribute
instance-attribute
¶
external_email = Field(None, alias='externalEmail', description='Email address for the prospective buyer as entered in the lead form on the View Item page. Provides a way for sellers to contact prospective buyers who choose not to log in to eBay. This applies only to eBay Motors and eBay Motors categories.')
financing_answer
class-attribute
instance-attribute
¶
financing_answer = Field(None, alias='financingAnswer', description='Boolean that indicates if a prospective buyer answered whether or not they would like financing. Entered on the lead form on the View Item page. This applies only to eBay Motors and Motors categories.')
lead_fee
class-attribute
instance-attribute
¶
lead_fee = Field(None, alias='leadFee', description="A container that returns the amount charged for this pay-per-lead contact in the item's site local currency.")
lead_status
class-attribute
instance-attribute
¶
lead_status = Field(None, alias='leadStatus', description='The enumeration value in this field indicates whether or not the seller has responded to the lead or if this is new.')
member_message
class-attribute
instance-attribute
¶
member_message = Field(None, alias='memberMessage', description='Contains any mail message content shared between the seller and prospective buyer. Only returned if the includeMessages boolean is true .')
submitted_time
class-attribute
instance-attribute
¶
submitted_time = Field(None, alias='submittedTime', description='Date and time (in GMT) that the lead was submitted.')
trade_in_make
class-attribute
instance-attribute
¶
trade_in_make = Field(None, alias='tradeInMake', description='The make of the vehicle the prospective buyer would like to trade in. This is entered on the lead form on the View Item page. This applies only to eBay Motors and eBay Motors categories.')
trade_in_model
class-attribute
instance-attribute
¶
trade_in_model = Field(None, alias='tradeInModel', description='The model of the vehicle the prospective buyer would like to trade in. This is entered on the lead form on the View Item page. This applies only to eBay Motors and eBay Motors categories.')
trade_in_year
class-attribute
instance-attribute
¶
trade_in_year = Field(None, alias='tradeInYear', description='The year of the vehicle the prospective buyer would like to trade in. This is entered on the lead form on the View Item page. This applies only to eBay Motors and eBay Motors categories.')
user_id
class-attribute
instance-attribute
¶
user_id = Field(None, alias='userId', description="The eBay user ID of the user who is interested in the seller's item.")
ClassifiedLead ¶
Bases: EbayModel
item_id
class-attribute
instance-attribute
¶
item_id = Field(None, alias='itemId', description='The unique identifier of the listing.')
item_title
class-attribute
instance-attribute
¶
item_title = Field(None, alias='itemTitle', description='The title of the listing. Maximum length: 80')
responses
class-attribute
instance-attribute
¶
responses = Field(None, description='An array of the classified lead responses.')
ClassifiedLeadsListResponse ¶
Bases: EbayModel
classified_leads
class-attribute
instance-attribute
¶
classified_leads = Field(None, alias='classifiedLeads', description="An array of leads for the seller's active classified ad listings.")
total_items
class-attribute
instance-attribute
¶
total_items = Field(None, alias='totalItems', description='The total number of listings returned.')
total_leads
class-attribute
instance-attribute
¶
total_leads = Field(None, alias='totalLeads', description='The total number of leads returned for all listings.')