GetAdFormatLeads

Use this call to retrieve sales-lead information for a lead-generation listing (such as a Classified Ad).

GetAdFormatLeadsRequest returns the number of leads generated by a Classified Ad and any contact information that prospective buyers have submitted.

The Classified Ad listing format was created for people who want to get in contact with as many interested buyers as possible. You can use Classified Ads to list items such as Real Estate property or an automobile. When you list an item using the Classified Ad format, there is no bidding on the item. Instead, buyers can express interest in the item and supply contact information. When a buyer submits an expression of interest, the buyer information is saved as a lead in the system. Use this call to retrieve the leads associated with your Classified Ad items.

Only the seller who listed the item can request Classified Ad leads associated with that item. Thus, in a call to GetAdFormatLeadsRequest, the value passed in the RequestToken argument identifies the owner of the Classified Ad listing. The item specified the request's ItemID field must be a Classified Ad, listed in a category that supports this item type.

Input

See also Samples.

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 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 does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

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

 If the following output selectors are used: 

...
 <OutputSelector>ViewItemURL</OutputSelector>
 <OutputSelector>BuyItNowPrice</OutputSelector> 
... 

 ...the response might look like the following 

  <Item>
 <BuyItNowPrice currencyID="USD">0.0</BuyItNowPrice>
 <ListingDetails>
 <ViewItemURL>http://www.ebay.com/itm/Tag-Heuer-Mens-Watch/182879833261</ViewItemURL>
 </ListingDetails>
 </Item>  

Output

See also Samples.

The box below lists all fields that might be returned in the 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 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).

<?xml version="1.0" encoding="utf-8"?>
<GetAdFormatLeadsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <AdFormatLead> AdFormatLeadType
    <AdditionalInformation> string </AdditionalInformation>
    <Address> AddressType
      <CityName> string </CityName>
      <FirstName> string </FirstName>
      <LastName> string </LastName>
      <Phone> string </Phone>
      <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>
    <ItemID> ItemIDType (string) </ItemID>
    <ItemTitle> string </ItemTitle>
    <MemberMessage> MemberMessageExchangeArrayType
      <MemberMessageExchange> MemberMessageExchangeType
        <CreationDate> dateTime </CreationDate>
        <Question> MemberMessageType
          <Body> string </Body>
        </Question>
        <Response> string </Response>
        <!-- ... more Response values allowed here ... -->
      </MemberMessageExchange>
      <!-- ... more MemberMessageExchange nodes allowed here ... -->
    </MemberMessage>
    <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 allowed here ... -->
  <AdFormatLeadCount> int </AdFormatLeadCount>
  <!-- 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 allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetAdFormatLeadsResponse>

Detail Controls

DetailLevel

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

The none column indicates the fields that are returned when you do not specify a DetailLevel.

Samples

New to making API calls? Please see Making a Call.

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Retrieves Classified Ad leads.

Description

The ItemID specified in the query represents an item that was listed as a Classified Ad. By setting DetailLevel to ReturnAll, the call retrieves the current set of leads, if any are available. Without a DetailLevel, the call returns the count of available leads.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?> 
<GetAdFormatLeadsRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials> 
     <eBayAuthToken>A*******3</eBayAuthToken> 
  </RequesterCredentials> 
  <ItemID>4*********1</ItemID> 
  <DetailLevel>ReturnAll</DetailLevel> 
</GetAdFormatLeadsRequest> 

Output

XML format.
<?xml version="1.0" encoding="utf-8"?> 
<GetAdFormatLeadsResponse xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <Timestamp>2019-11-04T17:52:10.895Z</Timestamp> 
  <Ack>Success</Ack> 
  <Version>1131</Version> 
  <Build>E1131_CORE_API6_19105226_R1</Build> 
  <AdFormatLead> 
    <AdditionalInformation>Are the neighbors noisy?</AdditionalInformation> 
    <Address> 
      <Street1>1*********t</Street1> 
      <CityName>San Jose</CityName> 
      <StateOrProvince>CA</StateOrProvince> 
      <PostalCode>95125</PostalCode> 
    </Address> 
    <BestTimeToCall>8:00 p.m.</BestTimeToCall> 
    <Email>a********@*****.com</Email> 
    <FirstName>****y</FirstName> 
    <LastName>B****t</LastName> 
    <Phone>1-***-***-***2</Phone> 
    <SubmittedTime>2019-09-02T02:55:43.000Z</SubmittedTime> 
  </AdFormatLead> 
  <AdFormatLead> 
    <AdditionalInformation>What kind of view does the place have?</AdditionalInformation> 
    <Address> 
      <StateOrProvince>CA</StateOrProvince> 
    </Address> 
    <Email>a********@*****.com</Email> 
    <FirstName>***b</FirstName> 
    <LastName>B****t</LastName> 
    <SubmittedTime>2019-09-02T01:50:47.000Z</SubmittedTime> 
  </AdFormatLead> 
</GetAdFormatLeadsResponse> 

Change History