AdFormatLeadType
Contains prospective buyer contact information and other details associated with a lead for an ad format listing.

Types that use AdFormatLeadType:

Call that uses one or more fields of AdFormatLeadType:

Fields

AdditionalInformation ( string )
Address ( AddressType )
Answer1 ( boolean )
Answer2 ( boolean )
BestTimeToCall ( string )
Email ( string )
ExternalEmail ( string )
FinancingAnswer ( boolean )
ItemID ( ItemIDType (string) )
ItemTitle ( string )
LeadFee ( AmountType (double) )
MemberMessage ( MemberMessageExchangeArrayType )
PurchaseTimeFrame ( string )
Status ( AdFormatLeadStatusCodeType )
SubmittedTime ( dateTime )
TradeInMake ( string )
TradeInModel ( string )
TradeInYear ( string )
UserID ( UserIDType (string) )

AdditionalInformation ( string ) [0..1]
Message sent from the prospective buyer to the seller. Same content as in the AdFormatLead.MemberMessage.MemberMessageExchange.Question.Body node (that is only displayed if IncludeMemberMessages = true is included in the request). The advantage of retrieving the MemberMessageExchange node, however, is that you retrieve the entire exchange between the seller and the lead.
See the Field Index to learn which calls use AdditionalInformation.

Address ( AddressType ) [0..1]
Address information for the prospective buyer. Not returned or returned self-closed if information is unavailable.
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. Not returned if 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 ID of the item that the lead is for.
See the Field Index to learn which calls use ItemID.

ItemTitle ( string ) [0..1]
The title of the item that the lead is for.
See the Field Index to learn which calls use ItemTitle.

LeadFee ( AmountType (double) ) [0..1]
The total fee from email and phone leads. Applies to the item specified in the request. LeadFee is part the pay-per-lead feature.
See the Field Index to learn which calls use LeadFee.

MemberMessage ( MemberMessageExchangeArrayType ) [0..1]
Contains any mail message content shared between the seller and lead.
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.

Status ( see AdFormatLeadStatusCodeType for possible values ) [0..1]
Status of 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 ID of the user who is interested in the seller's item.
See the Field Index to learn which calls use UserID.

This document was generated with a customized version of the apireferencedocs tool.

© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.