GetAdFormatLeads - Call Reference - eBay Trading Web Services

GetAdFormatLeads

Retrieves sales lead information for a lead generation listing. GetAdFormatLeadsRequest returns the number of leads for an ad and any contact information that the prospective buyer submitted.

GetAdFormatLeads Input

The box below lists all fields that could be included in the call request. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetAdFormatLeadsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel nodes here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <OutputSelector> string </OutputSelector>
  <!-- ... more OutputSelector nodes here ... -->
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
  <!-- Call-specific Input Fields -->
  <EndCreationTime> dateTime </EndCreationTime>
  <IncludeMemberMessages> boolean </IncludeMemberMessages>
  <ItemID> ItemIDType (string) </ItemID>
  <StartCreationTime> dateTime </StartCreationTime>
  <Status> MessageStatusTypeCodeType </Status>
</GetAdFormatLeadsRequest>

Argument	Type	Reqd?	Meaning
Standard Input Fields [Jump to call-specific fields]
DetailLevel	DetailLevelCodeType (repeatable)	Optional	Detail levels are instructions that define standard subsets of data to return for particular data components (e.g., each Item, Transaction, or User) within the response payload. For example, a particular detail level might cause the response to include buyer-related data in every result (e.g., for every Item), but no seller-related data. Specifying a detail level is like using a predefined attribute list in the SELECT clause of an SQL query. Use the DetailLevel element to specify the required detail level that the client application needs pertaining to the data components that are applicable to the request. The DetailLevelCodeType defines the global list of available detail levels for all request types. Most request types support certain detail levels or none at all. If you pass a detail level that exists in the schema but that isn't valid for a particular request, eBay ignores it processes the request without it. For each request type, see the detail level tables in the Input/Output Reference to determine which detail levels are applicable and which elements are returned for each applicable detail level. (Some detail level tables are still in the eBay Web Services guide. They will be moved to the Input/Output Reference in a future release.) Note that DetailLevel is required input for GetMyMessages. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you do use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. Applicable values: • ReturnAll (in) Returns all available data. With GetSellerList and other calls that retrieve large data sets, please avoid using ReturnAll when possible. For example, if you use GetSellerList, use a GranularityLevel or use the GetSellerEvents call instead. If you use ReturnAll with GetSellerList, use a small EntriesPerPage value and a short EndTimeFrom/EndTimeTo range for better performance. (Not all values in DetailLevelCodeType apply to this field.)
ErrorLanguage	string	Optional	Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US). ID--- country ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong See Tags for the Identification of Languages.
MessageID	string	Optional	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
OutputSelector	string (repeatable)	Optional	You can use the OutputSelector field to restrict the data returned by this call. When you make a call such as GetItem that retrieves data from eBay, the OutputSelector field is useful for restricting the data returned. This field makes the call response easier to use, especially when a large payload would be returned. If you use the OutputSelector field, the output data will include only the fields you specified in the request. For example, if you are using GetItem and you want the item data in the response to be restricted to the ViewItemURL (the URL where a user can view the listing) and BuyItNowPrice, then within the GetItem request, specify those output fields. To use this field, see the information at the following link. See Selecting Fields to Retrieve.
Version	string	Conditional	The version number of the API code that you are programming against (e.g., 549). The version you specify for a call has these basic effects: - It indicates the version of the code lists and other data that eBay should use to process your request. - It indicates the schema version you are using. You need to use a version that is greater than or equal to the lowest supported version. For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using. For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.) See: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version
WarningLevel	WarningLevelCodeType	Optional	Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request. An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment. WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors. We recommend that you only use this during development and debugging. Do not use this in requests in your production code. Applicable values: • High (in) Return warnings when the application passes unrecognized or deprecated elements in a request. • Low (in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified. See Warning Level.
Call-specific Input Fields
EndCreationTime	dateTime	Conditional	Used with StartCreationTime to limit the returned leads for a user to only those with a creation date less than or equal to the specified date and time.
IncludeMemberMessages	boolean	Optional	Boolean which indicates whether to return mail messages for this lead in a MemberMessage node.
ItemID	ItemIDType (string)	Optional	The unique identifier of an item listed on the eBay site. Returned by eBay when the item is created. This ID must correspond to an ad format item. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits).
StartCreationTime	dateTime	Conditional	Used with EndCreationTime to limit the returned leads for a user to only those with a creation date greater than or equal to the specified date and time.
Status	MessageStatusTypeCodeType	Optional	Filters the leads based on their status. Applicable values: • Answered (in/out) The question has been answered at least once. • CustomCode (in/out) Reserved for future or internal use. • Unanswered (in/out) The question has not yet been answered.

