complexType "ns:AdFormatLeadType"

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

complexType "ns:AdFormatLeadType"

Namespace:	urn:ebay:apis:eBLBaseComponents
Content:	complex, 19 elements, elem. wildcard
Defined:	globally in Schema in ebaySvc.wsdl; see XML source
Includes:	definitions of 19 elements, elem. wildcard
Used:	at 1 location

Component Diagram

XML Representation Summary

<...>

Content:

</...>

All Direct / Indirect Based Elements (1):

ns:AdFormatLead

Known Usage Locations

As direct type of elements (1):

ns:AdFormatLead

Annotation

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.

XML Source (w/o annotations (20); see within schema source)

<xs:complexType name="AdFormatLeadType">

<xs:sequence>

<xs:element minOccurs="0" name="AdditionalInformation" type="xs:string"/>

<xs:element minOccurs="0" name="Address" type="ns:AddressType"/>

<xs:element minOccurs="0" name="BestTimeToCall" type="xs:string"/>

<xs:element minOccurs="0" name="Email" type="xs:string"/>

<xs:element minOccurs="0" name="SubmittedTime" type="xs:dateTime"/>

<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>

<xs:element minOccurs="0" name="ItemTitle" type="xs:string"/>

<xs:element minOccurs="0" name="UserID" type="ns:UserIDType"/>

<xs:element minOccurs="0" name="MemberMessage" type="ns:MemberMessageExchangeArrayType"/>

<xs:element minOccurs="0" name="Status" type="ns:AdFormatLeadStatusCodeType"/>

<xs:element minOccurs="0" name="LeadFee" type="ns:AmountType"/>

<xs:element minOccurs="0" name="ExternalEmail" type="xs:string"/>

<xs:element minOccurs="0" name="PurchaseTimeFrame" type="xs:string"/>

<xs:element minOccurs="0" name="TradeInYear" type="xs:string"/>

<xs:element minOccurs="0" name="TradeInMake" type="xs:string"/>

<xs:element minOccurs="0" name="TradeInModel" type="xs:string"/>

<xs:element minOccurs="0" name="FinancingAnswer" type="xs:boolean"/>

<xs:element minOccurs="0" name="Answer1" type="xs:boolean"/>

<xs:element minOccurs="0" name="Answer2" type="xs:boolean"/>

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

</xs:sequence>

</xs:complexType>

Content Element Detail (all declarations defined in this component; 20/20)

ns:AdditionalInformation

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:AdditionalInformation>

Content:

{ xs:string }

</ns:AdditionalInformation>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="AdditionalInformation" type="xs:string"/>

ns:Address

Type:

ns:AddressType, complex content

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.

Component Diagram

XML Representation Summary

<ns:Address>

Content:

</ns:Address>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Address" type="ns:AddressType"/>

ns:Answer1

Type:

xs:boolean, predefined, simple content

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.

XML Representation Summary

<ns:Answer1>

Content:

{ xs:boolean }

</ns:Answer1>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Answer1" type="xs:boolean"/>

ns:Answer2

Type:

xs:boolean, predefined, simple content

XML Representation Summary

<ns:Answer2>

Content:

{ xs:boolean }

</ns:Answer2>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Answer2" type="xs:boolean"/>

ns:BestTimeToCall

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:BestTimeToCall>

Content:

{ xs:string }

</ns:BestTimeToCall>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="BestTimeToCall" type="xs:string"/>

ns:Email

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:Email>

Content:

{ xs:string }

</ns:Email>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Email" type="xs:string"/>

ns:ExternalEmail

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:ExternalEmail>

Content:

{ xs:string }

</ns:ExternalEmail>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ExternalEmail" type="xs:string"/>

ns:FinancingAnswer

Type:

xs:boolean, predefined, simple content

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.

XML Representation Summary

<ns:FinancingAnswer>

Content:

{ xs:boolean }

</ns:FinancingAnswer>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="FinancingAnswer" type="xs:boolean"/>

ns:ItemID

Type:

ns:ItemIDType, simple content

The unique identifier of the listing.

XML Representation Summary

<ns:ItemID>

Content:

{ xs:string }

</ns:ItemID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemID" type="ns:ItemIDType"/>

ns:ItemTitle

Type:

xs:string, predefined, simple content

The title of the listing.

XML Representation Summary

<ns:ItemTitle>

Content:

{ xs:string }

</ns:ItemTitle>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="ItemTitle" type="xs:string"/>

ns:LeadFee

Type:

ns:AmountType, simple content

The pay-per-lead feature is no longer available, and this field is scheduled to be removed from the WSDL.

Component Diagram

XML Representation Summary

<ns:LeadFee

currencyID

