eBay Trading APIVersion 1111

AdFormatLeadType

This type is used by the AdFormatLead container that is returned in the GetAdFormatLeads call response. An AdFormatLead container will be returned for each user that has expressed interest in the Classified Ad listing that was specified by the seller in the GetAdFormatLeads call request. Each AdFormatLead container consists of prospective buyer contact information and other details associated with a lead for a Classified Ad listing.

Type that uses AdFormatLeadType:

Call that uses AdFormatLeadType:

Fields



AdditionalInformation ( string ) [0..1]
This field shows the message that was sent from the prospective buyer to the seller. This will be the same content that is returned in the AdFormatLead.MemberMessage.MemberMessageExchange.Question.Body field (that is only displayed if the IncludeMemberMessages boolean field is included in the request and set to true). The advantage of retrieving the MemberMessageExchange node, however, is that you retrieve the entire exchange between the seller and the prospective buyer.
See the Field Index to learn which calls use AdditionalInformation.

Address ( AddressType ) [0..1]
This container consists of contact information for the prospective buyer. This container will not be returned if the buyer did not provide any contact information.
See the Field Index to learn which calls use Address.

Answer1 ( boolean ) [0..1]
This field corresponds to a configurable question on the lead form in the View Item web page. The corresponding question is site-specific. To determine the question for a specific site, you must view the form in the web flow for the given site. This field applies to Classified Ad format listings in Motors categories only.
See the Field Index to learn which calls use Answer1.

Answer2 ( boolean ) [0..1]
This field corresponds to a configurable question on the lead form in the View Item web page. The corresponding question is site-specific. To determine the question for a specific site, you must view the form in the web flow for the given site. This field applies to Classified Ad format listings in Motors categories only.
See the Field Index to learn which calls use Answer2.

BestTimeToCall ( string ) [0..1]
The time of day when the prospective buyer prefers to be contacted by the seller. This field is not returned if this information is unavailable.
See the Field Index to learn which calls use BestTimeToCall.

Email ( string ) [0..1]
Email address for the prospective buyer. If the prospective buyer chooses to hide his email address when contacting the seller, this element contains two dashes (--) instead of an email address.
See the Field Index to learn which calls use Email.

ExternalEmail ( string ) [0..1]
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 to only eBay Motors and eBay Motors categories.
See the Field Index to learn which calls use ExternalEmail.

FinancingAnswer ( boolean ) [0..1]
Prospective buyer answer whether or not the prospective buyer would like financing. Entered on the lead form on the View Item page. Applies to eBay Motors and Motors categories only. Financing response meanings: 0= no response,1= yes, 2= no.
See the Field Index to learn which calls use FinancingAnswer.

ItemID ( ItemIDType (string) ) [0..1]
The unique identifier of the listing.
See the Field Index to learn which calls use ItemID.

ItemTitle ( string ) [0..1]
The title of the listing.
See the Field Index to learn which calls use ItemTitle.

LeadFee ( AmountType (double) ) [0..1]
Not used by any call.

The pay-per-lead feature is no longer available, and this field is scheduled to be removed from the WSDL.
See the Field Index to learn which calls use LeadFee.

Contains any mail message content shared between the seller and prospective buyer.
See the Field Index to learn which calls use MemberMessage.

PurchaseTimeFrame ( string ) [0..1]
Prospective buyer's time frame for purchasing a vehicle as entered in the Lead form on View Item page for eBay Motors and eBay Motors categories. Purchasing Time Frames include:
  • within next 3 days
  • within a week
  • within a month
  • within three months
  • in more than three months
  • within an undecided time frame
See the Field Index to learn which calls use PurchaseTimeFrame.

The enumeration value in this field will indicate whether or not the seller has responded to the lead.
See the Field Index to learn which calls use Status.

SubmittedTime ( dateTime ) [0..1]
Date and time (in GMT) that the lead was submitted.
See the Field Index to learn which calls use SubmittedTime.

TradeInMake ( string ) [0..1]
The make of the vehicle the prospective buyer would like to trade in. Entered on the lead form on the View Item page. Applies to eBay Motors and Motors categories only.
See the Field Index to learn which calls use TradeInMake.

TradeInModel ( string ) [0..1]
The model of the vehicle the prospective buyer would like to trade in. Entered on the lead form on the View Item page. Applies to eBay Motors and Motors categories only.
See the Field Index to learn which calls use TradeInModel.

TradeInYear ( string ) [0..1]
The year of the vehicle the prospective buyer would like to trade in. Entered on the lead form on the View Item page. Applies to eBay Motors and Motors categories only.
See the Field Index to learn which calls use TradeInYear.

UserID ( UserIDType (string) ) [0..1]
The eBay user ID of the user who is interested in the seller's item.
See the Field Index to learn which calls use UserID.