GetAdFormatLeads Output

The box below lists all fields that might be returned in the call response. To learn more about an individual field or its type, click its name in the box (or scroll down to find it in the table below the box).

See also Samples.

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).

<?xml version="1.0" encoding="utf-8"?>
<GetAdFormatLeadsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType 
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType 
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
  <!-- Call-specific Output Fields -->
  <AdFormatLead> AdFormatLeadType 
    <AdditionalInformation> string </AdditionalInformation>
    <Address> AddressType 
      <CityName> string </CityName>
      <FirstName> string </FirstName>
      <LastName> string </LastName>
      <Phone2> string </Phone2>
      <PostalCode> string </PostalCode>
      <StateOrProvince> string </StateOrProvince>
      <Street1> string </Street1>
    </Address>
    <Answer1> boolean </Answer1>
    <Answer2> boolean </Answer2>
    <BestTimeToCall> string </BestTimeToCall>
    <Email> string </Email>
    <ExternalEmail> string </ExternalEmail>
    <FinancingAnswer> boolean </FinancingAnswer>
    <FirstName> string </FirstName>
    <ItemID> ItemIDType (string) </ItemID>
    <ItemTitle> string </ItemTitle>
    <LastName> string </LastName>
    <LeadFee> AmountType (double) </LeadFee>
    <MemberMessage> MemberMessageExchangeArrayType 
      <MemberMessageExchange> MemberMessageExchangeType 
        <CreationDate> dateTime </CreationDate>
        <Question> MemberMessageType 
          <Body> string </Body>
        </Question>
        <Response> string </Response>
        <!-- ... more Response nodes here ... -->
      </MemberMessageExchange>
      <!-- ... more MemberMessageExchange nodes here ... -->
    </MemberMessage>
    <Phone> string </Phone>
    <Phone2> string </Phone2>
    <PurchaseTimeFrame> string </PurchaseTimeFrame>
    <Status> AdFormatLeadStatusCodeType </Status>
    <SubmittedTime> dateTime </SubmittedTime>
    <TradeInMake> string </TradeInMake>
    <TradeInModel> string </TradeInModel>
    <TradeInYear> string </TradeInYear>
    <UserID> UserIDType (string) </UserID>
  </AdFormatLead>
  <!-- ... more AdFormatLead nodes here ... -->
  <AdFormatLeadCount> int </AdFormatLeadCount>
</GetAdFormatLeadsResponse>