("AFA" | "ALL" | "DZD" | "ADP" | "AOA" | "ARS" | "AMD" | "AWG" | "AZM" | "BSD" | "BHD" | "BDT" | "BBD" | "BYR" | "BZD" | "BMD" | "BTN" | "INR" | "BOV" | "BOB" | "BAM" | "BWP" | "BRL" | "BND" | "BGL" | "BGN" | "BIF" | "KHR" | "CAD" | "CVE" | "KYD" | "XAF" | "CLF" | "CLP" | "CNY" | "COP" | "KMF" | "CDF" | "CRC" | "HRK" | "CUP" | "CYP" | "CZK" | "DKK" | "DJF" | "DOP" | "TPE" | "ECV" | "ECS" | "EGP" | "SVC" | "ERN" | "EEK" | "ETB" | "FKP" | "FJD" | "GMD" | "GEL" | "GHC" | "GIP" | "GTQ" | "GNF" | "GWP" | "GYD" | "HTG" | "HNL" | "HKD" | "HUF" | "ISK" | "IDR" | "IRR" | "IQD" | "ILS" | "JMD" | "JPY" | "JOD" | "KZT" | "KES" | "AUD" | "KPW" | "KRW" | "KWD" | "KGS" | "LAK" | "LVL" | "LBP" | "LSL" | "LRD" | "LYD" | "CHF" | "LTL" | "MOP" | "MKD" | "MGF" | "MWK" | "MYR" | "MVR" | "MTL" | "EUR" | "MRO" | "MUR" | "MXN" | "MXV" | "MDL" | "MNT" | "XCD" | "MZM" | "MMK" | "ZAR" | "NAD" | "NPR" | "ANG" | "XPF" | "NZD" | "NIO" | "NGN" | "NOK" | "OMR" | "PKR" | "PAB" | "PGK" | "PYG" | "PEN" | "PHP" | "PLN" | "USD" | "QAR" | "ROL" | "RUB" | "RUR" | "RWF" | "SHP" | "WST" | "STD" | "SAR" | "SCR" | "SLL" | "SGD" | "SKK" | "SIT" | "SBD" | "SOS" | "LKR" | "SDD" | "SRG" | "SZL" | "SEK" | "SYP" | "TWD" | "TJS" | "TZS" | "THB" | "XOF" | "TOP" | "TTD" | "TND" | "TRL" | "TMM" | "UGX" | "UAH" | "AED" | "GBP" | "USS" | "USN" | "UYU" | "UZS" | "VUV" | "VEB" | "VND" | "MAD" | "YER" | "YUM" | "ZMK" | "ZWD" | "ATS" | "CustomCode")

Content:

{ xs:double }

</ns:LeadFee>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="LeadFee" type="ns:AmountType"/>

ns:MemberMessage

Type:

ns:MemberMessageExchangeArrayType, complex content

Contains any mail message content shared between the seller and prospective buyer.

Component Diagram

XML Representation Summary

<ns:MemberMessage>

Content:

ns:MemberMessageExchange*

</ns:MemberMessage>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="MemberMessage" type="ns:MemberMessageExchangeArrayType"/>

ns:PurchaseTimeFrame

Type:

xs:string, predefined, simple content

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

XML Representation Summary

<ns:PurchaseTimeFrame>

Content:

{ xs:string }

</ns:PurchaseTimeFrame>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="PurchaseTimeFrame" type="xs:string"/>

ns:Status

Type:

ns:AdFormatLeadStatusCodeType, simple content

The enumeration value in this field will indicate whether or not the seller has responded to the lead.

XML Representation Summary

<ns:Status>

Content:

{ enumeration of xs:token }

</ns:Status>

Simple Content

Enumeration:

"New"	-	This value will appear in the response if there is a new message from a prospective buyer that the seller has not yet responded to.
"Responded"	-	This value will appear in the response if the seller has already responded to the prospective buyer's message.
"CustomCode"	-	(out) Reserved for internal or future use.

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="Status" type="ns:AdFormatLeadStatusCodeType"/>

ns:SubmittedTime

Type:

xs:dateTime, predefined, simple content

Date and time (in GMT) that the lead was submitted.

XML Representation Summary

<ns:SubmittedTime>

Content:

{ xs:dateTime }

</ns:SubmittedTime>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="SubmittedTime" type="xs:dateTime"/>

ns:TradeInMake

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:TradeInMake>

Content:

{ xs:string }

</ns:TradeInMake>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="TradeInMake" type="xs:string"/>

ns:TradeInModel

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:TradeInModel>

Content:

{ xs:string }

</ns:TradeInModel>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="TradeInModel" type="xs:string"/>

ns:TradeInYear

Type:

xs:string, predefined, simple content

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.

XML Representation Summary

<ns:TradeInYear>

Content:

{ xs:string }

</ns:TradeInYear>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="TradeInYear" type="xs:string"/>

ns:UserID

Type:

ns:UserIDType, simple content

The eBay user ID of the user who is interested in the seller's item.

XML Representation Summary

<ns:UserID>

Content:

{ xs:string }

</ns:UserID>

XML Source (w/o annotations (1); see within schema source)

<xs:element minOccurs="0" name="UserID" type="ns:UserIDType"/>

{any element from any namespace}

XML Source (see within schema source)

<xs:any maxOccurs="unbounded" minOccurs="0" processContents="lax"/>

Overview

Namespace

WSDL

Schema

Component

Index

PREV C-TYPE NEXT C-TYPE

FRAMES NO FRAMES NS-Bindings

SUMMARY: XML REP | DERIVED | USE

DETAIL: DESC | XML SRC | TYPE | ATTR | CHILD

eBay Trading API

WSDL documentation generated with FlexDoc/XML 1.13 using FlexDoc/XML WSDLDoc 1.2.5 template set. All XSD diagrams generated by FlexDoc/XML DiagramKit.