NAME
eBay::API::XML::DataType::UserType
DESCRIPTION
Type to contain the data for one eBay user. Depending on the context, the user might be the seller or the buyer in a transaction, or the bidder or winning bidder in a listing. An object of this type is returned by a number of calls, including the GetUser call.
SYNOPSIS
INHERITANCE
eBay::API::XML::DataType::UserType inherits from the eBay::API::XML::BaseDataType class
Subroutines:
setAboutMePage()
If true, indicates that the user has set up an About Me page.
# Argument: 'xs:boolean'
isAboutMePage()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always# Returns: 'xs:boolean'
setBiddingSummary()
Contains information about the user as a bidder on a certain item. Returned for GetAllBidders if IncludeBiddingSummary = true is included in the request.
# Argument: 'ns:BiddingSummaryType'
getBiddingSummary()
Calls: GetAllBidders
Returned: Conditionally# Returns: 'ns:BiddingSummaryType'
setBuyerInfo()
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements. <br><br> Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'ns:BuyerType'
getBuyerInfo()
Calls: GetAllBidders
GetHighBidders
Returned: Always
Calls: GetBidderList
Returned: Conditionally
Context: Bidder
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer
Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: SoldList# Returns: 'ns:BuyerType'
setCharityAffiliations()
Contains information about the seller's charity affliations. Returned if the user is affiliated with one or more charities. Seller must be registered with the eBay Giving Works provider to be affiliated with a charity non-profit organization.
SeeLink: URL: http://givingworks.ebay.com/ Title: eBay Giving Works Program
# Argument: 'ns:CharityAffiliationsType'
getCharityAffiliations()
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll# Returns: 'ns:CharityAffiliationsType'
setEIASToken()
Unique identifier for the user that does not change when the eBay user name is changed. Use when an application needs to associate a new eBay user name with the corresponding eBay user. <br><br> Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'xs:string'
getEIASToken()
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetHighBidders
Returned: Always# Returns: 'xs:string'
setEmail()
Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Based on Trust and Safety policies, the time is unspecified and can vary by site. <br><br> Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'xs:string'
getEmail()
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Conditionally
Calls: GetBestOffers
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetOrders
Returned: Conditionally
Details: DetailLevel: none
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Calls: GetMyeBayBuying
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: WonList
DeletedFromWonList
Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: SoldList
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ReturnAll
Context: Seller
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
Context: HighBidder
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer
Calls: GetSellerEvents
Returned: Conditionally
Details: DetailLevel: ReturnAll# Returns: 'xs:string'
setFeedbackPrivate()
Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). Note that the percentage of positive feedback can still be returned, even if other feedback details are private. To be eligible to list on Express, a seller's feedback needs to be public. See "eBay Express" in the eBay Web Services guide. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. <br><br> Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'xs:boolean'
isFeedbackPrivate()
Calls: GetCategoryListings
GetProducts
Returned: Conditionally
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'xs:boolean'
setFeedbackRatingStar()
Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.
# Argument: 'ns:FeedbackRatingStarCodeType'
getFeedbackRatingStar()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer
Calls: GetMyeBayBuying
GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList
WatchList# Returns: 'ns:FeedbackRatingStarCodeType'
setFeedbackScore()
The aggregate feedback score for a user. A user's feedback score is the net positive feedback minus the net negative feedback left for the user. Feedback scores are a quantitative expression of the desirability of dealing with a user as a buyer or a seller in transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.<br> <br> To be eligible to list on Express, a seller's feedback score needs to be 100 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine.<br> <br> In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. <br> In GetMyeBayBuying and GetMyeBaySelling, feedback information (FeedbackScore and FeedbackRatingStar) is returned in BidList.ItemArray.Item.Seller. For GetMyeBayBuying, the feedback score of each seller with an item having received a bid from the buyer is returned. For GetMyeBaySelling, the feedback score of the seller is returned. <br> <br> GetMyeBayBuying and GetMyeBaySelling also return feedback information (FeedbackScore and FeedbackRatingStar) in BidList.ItemArray.Item.SellingStatus.HighBidder. GetMyeBayBuying returns feedback information on the high bidder of each item the buyer is bidding on. GetMyeBaySelling returns feedback information on the high bidder of each item the seller is selling. <br> <br> Since a bidder's user info is anonymous, the real feedback score will be returned only to that bidder, and to the seller of an item that the user is bidding on. For all other users, the value -99 is returned.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'xs:int'
getFeedbackScore()
Calls: GetAllBidders
GetCategoryListings
GetHighBidders
GetProducts
Returned: Conditionally
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Calls: GetBidderList
Returned: Always
Calls: GetBestOffers
Returned: Always
Details: DetailLevel: none, ReturnAll
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer
Calls: GetSearchResults
Returned: Conditionally
Details: DetailLevel: none, ItemReturnCategories, ItemReturnAttributes, ReturnAll
GranularityLevel: Coarse
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetSellerEvents
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetMyeBayBuying
GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: BidList
WatchList# Returns: 'xs:int'
setIDVerified()
Indicates whether the user has been verified. For more information about the ID Verify program, see: http://pages.ebay.com/help/policies/identity-idverify.html
# Argument: 'xs:boolean'
isIDVerified()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'xs:boolean'
setMotorsDealer()
Indicates if item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only.
TheseSites: AU, DE, FR, IT, UK
Calls: AddItem
ReviseItem
VerifyAddItem
RequiredInput: Conditionally# Argument: 'xs:boolean'
isMotorsDealer()
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: Seller
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller# Returns: 'xs:boolean'
setNewUser()
If true, identifies a new user who has been a registered eBay user for 30 days or less. Always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).
# Argument: 'xs:boolean'
isNewUser()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'xs:boolean'
setPayPalAccountLevel()
The user's PayPal account level. Only returned for the user identified in eBayAuthToken. That is, you cannot see someone else's PayPal account level. Use this information to check whether a seller is eligible to list digital downloadable items. See the eBay Web site online help for current PayPal requirements for listing digital items.
# Argument: 'ns:PayPalAccountLevelCodeType'
getPayPalAccountLevel()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'ns:PayPalAccountLevelCodeType'
setPayPalAccountStatus()
The user's PayPal account status. Only returned for the user identified in eBayAuthToken. That is, you cannot see someone else's PayPal account status. Use this information to check whether a seller is eligible to list digital downloadable items. See the eBay Web site online help for current PayPal requirements for listing digital items.
# Argument: 'ns:PayPalAccountStatusCodeType'
getPayPalAccountStatus()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'ns:PayPalAccountStatusCodeType'
setPayPalAccountType()
The user's PayPal account type. Only returned for the user identified in eBayAuthToken. That is, you cannot see someone else's PayPal account type. Use this information to check whether a seller is likely to be eligible to list digital downloadable items. See the eBay Web site online help for current PayPal requirements for listing digital items. Please note that this information cannot necessarily be used to determine whether a seller is eligible to list items on eBay Express, because a seller can have more than one PayPal account (and any of these accounts can be used for a given listing).
# Argument: 'ns:PayPalAccountTypeCodeType'
getPayPalAccountType()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'ns:PayPalAccountTypeCodeType'
setPositiveFeedbackPercent()
Percent of total feedback that is positive. For example, if the member has 50 feedbacks, where 49 are positive and 1 is neutral or negative, the positive feedback percent could be 98.0. The value uses a max precision of 4 and a scale of 1. If the user has feedback, this value can be returned regardless of whether the member has chosen to make their feedback private. Not returned if the user has no feedback. To be eligible to list on Express, a seller's feedback percent needs to be 98 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request.
# Argument: 'xs:float'
getPositiveFeedbackPercent()
Calls: GetAllBidders
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetCategoryListings
GetItem
GetProducts
Returned: Conditionally
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Calls: GetSearchResults
Returned: Conditionally
Details: DetailLevel: none, ItemReturnCategories, ItemReturnAttributes, ReturnAll
GranularityLevel: Coarse
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'xs:float'
setRESTToken()
This token is for the Trading API. For REST calls, it is recommended that you use the Shopping API instead of the Trading API. See <a href="http://developer.ebay.com/products/shopping/" target="_blank">Shopping AP/a for more information. The RESTToken field contains the REST token (if available) for the user who is making the request. Not returned when UserID is for a different user than the one identified in eBayAuthToken. Use the REST token to authenticate REST API calls in the Trading API.
# Argument: 'xs:string'
getRESTToken()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll# Returns: 'xs:string'
setRegistrationAddress()
Registration address for a user.<br> <br> <b>GetUser:</b> eBay returns complete RegistrationAddress details (including Phone), as applicable to the registration site, when you retrieve your own user data. <br> <br> <b>GetItem:</b> RegistrationAddress for another user (except for Phone) is only returned if you have a transactional relationship with that user AND that user is registered on DE/AT/CH, regardless of your registration site and the site to which you send the request. For example, the seller can see the buyer's registration address if the buyer is registered on DE/AT/CH, or the buyer can see the seller's registration address if the seller is registered on DE/AT/CH. (The buyer and seller won't see their own registration addresses in GetItem.) <br> <br> To be eligible to list on Express US, a seller's registration address must be in the US or Canada. To list on Express Germany, a seller's registration address must be in Germany. See "eBay Express" in the eBay Web Services guide. <p></p> <span class="tablenote"><b>Note:</b> At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information. </span>
# Argument: 'ns:AddressType'
getRegistrationAddress()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll, ReturnSummary, none
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: Seller
HighBidder# Returns: 'ns:AddressType'
setRegistrationDate()
Indicates the date the specified user originally registered with eBay. <br><br> Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'xs:dateTime'
getRegistrationDate()
Calls: GetBestOffers
Returned: Always
Details: DetailLevel: none, ReturnAll
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
HighBidder
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'xs:dateTime'
setSellerInfo()
Contains information about the user as a seller, such as whether the seller is authorized to list Live Auction items or opts to have items cross-promoted. <br><br>This field is replaced by the SellerBusinessType field if the user is a business seller with a site ID of 77 (Germany), 3 (UK), 205 (Ireland) or 100 (Motors). <br><br>See SellerType or SellerBusinessCodeType for the child elements.
# Argument: 'ns:SellerType'
getSellerInfo()
Calls: GetBidderList
Returned: Always
Context: Seller
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Coarse, Medium, Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller# Returns: 'ns:SellerType'
setSellerPaymentMethod()
Indicates the method the seller selected to pay eBay with for the account. The payment methods vary from one eBay site to the next. Payment methods are enumerated in the SellerPaymentMethodCodeType code list.
# Argument: 'ns:SellerPaymentMethodCodeType'
getSellerPaymentMethod()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'ns:SellerPaymentMethodCodeType'
setSite()
eBay site the user is registered with. To be eligible to list on Express US, a seller must be registered on the eBay US or Canada site. To be eligible to list on Express Germany, a seller must registered on the eBay Germany site. See "eBay Express" in the eBay Web Services guide. <p></p> <span class="tablenote"><b>Note:</b> At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information. </span> <br><br> Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'ns:SiteCodeType'
getSite()
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'ns:SiteCodeType'
setSiteVerified()
No longer used.
Ignore: # Argument: 'xs:boolean'
isSiteVerified()
# Returns: 'xs:boolean'
setSkypeID()
Indicates the Skype name of the user. Available if the seller has a Skype account and has linked it (on the eBay site) with his or her eBay account.
# Argument: reference to an array of 'xs:string'
getSkypeID()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: reference to an array of 'xs:string'
setStatus()
Indicates the user's registration/user status. To be eligible to list on Express, a seller's status must be Confirmed. See "eBay Express" in the eBay Web Services guide.
# Argument: 'ns:UserStatusCodeType'
getStatus()
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
AllValuesExcept: UnconfirmedPassport,
CreditCardVerifyPassport
Calls: GetUser
Returned: Conditionally
AllValuesExcept: UnconfirmedPassport,
CreditCardVerifyPassport
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Always
AllValuesExcept: UnconfirmedPassport,
CreditCardVerifyPassport
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetItem
Returned: Conditionally
AllValuesExcept: UnconfirmedPassport,
CreditCardVerifyPassport
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetOrderTransactions
Returned: Conditionally
AllValuesExcept: UnconfirmedPassport,
CreditCardVerifyPassport
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
AllValuesExcept: UnconfirmedPassport,
CreditCardVerifyPassport
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetSellerList
Returned: Always
AllValuesExcept: UnconfirmedPassport,
CreditCardVerifyPassport
Details: DetailLevel: none, ItemReturnDescription,
ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
AllValuesExcept: UnconfirmedPassport,
CreditCardVerifyPassport
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
AllValuesExcept: UnconfirmedPassport,
CreditCardVerifyPassport
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'ns:UserStatusCodeType'
setTUVLevel()
TUV level is a number allocated to a user based on various characteristics such as buyer, seller, new buyer, new seller, high risk, or bid limit. Applies to eBay Motors Pro applications only.
TheseSites: AU, DE, FR, IT, UK
# Argument: 'xs:int'
getTUVLevel()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: ReturnAll# Returns: 'xs:int'
setUniqueNegativeFeedbackCount()
Total count of negative Feedback entries received by the user, including weekly repeats.
# Argument: 'xs:int'
getUniqueNegativeFeedbackCount()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'xs:int'
setUniqueNeutralFeedbackCount()
Total count of neutral Feedback entries received by the user, including weekly repeats.
# Argument: 'xs:int'
getUniqueNeutralFeedbackCount()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'xs:int'
setUniquePositiveFeedbackCount()
Total count of positive Feedback entries received by the user, including weekly repeats. Contains the aggregate feedback score for a user. A member's feedback score is the net positive feedback minus the net negative feedback left for the member. Feedback scores are a quantitative expression of the desirability of dealing with that person as a Buyer or a Seller in auction transactions. Each auction transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). This rating is commonly expressed as the eBay Feedback score for the user.
# Argument: 'xs:int'
getUniquePositiveFeedbackCount()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'xs:int'
setUserAnonymized()
Indicates whether or not the User container has been made anonymous. If true, some elements in the User container have either been removed, or had their values changed to remove identifying characteristics. If false, all expected elements are returned, and no values are changed. <br><br> Since a bidder's user info is anonymous, this tag is returned as false only to the bidder, and to the seller of an item that the user is bidding on. For all other users, this tag is returned as true.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'xs:boolean'
isUserAnonymized()
Calls: GetAllBidders
GetHighBidders
GetSellerEvents
Returned: Always
Calls: GetSellerList
Returned: Always
Details: GranularityLevel: Fine
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnAttributes, ItemReturnDescription, ReturnAll
Context: HighBidder
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ReturnAll# Returns: 'xs:boolean'
setUserID()
Unique eBay user ID for the user.<br> <br> In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. <br><br> Since a bidder's user info is anonymous, this tag will contain the real ID value only for that bidder, and the seller of an item that the user is bidding on. For all other users, the real ID value will be replaced with the anonymous value, according to these rules: <br><br> When bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. For example, if the UserID = IBidALot, it might be displayed as, "I****A". <br> Note that in this format, the anonymous bidder ID stays the same for every auction. <br><br> (GetMyeBayBuying only) when bidding on items listed on the US site: UserID is replaced with the value "a****b" where a and b are random characters from the UserID. <br><br> When bidding on items listed on the the UK and AU sites: UserID is replaced with the value "Bidder X" where X is a number indicating the order of that user's first bid. For example, if the user was the third bidder, UserID = Bidder 3. <br> Note that in this format, the anonymous bidder ID stays the same for a given auction, but is different for different auctions. For example, a bidder who is the third and then the seventh bidder in an auction will be listed for both bids as "Bidder 3". However, if that same bidder is the first bidder on a different auction, the bidder will be listed for that auction as "Bidder 1", not "Bidder 3". <br><br> (GetMyeBayBuying only) when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder". <br><br> (GetSearchResults only)When IncludeFeedback is set to true in GetSearchResults request, the call response returns the seller's User ID. Please note seller's UserID is not anonymized.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'ns:UserIDType'
getUserID()
Calls: PlaceOffer
Returned: Always
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Conditionally
Calls: GetBestOffers
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetItemsAwaitingFeedback
Returned: Conditionally
Context: Buyer
Calls: GetMyeBayBuying
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetMyeBaySelling
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Context: ActiveList
SoldList
BidList
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer
Calls: GetSellerEvents
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSearchResults
Returned: Conditionally
Details: DetailLevel: ReturnAll# Returns: 'ns:UserIDType'
setUserIDChanged()
If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser). <br><br> Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'xs:boolean'
isUserIDChanged()
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'xs:boolean'
setUserIDLastChanged()
Date and time the user's data was last changed (in GMT). <br><br> Since a bidder's user info is anonymous, this tag will be returned only to that bidder, and to the seller of an item that the user is bidding on.
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=AnonymousUserInfo Title: Working with Anonymous User Information
# Argument: 'xs:dateTime'
getUserIDLastChanged()
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'xs:dateTime'
setUserSubscription()
Specifies the subscription level for a user.
# Argument: reference to an array of 'ns:EBaySubscriptionTypeCodeType'
getUserSubscription()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: reference to an array of 'ns:EBaySubscriptionTypeCodeType'
setVATID()
The value added tax identifier (VATID) is applicable to the VAT-enabled sites. Applies to eBay Motors Pro applications only.
TheseSites: AU, DE, FR, IT, UK
# Argument: 'xs:string'
getVATID()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'xs:string'
setVATStatus()
Indicates whether or not the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT. See documentation on Value-Added Tax (VAT).
SeeLink: URL: http://developer.ebay.com/DevZone/XML/docs/WebHelp/index.htm?context=eBay_XML_API&topic=VATStatus Title: VAT-exempt Sellers
# Argument: 'ns:VATStatusCodeType'
getVATStatus()
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'ns:VATStatusCodeType'
setEBayGoodStanding()
If true, indicates that the user is in good standing with eBay.
# Argument: 'xs:boolean'
isEBayGoodStanding()
Calls: GetUser
Returned: Conditionally
Details: DetailLevel: none, ReturnSummary, ReturnAll
Calls: GetAllBidders
GetBidderList
GetHighBidders
Returned: Always
Calls: GetItem
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: Seller
Calls: GetOrderTransactions
Returned: Conditionally
Details: DetailLevel: ReturnAll
Calls: GetSellerList
Returned: Conditionally
Details: DetailLevel: ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: HighBidder
Calls: GetItem
Returned: Conditionally
Details: DetailLevel: none, ItemReturnDescription, ItemReturnAttributes, ReturnAll
Context: HighBidder
Calls: GetSellerList
Returned: Always
Details: DetailLevel: none, ItemReturnDescription, ReturnAll
GranularityLevel: Fine
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Always
Details: DetailLevel: none, ReturnAll
Context: Seller
Calls: GetItemTransactions
GetSellerTransactions
Returned: Conditionally
Details: DetailLevel: none, ReturnAll
Context: Buyer# Returns: 'xs:boolean'
setEBayWikiReadOnly()
Indicates whether a user has read-only access to the eBay Wiki (true) or whether the user is able contribute or edit articles on the eBay Wiki (false). By default, all registered eBay users have access to contribute and edit articles on the eBay Wiki. All content contributed to the eBay Wiki is subject to the Community Content Policy.
Default: false
# Argument: 'xs:boolean'
isEBayWikiReadOnly()
Calls: GetUser
Returned: Always
Details: DetailLevel: none, ReturnSummary, ReturnAll# Returns: 'xs:boolean'