eBay Trading APIVersion 1031

UserType

Type to contain the data for one eBay user. Depending on the context, the user might be the seller or the buyer on either side of an order, 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.

Types that use UserType:

Calls that use UserType:

Fields



AboutMePage ( boolean ) [0..1]
If true, indicates that the user has set up an About Me page.
See the Field Index to learn which calls use AboutMePage.

BiddingSummary ( BiddingSummaryType ) [0..1]
Contains information about the user as a bidder on a certain item. Returned by GetAllBidders if IncludeBiddingSummary = true is included in the request.
See the Field Index to learn which calls use BiddingSummary.

BillingEmail ( string ) [0..1]
When a user has their billing option set to email, they can include this element in a GetUser request to retrieve their own email bills.
See the Field Index to learn which calls use BillingEmail.

BusinessRole ( BusinessRoleType ) [0..1]
This field indicates whether the user's account is enabled for buying and selling (indicated by FullMarketPlaceParticipant) on eBay, or if the account is a Partially Provisioned Account (indicated by Shopper) without selling and buying privileges on eBay.
See the Field Index to learn which calls use BusinessRole.

BuyerInfo ( BuyerType ) [0..1]
Contains information about the user as a buyer, such as the shipping address. See BuyerType for its child elements.

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.
See the Field Index to learn which calls use BuyerInfo.

CharityAffiliations ( CharityAffiliationsType ) [0..1]
Not used by any call.

This type is deprecated. Use instead User.SellerInfo.CharityAffiliationDetail.
See the Field Index to learn which calls use CharityAffiliations.

eBayGoodStanding ( boolean ) [0..1]
If true, indicates that the user is in good standing with eBay.
See the Field Index to learn which calls use eBayGoodStanding.

eBayWikiReadOnly ( boolean ) [0..1]
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.
See the Field Index to learn which calls use eBayWikiReadOnly.

EIASToken ( string ) [0..1]
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.
See the Field Index to learn which calls use EIASToken.

Email ( string ) [0..1]
Email address for the user. Please see the links below to the topics related to anonymous user information and static email addresses. You cannot retrieve an email address for any user with whom you do not have an order relationship, regardless of site.

An email address of another user is only returned if you and the other user are in an order relationship, within a certain time of order line item creation (although this limitation isn't applicable to the GetAllBidders call in the case of motor vehicles categories.) Based on Trust and Safety policies, the time is unspecified and can vary by site.

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.

For the order retrieval calls, the buyer's registration email address is only returned if the buyer is registered on the DE, AT, or CH sites, regardless of the seller's registration site and the site to which the seller sends the request.
See the Field Index to learn which calls use Email.

EnterpriseSeller ( boolean ) [0..1]
Reserved for internal or future use.
See the Field Index to learn which calls use EnterpriseSeller.

FeedbackPrivate ( boolean ) [0..1]
Indicates whether the user has chosen to make their feedback score and feedback details private (hidden from other users). The percentage of positive feedback can still be returned, even if other feedback details are private.

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.
See the Field Index to learn which calls use FeedbackPrivate.

FeedbackRatingStar ( FeedbackRatingStarCodeType ) [0..1]
Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Rating Star value for the user is returned to the buyer or seller, but a dummy value of None will be returned to all third parties.
See the Field Index to learn which calls use FeedbackRatingStar.

FeedbackScore ( int ) [0..1]
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 either side of an order.

Each order line item 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.

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.

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.

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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Feedback Score for the user is returned to the buyer or seller, but a dummy value of 0 will be returned to all third parties.
See the Field Index to learn which calls use FeedbackScore.

IDVerified ( boolean ) [0..1]
Indicates whether the user has been verified. For more information about the ID Verify program, see: Protecting your account
See the Field Index to learn which calls use IDVerified.

Membership ( MembershipDetailsType ) [0..1]
The Membership container will be returned if the seller is enrollled in one or more membership programs on one or more eBay sites. A Program container will be returned for each applicable membership program, and provides details on that program, including the eBay site, the program name (such as 'EBAYPLUS'), and the membership expiration date. This container will not be returned at all if the seller is not enrolled in any applicable membership programs.
See the Field Index to learn which calls use Membership.

MotorsDealer ( boolean ) [0..1]
Indicates if item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only.
See the Field Index to learn which calls use MotorsDealer.

NewUser ( boolean ) [0..1]
If true, identifies a new user who has been a registered eBay user for 30 days or less. This is always false after the user has been registered for more than 30 days. Does not indicate an ID change (see UserIdChanged).
See the Field Index to learn which calls use NewUser.

PayPalAccountLevel ( PayPalAccountLevelCodeType ) [0..1]
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.
See the Field Index to learn which calls use PayPalAccountLevel.

PayPalAccountStatus ( PayPalAccountStatusCodeType ) [0..1]
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.
See the Field Index to learn which calls use PayPalAccountStatus.

PayPalAccountType ( PayPalAccountTypeCodeType ) [0..1]
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.
See the Field Index to learn which calls use PayPalAccountType.

PositiveFeedbackPercent ( float ) [0..1]
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.

For GetOrders, GetOrderTransactions, and GetItemTransactions only: If using Trading WSDL Version 1019 or above, this field will only be returned to the buyer or seller, and no longer returned at all to third parties. If using a Trading WSDL older than Version 1019, the accurate Positive Feedback Percentage value for the user is returned to the buyer or seller, but a dummy value of 0.0 will be returned to all third parties.
See the Field Index to learn which calls use PositiveFeedbackPercent.

QualifiesForSelling ( boolean ) [0..1]
This flag indicates whether or not the user is eligible to sell items on eBay. This field is only returned if the IncludeFeatureEligibility flag is included in the call request and set to true.
See the Field Index to learn which calls use QualifiesForSelling.

RegistrationAddress ( AddressType ) [0..1]
This container consists of the Registration address for the eBay user making the call.

GetUser: eBay returns complete RegistrationAddress details (including Phone), as applicable to the registration site for the eBay user making the call.

GetItem and GetSellerTransactions: RegistrationAddress for another user (except for Phone) is only returned if you have an order 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.)
See the Field Index to learn which calls use RegistrationAddress.

