GetUser returns data for a single, registered eBay user.
GetUser takes as input the eBay user ID for the user whose data you want to review, or the item ID of a successfully concluded listing in which the requestor and target user were participants as buyer and seller in the order.
A successful call returns the data for the specified user in a User container. Site-specific information (such as a subscription to SellingManagerPro) and non-site-specific information (such as registration date) is also returned. Site-specific information depends on the site you specify in the request, while non-site-specific information does not depend on the specified site.
After retrieving the user information, you can:
Sellers who engage in cross-border trading on sites that require a recoupment agreement must agree to the recoupment terms before adding items to the site. This agreement allows eBay to reimburse a buyer during a dispute and then recoup the cost from the seller. The list of the sites where a user has agreed to the recoupment terms is returned in the GetUser response.
Before using GetUser, create one or two test users in the Sandbox. Some data (like email addresses) is returned only under certain conditions (see Email Privacy Policy). Test GetUser with the requestor accessing data for another user and with retrieving the requestor's own data.
GetUser will only return CharityAffiliationDetails if the user is a registered charity seller with the eBay Giving Works provider. Contact Developer Support to get test Sandbox users that are set up as registered charity sellers.
See Managing User Information.
See also the reference documentation for these calls:
| Output Detail Controls Samples Change History Top Errors for GetUser User Notes |
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 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"?>
<GetUserRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Call-specific Input Fields -->
<IncludeFeatureEligibility> boolean </IncludeFeatureEligibility>
<ItemID> ItemIDType (string) </ItemID>
<UserID> string </UserID>
<!-- Standard Input Fields -->
<DetailLevel> DetailLevelCodeType </DetailLevel>
<!-- ... more DetailLevel values allowed here ... -->
<ErrorLanguage> string </ErrorLanguage>
<MessageID> string </MessageID>
<Version> string </Version>
<WarningLevel> WarningLevelCodeType </WarningLevel>
</GetUserRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| Call-specific Input Fields [Jump to standard fields] |
| IncludeFeatureEligibility | boolean | Optional | If IncludeFeatureEligibility is true, the response includes a FeatureEligibility node. (The FeatureEligibility node indicates whether the seller can list with certain features.) |
| ItemID | ItemIDType (string) | Optional |
Specify the item ID for a successfully concluded listing in which the requestor and target user were participants (one as seller and the other as buyer). Necessary to return certain data (like an email address). Not necessary if the requestor is retrieving their own data. ItemID is an optional input. Max length: 19 (Note: The eBay database specifies 38. Currently, Item IDs are usually 9 to 12 digits). |
| UserID | string | Optional | Specify the user whose data you want returned by the call. UserID is optional. If not specified, eBay returns data pertaining to the requesting user (as specified with the eBayAuthToken). |
| Standard Input Fields |
| DetailLevel | DetailLevelCodeType | Optional,
repeatable: [0..*] |
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. • ReturnSummary (in) Returns the summary data. For GetMyMessages, this detail level returns the same data whether or not you include MessageIDs or AlertIDs in the request. Returns up to 10 FolderID and FolderName values. Currently, this detail level is the only way to retrieve FolderID and FolderName values. See "GetMyMessages" in the eBay Web Services Guide for a code sample that demonstrates this. (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 |
| MessageID | string | Optional |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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. |
| 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:
|
| 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. |
| Input Detail Controls Samples Change History Top Errors for GetUser User Notes |
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 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).
<?xml version="1.0" encoding="utf-8"?>
<GetUserResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Call-specific Output Fields -->
<User> UserType
<AboutMePage> boolean </AboutMePage>
<BillingEmail> string </BillingEmail>
<BusinessRole> BusinessRoleType </BusinessRole>
<eBayGoodStanding> boolean </eBayGoodStanding>
<eBayWikiReadOnly> boolean </eBayWikiReadOnly>
<EIASToken> string </EIASToken>
<Email> string </Email>
<EnterpriseSeller> boolean </EnterpriseSeller>
<FeedbackPrivate> boolean </FeedbackPrivate>
<FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
<FeedbackScore> int </FeedbackScore>
<IDVerified> boolean </IDVerified>
<MotorsDealer> boolean </MotorsDealer>
<NewUser> boolean </NewUser>
<PayPalAccountLevel> PayPalAccountLevelCodeType </PayPalAccountLevel>
<PayPalAccountStatus> PayPalAccountStatusCodeType </PayPalAccountStatus>
<PayPalAccountType> PayPalAccountTypeCodeType </PayPalAccountType>
<PositiveFeedbackPercent> float </PositiveFeedbackPercent>
<QualifiesForSelling> boolean </QualifiesForSelling>
<RegistrationAddress> AddressType
<CityName> string </CityName>
<CompanyName> string </CompanyName>
<Country> CountryCodeType </Country>
<CountryName> string </CountryName>
<Name> string </Name>
<Phone> string </Phone>
<PostalCode> string </PostalCode>
<StateOrProvince> string </StateOrProvince>
<Street> string </Street>
<Street1> string </Street1>
<Street2> string </Street2>
</RegistrationAddress>
<RegistrationDate> dateTime </RegistrationDate>
<SellerInfo> SellerType
<AllowPaymentEdit> boolean </AllowPaymentEdit>
<CharityAffiliationDetails> CharityAffiliationDetailsType
<CharityAffiliationDetail> CharityAffiliationDetailType
<AffiliationType> CharityAffiliationTypeCodeType </AffiliationType>
<CharityID> string </CharityID>
<LastUsedTime> dateTime </LastUsedTime>
</CharityAffiliationDetail>
<!-- ... more CharityAffiliationDetail nodes allowed here ... -->
</CharityAffiliationDetails>
<CharityRegistered> boolean </CharityRegistered>
<CheckoutEnabled> boolean </CheckoutEnabled>
<CIPBankAccountStored> boolean </CIPBankAccountStored>
<DomesticRateTable> boolean </DomesticRateTable>
<FeatureEligibility> FeatureEligibilityType
<QualifiedForAuctionOneDayDuration> boolean </QualifiedForAuctionOneDayDuration>
<QualifiedForFixedPriceOneDayDuration> boolean </QualifiedForFixedPriceOneDayDuration>
<QualifiesForBuyItNow> boolean </QualifiesForBuyItNow>
<QualifiesForBuyItNowMultiple> boolean </QualifiesForBuyItNowMultiple>
<QualifiesForVariations> boolean </QualifiesForVariations>
</FeatureEligibility>
<GoodStanding> boolean </GoodStanding>
<IntegratedMerchantCreditCardInfo> IntegratedMerchantCreditCardInfoType
<SupportedSite> SiteCodeType </SupportedSite>
<!-- ... more SupportedSite values allowed here ... -->
</IntegratedMerchantCreditCardInfo>
<InternationalRateTable> boolean </InternationalRateTable>
<MerchandizingPref> MerchandizingPrefCodeType </MerchandizingPref>
<PaisaPayEscrowEMIStatus> int </PaisaPayEscrowEMIStatus>
<PaisaPayStatus> int </PaisaPayStatus>
<PaymentMethod> SellerPaymentMethodCodeType </PaymentMethod>
<ProStoresPreference> ProStoresCheckoutPreferenceType
</ProStoresPreference>
<QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
<RecoupmentPolicyConsent> RecoupmentPolicyConsentType
<Site> SiteCodeType </Site>
<!-- ... more Site values allowed here ... -->
</RecoupmentPolicyConsent>
<RegisteredBusinessSeller> boolean </RegisteredBusinessSeller>
<SafePaymentExempt> boolean </SafePaymentExempt>
<SchedulingInfo> SchedulingInfoType
<MaxScheduledItems> int </MaxScheduledItems>
<MaxScheduledMinutes> int </MaxScheduledMinutes>
<MinScheduledMinutes> int </MinScheduledMinutes>
</SchedulingInfo>
<SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
<SellereBayPaymentProcessConsent> SellereBayPaymentProcessConsentCodeType
<PayoutMethod> PayoutMethodType </PayoutMethod>
<PayoutMethodSet> boolean </PayoutMethodSet>
<UserAgreementInfo> UserAgreementInfoType
<AcceptedTime> dateTime </AcceptedTime>
<SellereBayPaymentProcessEnableTime> dateTime </SellereBayPaymentProcessEnableTime>
<SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
<Site> SiteCodeType </Site>
<UserAgreementURL> anyURI </UserAgreementURL>
</UserAgreementInfo>
<!-- ... more UserAgreementInfo nodes allowed here ... -->
</SellereBayPaymentProcessConsent>
<SellereBayPaymentProcessStatus> SellereBayPaymentProcessStatusCodeType </SellereBayPaymentProcessStatus>
<SellerGuaranteeLevel> SellerGuaranteeLevelCodeType </SellerGuaranteeLevel>
<SellerLevel> SellerLevelCodeType </SellerLevel>
<SellerPaymentAddress> AddressType
<CityName> string </CityName>
<Country> CountryCodeType </Country>
<CountryName> string </CountryName>
<InternationalName> string </InternationalName>
<InternationalStateAndCity> string </InternationalStateAndCity>
<InternationalStreet> string </InternationalStreet>
<Name> string </Name>
<Phone> string </Phone>
<PostalCode> string </PostalCode>
<StateOrProvince> string </StateOrProvince>
<Street1> string </Street1>
<Street2> string </Street2>
</SellerPaymentAddress>
<StoreOwner> boolean </StoreOwner>
<StoreSite> SiteCodeType </StoreSite>
<StoreURL> anyURI </StoreURL>
<TopRatedSeller> boolean </TopRatedSeller>
<TopRatedSellerDetails> TopRatedSellerDetailsType
<TopRatedProgram> TopRatedProgramCodeType </TopRatedProgram>
<!-- ... more TopRatedProgram values allowed here ... -->
</TopRatedSellerDetails>
<TransactionPercent> float </TransactionPercent>
</SellerInfo>
<Site> SiteCodeType </Site>
<SkypeID> string </SkypeID>
<!-- ... more SkypeID values allowed here ... -->
<Status> UserStatusCodeType </Status>
<TUVLevel> int </TUVLevel>
<UniqueNegativeFeedbackCount> int </UniqueNegativeFeedbackCount>
<UniqueNeutralFeedbackCount> int </UniqueNeutralFeedbackCount>
<UniquePositiveFeedbackCount> int </UniquePositiveFeedbackCount>
<UserID> UserIDType (string) </UserID>
<UserIDChanged> boolean </UserIDChanged>
<UserIDLastChanged> dateTime </UserIDLastChanged>
<UserSubscription> EBaySubscriptionTypeCodeType </UserSubscription>
<!-- ... more UserSubscription values allowed here ... -->
<VATID> string </VATID>
<VATStatus> VATStatusCodeType </VATStatus>
</User>
<!-- 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>
</GetUserResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Call-specific Output Fields [Jump to standard fields] |
| User | UserType | Always |
Contains the returned user data for the specified eBay user.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.AboutMePage | boolean | Conditionally |
If true, indicates that the user has set up an About Me page.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.BillingEmail | string | Conditionally |
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.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.BusinessRole | BusinessRoleType | Always |
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.
Applicable values: • FullMarketPlaceParticipant (out) This value indicates that the eBay user's account is a fully provisioned account with buying and selling privileges on eBay. • Shopper (out) This value indicates that the eBay user's account is a Partially Provisioned Account without buying and selling privileges on eBay. |
| User.eBayGoodStanding | boolean | Conditionally |
If true, indicates that the user is in good standing with eBay.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.eBayWikiReadOnly | boolean | Always |
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. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.EIASToken | string | Conditionally |
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.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.Email | string | Conditionally |
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. Max length: 64 for US. May differ for other countries. Note: The eBay database allocates up to 128 characters for this field . DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. See:
|
| User.EnterpriseSeller | boolean | Always |
Reserved for internal or future use.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| User.FeedbackPrivate | boolean | Conditionally |
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. 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. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.FeedbackRatingStar | FeedbackRatingStarCodeType | Conditionally |
Visual indicator of user's feedback score. See FeedbackRatingStarCodeType for specific values.
Applicable values: • Blue (out) Blue Star, feedback score 50-99. • CustomCode (out) Reserved for internal or future use. • Green (out) Green Star, feedback score 5,000-9,999. • GreenShooting (out) Green Shooting Star, feedback score 500,000-999,999. • None (out) No graphic displayed, feedback score 0-9. • Purple (out) Purple Star, feedback score 500-999. • PurpleShooting (out) Purple Shooting Star, feedback score 50,000-99,999. • Red (out) Red Star, feedback score 1,000-4,999 • RedShooting (out) Red Shooting Star, feedback score 100,000-499,999. • SilverShooting (out) Silver Shooting Star, feedback score 1,000,000 and above. • Turquoise (out) Turquoise Star, feedback score 100-499. • TurquoiseShooting (out) Turquoise Shooting Star, feedback score 25,000-49,999. • Yellow (out) Yellow Star, feedback score 10-49. • YellowShooting (out) Yellow Shooting Star, feedback score 10,000-24,999. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.FeedbackScore | int | Conditionally |
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. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.IDVerified | boolean | Conditionally |
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
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.MotorsDealer | boolean | Conditionally |
Indicates if item is listed for sale by owner (FSBO) or listed by a dealer. Applies to eBay Motors Pro applications only.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.NewUser | boolean | Conditionally |
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).
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.PayPalAccountLevel | PayPalAccountLevelCodeType | Conditionally |
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.
Applicable values: • CustomCode (out) Reserved for internal or future use • InternationalUnverified (out) Account international unverified • InternationalVerified (out) Account international verified • Invalid
• Trusted (out) Account trusted • Unknown
• Unverified (out) Account unverified • Verified (out) Account verified DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.PayPalAccountStatus | PayPalAccountStatusCodeType | Conditionally |
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.
Applicable values: • Active (out) Account is active. • Closed (out) Account is closed. • CustomCode (out) Reserved for internal or future use • HighRestricted (out) Account is highly restricted. • Invalid
• Locked (out) Account is locked. • LowRestricted (out) Account restriction is low. • Unknown
• WireOff
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.PayPalAccountType | PayPalAccountTypeCodeType | Conditionally |
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.
Applicable values: • Business (out) Business account. • CustomCode (out) Reserved for internal or future use • Invalid
• Personal (out) Personal account. • Premier (out) Premier account. • Unknown
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.PositiveFeedbackPercent | float | Conditionally |
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.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.QualifiesForSelling | boolean | Conditionally |
Indicate whether user is eligible to list item or not.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.RegistrationAddress | AddressType | Conditionally |
Registration address for a user. GetUser: eBay returns complete RegistrationAddress details (including Phone), as applicable to the registration site, when you retrieve your own user data. 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.) DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.RegistrationAddress .CityName |
string | Conditionally |
The name of the user's city. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.RegistrationAddress .CompanyName |
string | Conditionally |
User's company name. Only returned if available. Not applicable to Half.com.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.RegistrationAddress .Country |
CountryCodeType | Conditionally |
The two-digit code representing the country of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider. Also applicable to Half.com (for GetOrders). Applicable values: See Country. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.RegistrationAddress .CountryName |
string | Conditionally |
The name of the user's country. Also applicable to Half.com (for GetOrders). Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.RegistrationAddress.Name | string | Conditionally |
User's name for the address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.RegistrationAddress.Phone | string | Conditionally |
User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number. In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components. Also applicable to Half.com (for GetOrders). Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.RegistrationAddress .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. For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. . DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.RegistrationAddress .StateOrProvince |
string | Conditionally |
The region of the user's address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.RegistrationAddress .Street |
string | Conditionally |
A concatenation of Street1 and Street2, primarily for RegistrationAddress. Not applicable to Half.com.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.RegistrationAddress .Street1 |
string | Conditionally |
Line 1 of the user's street address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. . DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.RegistrationAddress .Street2 |
string | Conditionally |
Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders). In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. . DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.RegistrationDate | dateTime | Conditionally |
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. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo | SellerType | Conditionally |
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), 3 (UK), 205 (Ireland) or 100 (Motors). See SellerType or SellerBusinessCodeType for the child elements. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .AllowPaymentEdit |
boolean | Conditionally |
Indicates whether the user as a seller by default allows buyers to edit the total cost of an item (while in checkout). (Sellers enable this property in their My eBay user preferences on the eBay site.)
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .CharityAffiliationDetails |
CharityAffiliationDetailsType | Conditionally |
Contains information about the seller's charity affiliations detail. 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.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .CharityAffiliationDetails .CharityAffiliationDetail |
CharityAffiliationDetailType | Conditionally,
repeatable: [0..*] |
Indicates the affiliation status for nonprofit charity organizations registered with the dedicated eBay Giving Works provider.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .CharityAffiliationDetails .CharityAffiliationDetail .AffiliationType |
CharityAffiliationTypeCodeType | Conditionally |
Indicates the affiliation status of the nonprofit charity organization registered with the eBay Giving Works provider.
Applicable values: • Community (out) The specified nonprofit charity organization has a community affiliation. • CustomCode (out) Reserved for internal or future use. • Direct (out) The specified nonprofit charity organization has direct affiliation. • Remove (out) The specified nonprofit charity organization is no longer affiliated. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .CharityAffiliationDetails .CharityAffiliationDetail .CharityID |
string | Conditionally |
The affiliation ID for nonprofit charity organizations registered with the dedicated eBay Giving Works provider.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .CharityAffiliationDetails .CharityAffiliationDetail .LastUsedTime |
dateTime | Conditionally |
Indicates the affiliation last used date of the nonprofit charity organization registered with the eBay Giving Works provider.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .CharityRegistered |
boolean | Always |
Indicates whether or not the seller is a registered charity seller. If CharityRegistered is false, the user must register with the eBay Giving Works provider to list items with eBay Giving Works.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .CheckoutEnabled |
boolean | Conditionally |
This flag indicates whether or not the seller's Checkout Enabled preference is turned on (at account level or at listing level). This preference is managed through Payment Preferences in My eBay. If this preference is enabled, a Pay Now button will appear in checkout flow pages and in the email notifications that are sent to buyers. This preferance is enabled by default if PayPal is one of the payment methods.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .CIPBankAccountStored |
boolean | Conditionally |
If true, this flag indicates that the seller has stored bank account information on file with eBay. A seller must have stored bank account information on file with eBay in order to use 'CashOnPickup' as a payment method (known as 'Pay upon Pickup' on the site). This field is applicable to all eBay sites that support 'CashOnPickup' as a payment method.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .DomesticRateTable |
boolean | Conditionally |
If true, the seller has configured a domestic shipping rate table on the DE, UK or US website.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .FeatureEligibility |
FeatureEligibilityType | Conditionally |
Contains eligibility details about seller- or platform-based features. This is returned only if IncludeFeatureEligibility is set to true in the request.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .FeatureEligibility .QualifiedForAuctionOneDayDuration |
boolean | Conditionally |
Indicates whether the seller is eligible to list an auction item with a one day duration on this site. Limitation: the Adult-Only and Auto Vehicle categories do not support one day auctions, so the seller cannot list items in these categories as one day auctions even if the seller has the eligibility.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .FeatureEligibility .QualifiedForFixedPriceOneDayDuration |
boolean | Conditionally |
Indicates whether the seller is eligible to list a fixed-price item with a one-day listing duration. A value of true means that the seller is eligible; a value of false indicates that the seller is not eligible. Note that this field only controls user eligibility. The listing type and category must support this feature for this field to be applicable.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .FeatureEligibility .QualifiesForBuyItNow |
boolean | Conditionally |
Indicates whether the seller is eligible to list items with the 'BuyItNow' option. A value of true means that the seller is eligible; a value of false indicates that they are not eligible.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .FeatureEligibility .QualifiesForBuyItNowMultiple |
boolean | Conditionally |
Indicates whether the seller is eligible to specify the 'BuyItNow' option for multiple-item listings. A value of true means that the seller is eligible; a value of false indicates that they are not eligible.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .FeatureEligibility .QualifiesForVariations |
boolean | Always |
Indicates whether or not the seller is eligible to list multi-variation items.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo.GoodStanding | boolean | Conditionally |
If true, indicates that the user is in good standing with eBay. (One of the requirements for listing a new item with Immediate Payment.)
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .IntegratedMerchantCreditCardInfo |
IntegratedMerchantCreditCardInfoType | Conditionally |
Indicates the sites on which a seller has a payment gateway account (and thus the sites on which the seller can use the IntegratedMerchantCreditCard payment method). Sellers use a payment gateway account to accept online credit cards.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .IntegratedMerchantCreditCardInfo .SupportedSite |
SiteCodeType | Conditionally,
repeatable: [0..*] |
Indicates a site on which a seller has a payment gateway account (and thus a site on which the seller can use the IntegratedMerchantCreditCard payment method).
Applicable values: See SupportedSite. |
|
User.SellerInfo .InternationalRateTable |
boolean | Conditionally |
If true, the seller has configured an international shipping rate table on the DE or UK website.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .MerchandizingPref |
MerchandizingPrefCodeType | Conditionally |
Indicates whether the seller participates in the Merchandising Manager feature. If so, the seller can set up rules for cross-promoting items from the seller's store. If not, eBay cross-promotes items as the seller's items are being viewed or purchased.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .PaisaPayEscrowEMIStatus |
int | Conditionally |
Indicates the seller's PaisaPayEscrowEMI (Equal Monthly Installment) registration status. India site only. 0 - Seller not registered 1 - Seller registered 7 - Seller eligible DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo.PaisaPayStatus | int | Conditionally |
Indicates the seller's PaisaPay and PaisapayEscrow registration status. India site only. 0 - Seller not registered 1 - Seller registered 2 - Seller registered but registration suspended 3 - Seller registered but outbound payment suspended DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo.PaymentMethod | SellerPaymentMethodCodeType | Conditionally |
Indicates the method the seller selected to pay eBay with for the account. The payment methods vary from one eBay site to the next.
Applicable values: • CreditCard (out) Credit Card • CustomCode (out) Reserved for internal or future use • DirectDebit (out) Direct Debit • DirectDebitPendingSignatureMandate (out) Direct Debit, pending signature mandate • DirectDebitPendingVerification (out) Direct Debit, pending verification • eBayDirectPay (out) eBay Direct Pay • NothingOnFile (out) Used for all other payment methods which are not specifically listed in other columns. • PayPal (out) PayPal DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .ProStoresPreference |
ProStoresCheckoutPreferenceType | Conditionally |
Details about the checkout preferences related to the ProStores store. Returned only if set by the user. (Currently those preferences are not settable using the public API.)
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .QualifiesForB2BVAT |
boolean | Conditionally |
Indicates whether the user is subject to VAT. Users who have registered with eBay as VAT-exempt are not subject to VAT.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .RecoupmentPolicyConsent |
RecoupmentPolicyConsentType | Always |
The list of the sites where a seller has agreed to the cross-border recoupment terms. Sellers who engage in cross-border trade on sites that require a recoupment agreement, must agree to the recoupment terms before adding items to the site. This agreement allows eBay to reimburse a buyer during a dispute and then recoup the cost from the seller. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .RecoupmentPolicyConsent.Site |
SiteCodeType | Conditionally,
repeatable: [0..*] |
Coming soon. Site codes for sites where the Seller has agreed to cross-border trade recoupment. This means that the site where the seller is trading requires a recoupment agreement for cross-border trade, and the seller has an agreement in effect.
Applicable values: See Site. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .RegisteredBusinessSeller |
boolean | Conditionally |
If true, the user is registered as a vehicle dealer on the eBay Motors site.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SafePaymentExempt |
boolean | Always |
If true, the user is currently exempt from the requirement to offer at least one safe payment method (PayPal/PaisaPay or one of the credit cards specified in Item.PaymentMethods) when listing items. This value should only return true for sellers who registered before January 17, 2007. Otherwise, it should return false. This setting overrides both the site and category values for SafePaymentRequired. Default: false. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo.SchedulingInfo | SchedulingInfoType | Conditionally |
Container for scheduling limits for the user. Conveys the minimum and maximum minutes the user may schedule listings in advance, as well as the maximum number of items the user may schedule.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo.SchedulingInfo .MaxScheduledItems |
int | Conditionally |
Maximum number of Items that a user may schedule.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo.SchedulingInfo .MaxScheduledMinutes |
int | Conditionally |
Maximum number of minutes that a listing may be scheduled in advance of its going live.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo.SchedulingInfo .MinScheduledMinutes |
int | Conditionally |
Minimum number of minutes that a listing may be scheduled in advance of its going live.
DetailLevel: ReturnAll. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellerBusinessType |
SellerBusinessCodeType | Conditionally |
Type of seller account. This value is returned if the German (ID 77), UK (ID 3), Ireland (ID 205), or eBay Motors (ID 100) sites are specified.
Applicable values: • Commercial (out) Commercial seller account. • CustomCode (out) Reserved for internal or future use. • Private (out) Private seller account. • Undefined (out) Type of seller account not defined. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessConsent |
SellereBayPaymentProcessConsentCodeType | Conditionally |
This container is returned to all DE and AT sellers and consists of details of the seller's account status regarding the new eBay payment process. This information includes the seller's payout preferences and whether or not the seller has accepted the supplemental user agreement for the new eBay payment process.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessConsent .PayoutMethod |
PayoutMethodType | Conditionally |
Enumeration value that indicates the account type that the DE or AT seller has selected as their default seller payout account. Once a DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, that seller must set the default payout account in My eBay preferences. eBay will distribute seller payouts to this account. This field will not be returned if PayoutMethodSet='false'. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. Applicable values: • EFT (out) This value indicates that the seller wants eBay to distribute payouts to their bank account via EFT (Electronic Funds Transfer). • MONEYBOOKERS (out) This value indicates that the seller wants eBay to distribute payouts to their Moneybookers (Skrill) account. • PAYPAL (out) This value indicates that the seller wants eBay to distribute payouts to their PayPal account. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessConsent .PayoutMethodSet |
boolean | Conditionally |
Flag to indicate whether or not a DE or AT seller has set the payout method type on the account. This field is always returned with the SellereBayPaymentProcessConsent container. Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessConsent .UserAgreementInfo |
UserAgreementInfoType | Conditionally,
repeatable: [0..*] |
Container consisting of details related to the current status of a DE or AT seller signing the required supplemental user agreement for the new eBay payment process. This container will always be returned to DE and AT sellers and the child values that are returned will be dependent on the current SellereBayPaymentProcessStatus value for the seller's account. If the seller lists items on both the DE and AT sites, a UserAgreementInfo container will be returned for each site, with the sites being distinguished by the UserAgreementInfo.Site value (either 'Germany' or 'Austria'). Note: The introduction of the new eBay payment process for the Germany and Austria eBay sites has been delayed until further notice. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessConsent .UserAgreementInfo .AcceptedTime |
dateTime | Conditionally |
This timestamp indicates the date on which the DE or AT seller accepted the supplemental user agreement for the new payment process. Unless the UserAgreementInfo.SellereBayPaymentProcessStatus value is 'MustAcceptUA', this value is always returned with UserAgreementInfo container. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessConsent .UserAgreementInfo .SellereBayPaymentProcessEnableTime |
dateTime | Conditionally |
This timestamp indicates the date on which the new eBay payment process was fully enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='eBayPaymentProcessEnabled') or scheduled to be enabled (if UserAgreementInfo.SellereBayPaymentProcessStatus='AcceptedUA' or 'MustAcceptUA', and the enable date is known by eBay). Unless the eBay payment process enable date is not known for the seller, this value is always returned with UserAgreementInfo container. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessConsent .UserAgreementInfo .SellereBayPaymentProcessStatus |
SellereBayPaymentProcessStatusCodeType | Conditionally |
Enumeration value that indicates whether or not a new DE or AT seller has accepted the supplement user agreement for the new payment process for that site (indicated by the UserAgreementInfo.site value). This value is always returned with the UserAgreementInfo container. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. Applicable values: • AcceptedUA (out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account. • CustomCode (out) Reserved for internal or future use • eBayPaymentProcessEnabled (out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account. • MustAcceptUA (out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessConsent .UserAgreementInfo.Site |
SiteCodeType | Conditionally |
String value that indicates the site to which the supplemental user agreement information pertains. This value is always returned with the UserAgreementInfo container. Although this value is based on SiteCodeType (which contains many values), the only values that will be returned here are 'Germany' or 'Austria'. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. Applicable values: See Site. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessConsent .UserAgreementInfo .UserAgreementURL |
anyURI | Conditionally |
This is the URL for new eBay payment process supplemental user agreement. This URL is only returned if the UserAgreementInfo.SellereBayPaymentProcessStatus='MustAcceptUA'. Note: The introduction of the new eBay payment process for the entire German and Austrian eBay marketplace has been delayed until further notice. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellereBayPaymentProcessStatus |
SellereBayPaymentProcessStatusCodeType | Conditionally |
This enumeration value indicates the current status of a DE or AT seller's account related to the new eBay payment process. 'AcceptedUA' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, but that same seller's account is not yet ramped up in the new eBay payment process. 'eBayPaymentProcessEnabled' is returned if the DE or AT seller has accepted the supplemental user agreement for the new eBay payment process, and that same seller's account is ramped up in the new eBay payment process. 'MustAcceptUA' is returned if the DE or AT seller has not accepted the supplemental user agreement for the new eBay payment process. If this is the case, the seller can find the URL to the supplemental user agreement in the SellereBayPaymentProcessConsent.UserAgreementInfo.UserAgreementURL field. Applicable values: • AcceptedUA (out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process, but the new payment process has yet to be fully implemented on the seller's account. • CustomCode (out) Reserved for internal or future use • eBayPaymentProcessEnabled (out) This value indicates that the DE or AT seller has accepted the supplemental user agreement related to the new payment process and the new payment process is fully implemented on the seller's account. • MustAcceptUA (out) This value indicates that the DE or AT seller has yet to accept the supplemental user agreement related to the new payment process. If the new payment process has been fully implemented on the seller's account, this seller will be blocked from listing on the DE and AT sites until the user agreement is accepted. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellerGuaranteeLevel |
SellerGuaranteeLevelCodeType | Conditionally |
Deprecated as of version 773. No longer recommended. No longer supported. Applicable values: • CustomCode (out) Reserved for internal or future use. • NotEligible (out) Not eligible for Seller Level Guarantee • Premium (out) Premium eligibility level • Regular (out) Regular eligibility level • Ultra (out) Ultra eligibility level DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. Deprecation version: 773. See also Deprecated Objects. |
| User.SellerInfo.SellerLevel | SellerLevelCodeType | Conditionally |
The user's eBay PowerSeller tier. Possible values are enumerated in the SellerLevelCodeType code list. SellerInfo.SellerLevel is no longer returned in the GetUser, GetBidderList, GetSellerList, GetItem, and GetItemTransactions responses for the US, DE/AT/CH, and UK/IE sites, for version 629 and later. If you are using a version older than 629, SellerInfo.SellerLevel will still be returned. Developers should note that SellerInfo.SellerLevel could potentially be removed from other sites as well.
Applicable values: • Bronze (out) Bronze (lowest tier) • CustomCode (out) Reserved for internal or future use • Gold (out) Gold (between Silver and Platinum) • None (out) Not a PowerSeller (eBay has not yet evaluated your PowerSeller status, or you have not chosen to be a member of the PowerSeller program, or you lost your PowerSeller status due to a policy violation.) • Platinum (out) Platinum (between Gold and Titanium) • Silver (out) Silver (between Bronze and Gold) • Titanium (out) Titanium (highest tier) DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .SellerPaymentAddress |
AddressType | Conditionally |
Address used by eBay for purposes of billing the user for seller fees.
DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress.CityName |
string | Conditionally |
The name of the user's city. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress.Country |
CountryCodeType | Conditionally |
The two-digit code representing the country of the user. If not provided as input for GetCart or SetCart, eBay uses the country associated with the SiteID in effect when the call is made. For a Global Shipping Program order, GetSellerList returns the country code of the buyer, not the international shipping provider. Also applicable to Half.com (for GetOrders). Applicable values: See Country. DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress .CountryName |
string | Conditionally |
The name of the user's country. Also applicable to Half.com (for GetOrders). Max length: eBay validates the content, but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress .InternationalName |
string | Conditionally |
Seller's international name that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress .InternationalStateAndCity |
string | Conditionally |
International state and city for the seller's payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress .InternationalStreet |
string | Conditionally |
Seller's international street address that is associated with the payment address. Only applicable to SellerPaymentAddress. Not applicable to Half.com.
DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress.Name |
string | Conditionally |
User's name for the address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress.Phone |
string | Conditionally |
User's primary phone number. This may return a value of "Invalid Request" if you are not authorized to see the user's phone number. In the US, the area code (3 digits), the prefix (3 digits), the line number (4 digits), and phone extension (if specified by the user) are returned in this field. The extension can be one or more digits. Non-breaking spaces are used as delimiters between these phone number components. Also applicable to Half.com (for GetOrders). Max length: eBay validates the content (should only be integer values and delimiters), but not the length for this field. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress .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. For a Global Shipping Program order, GetSellerList and GetMyeBaySelling return the postal code of the buyer, not that of the international shipping provider. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 9 (not counting delimiter characters) for the US. Note: The eBay database allocates up to 24 characters for this field. . DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress .StateOrProvince |
string | Conditionally |
The region of the user's address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 64 for the US. Note: The eBay database allocates up to 128 characters for this field. . DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress.Street1 |
string | Conditionally |
Line 1 of the user's street address. Also applicable to Half.com (for GetOrders). Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. . DetailLevel: ReturnAll. |
|
User.SellerInfo .SellerPaymentAddress.Street2 |
string | Conditionally |
Line 2 of the user's address (such as an apartment number). Returned if the user specified a second street value for their address. Also applicable to Half.com (for GetOrders). In case of Item.SellerContactDetails, Street2 can be used to provide City, Address, State, and Zip code (if applicable). Max length: This varies based on the user's country. Currently, the maximum length is 180 for the US. Note: The eBay database allocates up to 512 characters for this field. . DetailLevel: ReturnAll. |
| User.SellerInfo.StoreOwner | boolean | Conditionally |
Boolean value indicates whether or not the seller is an eBay Store owner.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo.StoreSite | SiteCodeType | Conditionally |
The site associated with the seller's eBay Store.
Applicable values: See StoreSite. |
| User.SellerInfo.StoreURL | anyURI | Conditionally |
The URL for the seller's eBay Store. This field is only returned if the seller is a store owner. To determine if a seller is a Store owner, check for the User.SellerInfo.StoreOwner and a value of true. The eBay Stores domain that is returned in this field is based on the SITEID header that is passed in the request, and not on the user's registration address, as was the case prior to version 757. So, if the seller's registration county is the UK, but a SITEID value of 71 (France) is passed into the call, the eBay Stores domain that is returned would be stores.ebay.fr.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo.TopRatedSeller | boolean | Conditionally |
This boolean field indicates if the seller is certified as a Top Rated Seller. To qualify as a Top Rated Seller, a seller must meet the following requirements:
On the eBay US site, Top Rated Sellers are eligible to receive a Top Rated Plus seal for their listings. For a Top Rated Seller's listing to qualify as a Top Rated Plus listing, that listing must accept returns and the handling time must be set to one day (DispatchTimeMax= 1). Top Rated Plus listings get increased visibility in fixed-price searches and receive a Final Value Fee discount.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. See:
|
|
User.SellerInfo .TopRatedSellerDetails |
TopRatedSellerDetailsType | Conditionally |
Contains top-rated seller program details for the seller.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .TopRatedSellerDetails .TopRatedProgram |
TopRatedProgramCodeType | Conditionally,
repeatable: [0..*] |
Coming soon. Top-rated seller program details for the seller. Returned when the seller is qualified as a top-rated seller.
Applicable values: • CustomCode (out) Reserved for internal or future use. • DE (out) Specifies the German Top-Rated Seller Program. • Global (out) Specifies the Global Top-Rated Seller Program. • UK (out) Specifies the UK Top-Rated Seller Program. • US (out) Specifies the US Top-Rated Seller Program. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .TransactionPercent |
float | Conditionally |
Percentage of the number of times a member has sold successfully vs. the number of times a member has bought an item in the preceding 365 days.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.Site | SiteCodeType | Conditionally |
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. Applicable values: See Site. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SkypeID | string | Conditionally,
repeatable: [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.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.Status | UserStatusCodeType | Conditionally |
Indicates the user's registration/user status.
Applicable values: • AccountOnHold (out) User's account is on hold, such as for non-payment of amounts due eBay; user cannot sell or buy items • Confirmed (out) User has completed online registration and has properly responded to confirmation email; most users should fall in this category • CreditCardVerify (out) User has completed registration and confirmation, but needs to complete verification of credit card information. A user has this status if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.) • CreditCardVerifyHalfOptIn (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the user needs to complete verification of credit card information. A user has this status on eBay if this user began registration as a seller but did not complete it. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.) • CustomCode (out) Reserved for internal or future use • Deleted (out) Records for the specified user have been deleted • Ghost (out) Registered users of AuctionWeb (pre-eBay) who never re-registered on eBay • Guest (out) The user is a guest user. The user has not added a password and has not confirmed an email address. The user has not signed up as a regular user, but has agreed to the User Agreement and Privacy Policy. The user has been through the buying flow for a guest; the user has been through checkout using the streamlined Buy-It-Now flow. • InMaintenance (out) Temporary user record state indicating the record is in the process of being changed by eBay; query user information again to get new status • Merged (out) User record has been merged with another account record for the same user • RegistrationCodeMailOut (out) User has completed online registration and has been sent the confirmation email, but has not yet responded to the confirmation email • Suspended (out) User has been suspended from selling and buying, such as for violations of eBay terms or agreement • TermPending (out) User has been scheduled for account closure (typically when a user has requested to have their account closed) A user in this state should not be considered an active user • Unconfirmed (out) User has completed online registration, but has either not responded to confirmation email or has not yet been sent the confirmation email. Or, if this user began registration as a seller but did not complete it, the user will have this status. A seller with this status can begin to list an item but cannot complete the listing until the seller completes seller registration. (For information on what is needed to complete seller registration, see http://pages.ebay.com/help/sell/questions/sell-requirements.html.) • UnconfirmedHalfOptIn (out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending • Unknown (out) User properties have never been set; this value should seldom, if ever, be returned and typically represents a problem (Not all values in UserStatusCodeType apply to this field.) DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.TUVLevel | int | Conditionally |
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.
DetailLevel: ReturnAll. |
|
User .UniqueNegativeFeedbackCount |
int | Conditionally |
Total count of negative Feedback entries received by the user, including weekly repeats.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User .UniqueNeutralFeedbackCount |
int | Conditionally |
Total count of neutral Feedback entries received by the user, including weekly repeats.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User .UniquePositiveFeedbackCount |
int | Conditionally |
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 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.). 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.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.UserID | UserIDType (string) | Conditionally |
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". Note that 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. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.UserIDChanged | boolean | Conditionally |
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. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.UserIDLastChanged | dateTime | Conditionally |
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. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.UserSubscription | EBaySubscriptionTypeCodeType | Conditionally,
repeatable: [0..*] |
Specifies the subscription level for a user.
Applicable values: See UserSubscription. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.VATID | string | Conditionally |
The value added tax identifier (VATID) is applicable to the VAT-enabled sites. Applies to eBay Motors Pro applications only.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.VATStatus | VATStatusCodeType | Conditionally |
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).
Applicable values: • CustomCode (out) Reserved for internal or future use • NoVATTax (out) VAT is not applicable • VATExempt (out) Residence in a country with VAT and user is registered as VAT-exempt • VATTax (out) Residence in a country with VAT and user is not registered as VAT-exempt DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| Standard Output 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 |
Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned. Note: GetCategories is 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 | Conditionally,
repeatable: [0..*] |
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. See the "Errors by Number" document. |
| Errors.ErrorParameters | ErrorParameterType | Conditionally,
repeatable: [0..*] |
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 and other Trading API calls 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. |
| Input Output Samples Change History Top Errors for GetUser User Notes |
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.
| Y | The field is always returned. |
| (Y) | The field is conditionally returned. See the field documentation for clarification of conditions. |
| - | The field is not returned. |
| Input Output Detail Controls Change History Top Errors for GetUser User Notes |
New to making API calls? Please see Routing the Request.
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 the data for a single user registered on the eBay site.
Description
Bountiful Buyer has found a rare Harry potter book on eBay, and it is listed by the seller magicalbookseller. Bountiful Buyer is interested in getting information about the seller. This call retrieves detailed information on magicalbookseller, which helps Bountiful Buyer determine if the seller is trustworthy.
Input
The input needed for Bountiful Buyer to get information on the seller is the UserID for magicalbookseller.
XML format (HTTP POST). Also available is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <GetUserRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <RequesterCredentials> <eBayAuthToken>ABC...123</eBayAuthToken> </RequesterCredentials> <UserID>magicalbookseller</UserID> </GetUserRequest>
Output
The important information in the output includes the FeedbackScore, PositiveFeedbackPercent, eBayGoodStanding, and the SellerInfo. This information helps the Bountiful Buyer to decide whether or not to bid on the seller's listing.
XML format. Also available is the .txt version of this XML. <GetUserResponse xmlns="urn:ebay:apis:eBLBaseComponents"> <Timestamp>2010-02-10T19:04:51.423Z</Timestamp> <Ack>Success</Ack> <Version>653</Version> <Build>E653_CORE_BUNDLED_10549562_R1</Build> <User> <AboutMePage>false</AboutMePage> <EIASToken>nZ+sHZ2PrBmdj6wVnY+sEZ2PrA2dj6wGl4CjCJeEogSdj6x9nY+seQ==</EIASToken> <Email>Invalid Request</Email> <FeedbackScore>431</FeedbackScore> <UniqueNegativeFeedbackCount>0</UniqueNegativeFeedbackCount> <UniquePositiveFeedbackCount>128</UniquePositiveFeedbackCount> <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent> <FeedbackPrivate>false</FeedbackPrivate> <FeedbackRatingStar>Turquoise</FeedbackRatingStar> <IDVerified>true</IDVerified> <eBayGoodStanding>true</eBayGoodStanding> <NewUser>false</NewUser> <RegistrationDate>2005-12-04T21:48:09.000Z</RegistrationDate> <Site>US</Site> <Status>Confirmed</Status> <UserID>magicalbookseller</UserID> <UserIDChanged>false</UserIDChanged> <UserIDLastChanged>2009-01-20T20:54:42.000Z</UserIDLastChanged> <VATStatus>NoVATTax</VATStatus> <SellerInfo> <AllowPaymentEdit>true</AllowPaymentEdit> <CheckoutEnabled>true</CheckoutEnabled> <CIPBankAccountStored>false</CIPBankAccountStored> <GoodStanding>true</GoodStanding> <LiveAuctionAuthorized>false</LiveAuctionAuthorized> <MerchandizingPref>OptIn</MerchandizingPref> <QualifiesForB2BVAT>false</QualifiesForB2BVAT> <SellerGuaranteeLevel>NotEligible</SellerGuaranteeLevel> <SchedulingInfo> <MaxScheduledMinutes>30240</MaxScheduledMinutes> <MinScheduledMinutes>0</MinScheduledMinutes> <MaxScheduledItems>3000</MaxScheduledItems> </SchedulingInfo> <StoreOwner>true</StoreOwner> <StoreURL>http://www.stores.sandbox.ebay.com/id=132854966</StoreURL> <ExpressEligible>false</ExpressEligible> <StoreSite>US</StoreSite> <ExpressWallet>false</ExpressWallet> <CharityRegistered>false</CharityRegistered> <SafePaymentExempt>true</SafePaymentExempt> <TransactionPercent>52.3</TransactionPercent> </SellerInfo> <eBayWikiReadOnly>false</eBayWikiReadOnly> <MotorsDealer>false</MotorsDealer> <UniqueNeutralFeedbackCount>2</UniqueNeutralFeedbackCount> <EnterpriseSeller>false</EnterpriseSeller> </User> </GetUserResponse>
| Input Output Detail Controls Samples Top Errors for GetUser User Notes |
| Version | Description |
|---|---|
| 787 2012-08-29 |
|
| 777 2012-06-06 |
|
| 765 2012-03-14 |
|
| 689 2010-09-21 |
|
| 657 2010-02-17 |
|
| 629 2009-08-05 |
|
| 623 2009-06-24 |
|
| 605 2009-02-18 |
|
| 603 2009-02-04 |
|
| 563 2008-04-30 |
|
| 561 2008-04-16 |
|
| 549 2008-01-24 |
|
| 537 2007-10-31 |
|
| 535 2007-10-17 |
|
| 507 2007-04-04 |
|
| 503 2007-03-07 |
|
| 483 2006-10-18 |
|
| 475 2006-8-23 |
|
| 469 2006-7-12 |
|
| 467 2006-06-28 |
|
| 465 2006-06-14 |
|
| 459 2006-05-03 |
|
| 561 2008-4-16 |
|
| 473 2006-8-9 |
|
| 433 2005-11-2 |
|
| 429 2005-10-5 |
|
| 425 2005-9-7 |
|
| Input Output Detail Controls Samples Change History Top Errors for GetUser User Notes |
Copyright © 2005–2013 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.