Return Value	Type	Returned?	Meaning
Standard Output Fields [Jump to call-specific fields]
Ack	AckCodeType	Always	A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for Ack. Applicable values: • CustomCode (out) Reserved for internal or future use. • Failure (out) Request processing failed • Success (out) Request processing succeeded • Warning (out) Request processing completed with warning information being included in the response message (Not all values in AckCodeType apply to this field.)
Build	string	Always	This refers to the specific software build that eBay used when processing the request and generating the response. This includes the version number plus additional information. eBay Developer Support may request the build information when helping you resolve technical issues.
CorrelationID	string	Conditionally	In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors	ErrorType (repeatable)	Conditionally	A list of application-level errors (if any) that occurred when eBay processed the request. See Error Handling.
Errors.ErrorClassification	ErrorClassificationCodeType	Conditionally	API errors are divided between two classes: system errors and request errors. Applicable values: • CustomCode (out) Reserved for internal or future use. • RequestError (out) An error has occurred either as a result of a problem in the sending application or because the application's end-user has attempted to submit invalid data (or missing data). In these cases, do not retry the request. The problem must be corrected before the request can be made again. If the problem is due to something in the application (such as a missing required field), the application must be changed. If the problem is a result of end-user data, the application must alert the end-user to the problem and provide the means for the end-user to correct the data. Once the problem in the application or data is resolved, resend the request to eBay with the corrected data. • SystemError (out) Indicates that an error has occurred on the eBay system side, such as a database or server down. An application can retry the request as-is a reasonable number of times (eBay recommends twice). If the error persists, contact Developer Technical Support. Once the problem has been resolved, the request may be resent in its original form.
Errors.ErrorCode	token	Conditionally	A unique code that identifies the particular error condition that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.
Errors.ErrorParameters	ErrorParameterType (repeatable)	Conditionally	This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters [ attribute ParamID ]	string	Conditionally	The index of the parameter in the list of parameter types returned within the error type.
Errors.ErrorParameters.Value	string	Conditionally	The value of the variable (e.g., the attribute set ID)
Errors.LongMessage	string	Conditionally	A more detailed description of the condition that raised the error.
Errors.SeverityCode	SeverityCodeType	Conditionally	Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. Applicable values: • CustomCode (out) Reserved for internal or future use • Error (out) Application-level error • Warning (out) Warning or informational error
Errors.ShortMessage	string	Conditionally	A brief description of the condition that raised the error.
HardExpirationWarning	string	Conditionally	Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
Timestamp	dateTime	Always	This value represents the date and time when eBay processed the request. The time zone of this value is GMT and the format is the ISO 8601 date and time format (YYYY-MM-DDTHH:MM:SS.SSSZ). See Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version	string	Always	The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response.
Call-specific Output Fields
AdFormatLead	AdFormatLeadType (repeatable)	Conditionally	Contains contact and other information for one lead. One node is returned for each lead. Only returned at a detail level of ReturnAll. At least one lead must be available for the specified item to return AdFormatLead. DetailLevel: ReturnAll.
AdFormatLead .AdditionalInformation	string	Conditionally	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. DetailLevel: ReturnAll.
AdFormatLead.Address	AddressType	Conditionally	Address information for the prospective buyer. Not returned or returned self-closed if information is unavailable. DetailLevel: ReturnAll.
AdFormatLead.Address.CityName	string	Conditionally	The name of the user's city. Also applicable to Half.com (for GetOrders). Max length: 64. DetailLevel: ReturnAll.
AdFormatLead.Address.FirstName	string	Conditionally	Displays the first name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
AdFormatLead.Address.LastName	string	Conditionally	Displays the last name of the seller (in a business card format) if the seller's SellerBusinessCodeType is set to 'Commercial'. DetailLevel: ItemReturnAttributes, ItemReturnDescription, ReturnAll. Also returned if DetailLevel is not provided on input.
AdFormatLead.Address.Phone2	string	Conditionally	Secondary Phone number of the lead. Not returned if information is unavailable. DetailLevel: ReturnAll.
AdFormatLead.Address .PostalCode	string	Conditionally	User's postal code. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. Also applicable to Half.com (for GetOrders). Max length: 12. DetailLevel: ReturnAll.
AdFormatLead.Address .StateOrProvince	string	Conditionally	The region of the user's address. Also applicable to Half.com (for GetOrders). Max length: 64. DetailLevel: ReturnAll.
AdFormatLead.Address.Street1	string	Conditionally	Line 1 of the user's street address. Also applicable to Half.com (for GetOrders). Max length: 100. DetailLevel: ReturnAll.
AdFormatLead.Answer1	boolean	Conditionally	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. DetailLevel: ReturnAll.
AdFormatLead.Answer2	boolean	Conditionally	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. DetailLevel: ReturnAll.
AdFormatLead.BestTimeToCall	string	Conditionally	The time of day when the prospective buyer prefers to be contacted by the seller. Not returned if information is unavailable. DetailLevel: ReturnAll.
AdFormatLead.Email	string	Conditionally	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. DetailLevel: ReturnAll.
AdFormatLead.ExternalEmail	string	Conditionally	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. Max length: 128. DetailLevel: ReturnAll.
AdFormatLead.FinancingAnswer	boolean	Conditionally	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. DetailLevel: ReturnAll.
AdFormatLead.FirstName	string	Conditionally	First name of the prospective buyer. DetailLevel: ReturnAll.
AdFormatLead.ItemID	ItemIDType (string)	Conditionally	The ID of the item that the lead is for. DetailLevel: ReturnAll.
AdFormatLead.ItemTitle	string	Conditionally	The title of the item that the lead is for. DetailLevel: ReturnAll.
AdFormatLead.LastName	string	Conditionally	Last name of the prospective buyer. DetailLevel: ReturnAll.
AdFormatLead.LeadFee	AmountType (double)	Conditionally	The total fee from email and phone leads. Applies to the item specified in the request. LeadFee is part the pay-per-lead feature. DetailLevel: ReturnAll.
AdFormatLead.MemberMessage	MemberMessageExchangeArrayType	Conditionally	Contains any mail message content shared between the seller and lead. DetailLevel: ReturnAll.
AdFormatLead.MemberMessage .MemberMessageExchange	MemberMessageExchangeType (repeatable)	Conditionally	Information about individual messages. Returned if the parent container is returned. DetailLevel: ReturnAll.
AdFormatLead.MemberMessage .MemberMessageExchange .CreationDate	dateTime	Conditionally	Date the message was created. In the request, used to filter response. Returned if the parent container is returned. DetailLevel: ReturnAll.
AdFormatLead.MemberMessage .MemberMessageExchange .Question	MemberMessageType	Conditionally	Contains all the information about the question being asked. Returned if the parent container is returned. DetailLevel: ReturnAll.
AdFormatLead.MemberMessage .MemberMessageExchange .Question.Body	string	Conditionally	Message content. Max length: 1000. DetailLevel: ReturnAll.
AdFormatLead.MemberMessage .MemberMessageExchange .Response	string (repeatable)	Conditionally	An answer to the question. Returned if the parent container is returned. For GetAdFormatLeads, returned if the seller responded to the lead's question. Contains the body of the seller's response message. DetailLevel: ReturnAll.
AdFormatLead.Phone	string	Conditionally	Phone number of the prospective buyer. Not returned if information is unavailable. DetailLevel: ReturnAll.
AdFormatLead.Phone2	string	Conditionally	Secondary Phone number of the lead. Not returned if information is unavailable. DetailLevel: ReturnAll.
AdFormatLead.PurchaseTimeFrame	string	Conditionally	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 Max length: 255. DetailLevel: ReturnAll.
AdFormatLead.Status	AdFormatLeadStatusCodeType	Conditionally	Status of the lead. Applicable values: • CustomCode (out) Reserved for internal or future use. • New (out) A new message from a prospective buyer that the seller has not yet responded to. • Responded (out) A message from a prospective buyer that the seller has responded to. DetailLevel: ReturnAll.
AdFormatLead.SubmittedTime	dateTime	Conditionally	Date and time (in GMT) that the lead was submitted. DetailLevel: ReturnAll.
AdFormatLead.TradeInMake	string	Conditionally	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. Max length: 128. DetailLevel: ReturnAll.
AdFormatLead.TradeInModel	string	Conditionally	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. Max length: 128. DetailLevel: ReturnAll.
AdFormatLead.TradeInYear	string	Conditionally	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. Max length: 32. DetailLevel: ReturnAll.
AdFormatLead.UserID	UserIDType (string)	Conditionally	The eBay ID of the user who is interested in the seller's item. DetailLevel: ReturnAll.
AdFormatLeadCount	int	Conditionally	The total number of leads returned. Only returned if you do not specify a detail level. DetailLevel: Returned if DetailLevel is not provided on input.