RegistrationDate ( dateTime ) [0..1]
Indicates the date the specified user originally registered with eBay.

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.
See the Field Index to learn which calls use RegistrationDate.

SellerInfo ( SellerType ) [0..1]
Contains information about a seller, including listing settings, listing preferences, seller rankings, and seller type.

This field is replaced by the SellerBusinessType field if the user is a business seller with a site ID of 77 (Germany), ID of 3 (UK), ID of 205 (Ireland) or ID of 0 (US Motors).

See SellerType or SellerBusinessCodeType for the child elements.
See the Field Index to learn which calls use SellerInfo.

SellerPaymentMethod ( SellerPaymentMethodCodeType ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use SellerPaymentMethod.

ShippingAddress ( AddressType ) [0..1]
Contains the shipping address of a bidder who has made a Best Offer for an item.

You cannot retrieve a shipping address for any user with whom you do not have an order relationship, regardless of site. The shipping address of another user is returned only if you and the other user are in an order relationship, within a certain time of order line item creation.

Because a bidder's user information is anonymous, this container is returned only to that bidder, and to the seller of an item that the user is bidding on.
See the Field Index to learn which calls use ShippingAddress.

Site ( SiteCodeType ) [0..1]
eBay site the user is registered with.

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.
See the Field Index to learn which calls use Site.

SiteVerified ( boolean ) [0..1]
Not used by any call.

This field is deprecated.
See the Field Index to learn which calls use SiteVerified.

SkypeID ( string ) [0..*]
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.
See the Field Index to learn which calls use SkypeID.

StaticAlias ( string ) [0..1]
Contains the static email address of an eBay member, used within the "reply to" email address when the eBay member sends a message. (Each eBay member is assigned a static alias. The alias is used within a static email address.)
See the Field Index to learn which calls use StaticAlias.

Indicates the user's registration/user status.
See the Field Index to learn which calls use Status.

TUVLevel ( int ) [0..1]
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.
See the Field Index to learn which calls use TUVLevel.

UniqueNegativeFeedbackCount ( int ) [0..1]
Total count of negative Feedback entries received by the user, including weekly repeats.
See the Field Index to learn which calls use UniqueNegativeFeedbackCount.

UniqueNeutralFeedbackCount ( int ) [0..1]
Total count of neutral Feedback entries received by the user, including weekly repeats.
See the Field Index to learn which calls use UniqueNeutralFeedbackCount.

UniquePositiveFeedbackCount ( int ) [0..1]
Total count of positive Feedback entries received by the user, including weekly repeats. This 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 on either side of an order. Each order line item 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).

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.
See the Field Index to learn which calls use UniquePositiveFeedbackCount.

UserAnonymized ( boolean ) [0..1]
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.

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.
See the Field Index to learn which calls use UserAnonymized.

UserFirstName ( string ) [0..1]
The first name of the buyer who purchased the order.
See the Field Index to learn which calls use UserFirstName.

UserID ( UserIDType (string) ) [0..1]
Unique eBay user ID for the user.

Since a bidder's user info is anonymous, this tag contains the actual value of an ID only for that bidder, and for the seller of an item that the user is bidding on. For other users, the actual value is replaced by an anonymous value, according to these rules:

When bidding on items, 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".

Important: In this format, the anonymous bidder ID can change for each auction. For GetMyeBayBuying only, when bidding on items: UserID is replaced with the value "a****b" where a and b are random characters from the UserID.

When bidding on items listed on the the Philippines site: 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. Note that in this Philippines site 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".

For GetMyeBayBuying only, when bidding on items listed on the UK and AU sites: UserID is replaced with the string "High Bidder".

For PlaceOffer, see also SellingStatus.HighBidder.
See the Field Index to learn which calls use UserID.

UserIDChanged ( boolean ) [0..1]
If true, identifies a user whose ID has changed within the last 30 days. Does not indicate a new user (see NewUser).

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.
See the Field Index to learn which calls use UserIDChanged.

UserIDLastChanged ( dateTime ) [0..1]
Date and time the user's data was last changed (in GMT).

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.
See the Field Index to learn which calls use UserIDLastChanged.

UserLastName ( string ) [0..1]
The last name of the buyer who purchased the order.
See the Field Index to learn which calls use UserLastName.

UserSubscription ( EBaySubscriptionTypeCodeType ) [0..*]
Specifies the subscription level for a user.
See the Field Index to learn which calls use UserSubscription.

VATID ( string ) [0..1]
The value added tax identifier (VATID) is applicable to the VAT-enabled sites. Applies to eBay Motors Pro applications only.
See the Field Index to learn which calls use VATID.

VATStatus ( VATStatusCodeType ) [0..1]
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).
See the Field Index to learn which calls use VATStatus.