GetAdFormatLeads Detail Controls

Detail Control: DetailLevel

The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)

none	The field is returned if DetailLevel is not specified on input.
Y	The field is always returned.
(Y)	The field is conditionally returned. See the field description for clarification of conditions.

Output Field	ItemReturnAttributes	ItemReturnDescription	ReturnAll	none
AdFormatLead	-	-	(Y)	-
AdFormatLead.AdditionalInformation	-	-	(Y)	-
AdFormatLead.Address	-	-	(Y)	-
AdFormatLead.Address.CityName	-	-	(Y)	-
AdFormatLead.Address.FirstName	(Y)	(Y)	(Y)	(Y)
AdFormatLead.Address.LastName	(Y)	(Y)	(Y)	(Y)
AdFormatLead.Address.Phone2	-	-	(Y)	-
AdFormatLead.Address.PostalCode	-	-	(Y)	-
AdFormatLead.Address.StateOrProvince	-	-	(Y)	-
AdFormatLead.Address.Street1	-	-	(Y)	-
AdFormatLead.Answer1	-	-	(Y)	-
AdFormatLead.Answer2	-	-	(Y)	-
AdFormatLead.BestTimeToCall	-	-	(Y)	-
AdFormatLead.Email	-	-	(Y)	-
AdFormatLead.ExternalEmail	-	-	(Y)	-
AdFormatLead.FinancingAnswer	-	-	(Y)	-
AdFormatLead.FirstName	-	-	(Y)	-
AdFormatLead.ItemID	-	-	(Y)	-
AdFormatLead.ItemTitle	-	-	(Y)	-
AdFormatLead.LastName	-	-	(Y)	-
AdFormatLead.LeadFee	-	-	(Y)	-
AdFormatLead.MemberMessage	-	-	(Y)	-
AdFormatLead.MemberMessage.MemberMessageExchange	-	-	(Y)	-
AdFormatLead.MemberMessage.MemberMessageExchange.CreationDate	-	-	(Y)	-
AdFormatLead.MemberMessage.MemberMessageExchange.Question	-	-	(Y)	-
AdFormatLead.MemberMessage.MemberMessageExchange.Question.Body	-	-	(Y)	-
AdFormatLead.MemberMessage.MemberMessageExchange.Response	-	-	(Y)	-
AdFormatLead.Phone	-	-	(Y)	-
AdFormatLead.Phone2	-	-	(Y)	-
AdFormatLead.PurchaseTimeFrame	-	-	(Y)	-
AdFormatLead.Status	-	-	(Y)	-
AdFormatLead.SubmittedTime	-	-	(Y)	-
AdFormatLead.TradeInMake	-	-	(Y)	-
AdFormatLead.TradeInModel	-	-	(Y)	-
AdFormatLead.TradeInYear	-	-	(Y)	-
AdFormatLead.UserID	-	-	(Y)	-
AdFormatLeadCount	-	-	-	(Y)

GetAdFormatLeads Samples

An inline sample will be added in a future release. Please refer to the Samples section of the eBay Web Services Guide chapter for GetAdFormatLeads.

GetAdFormatLeads Change History

Version	Description
563 2008-04-30	StartCreationTime, EndCreationTime (added): You can use these fields to retrieve only those leads for a user that fall within a specified time window.
561 2008-04-16	ExternalEmail, PurchaseTimeFrame, TradeInYear, TradeInMake, TradeInModel, FinancingAnswer, Answer1 and Answer2 in AdFormatLeadType (added): New fields associated with GetAdFormatLeads added to retrieve lead information submitted via form on the View Item page.
507 2007-04-04	LeadFee (added): Added for the pay-per-lead feature, applicable in upcoming months on the US site.
499 2007-02-07	AdFormatLead (modified): Two new elements in the request, Status and IncludeMemberMessages. Several new elements returned including ItemID, ItemTitle, Phone2, Status, UserID, and the MemberMessage container.
489 2006-11-29	AdFormatLead.Email (doc change): Updated the Email annotation to remove text that indicated a transactional relationship was needed to retrieve an email address. This restriction does not apply to email addresses retrieved from prospective buyers for ad format listings via GetAdFormatLeads.

User-Contributed Notes

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

eBay Trading API Call Reference Version 573

eBay Trading API
Call Reference Version 573