| List of All Calls Field Index Enumeration Index Type Index Deprecated Objects Errors by Number |
| Input Output Detail Controls Samples Change History Top Errors for GetUser User Notes |
Input/Output ReferenceVersion 563
Retrieves information about a user. Input fields control what user data is returned. This includes the eBay user ID for the user whose data is to be returned and the item ID for a listing to indicate a transactional relationship between the requestor and the target user.
See Managing User Information.
| 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 may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).
<?xml version="1.0" encoding="utf-8"?>
<GetUserRequest xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- Standard Input Fields -->
<DetailLevel> DetailLevelCodeType </DetailLevel>
<!-- ... more DetailLevel nodes here ... -->
<ErrorLanguage> string </ErrorLanguage>
<MessageID> string </MessageID>
<Version> string </Version>
<WarningLevel> WarningLevelCodeType </WarningLevel>
<!-- Call-specific Input Fields -->
<IncludeExpressRequirements> boolean </IncludeExpressRequirements>
<ItemID> ItemIDType (string) </ItemID>
<UserID> string </UserID>
</GetUserRequest>
| Argument | Type | Reqd? | Meaning |
|---|---|---|---|
| Standard Input Fields [Jump to call-specific fields] | |||
| DetailLevel | DetailLevelCodeType (repeatable) |
Optional |
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 See Tags for the Identification of Languages. |
| MessageID | string | Optional |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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: HTTP Headers (XML API Only) eBay Schema Versioning Strategy Lowest Supported Version |
| 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. |
| Call-specific Input Fields | |||
| IncludeExpressRequirements | boolean | Optional |
Indicates if the response should include detailed information relating to whether a user qualifies to list an item on Express. To list an item on Express, a user must qualify based on conditions described in the eBay Web Services Guide. Default: false. See Seller Criteria for eBay Express. |
| ItemID | ItemIDType (string) | Optional |
Specifies 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 | Specifies the user whose data will be returned by the call. UserID is optional. If not specified, the user data returned is for the requesting user (as specified with the eBayAuthToken). |
| Input Detail Controls Samples Change History Top Errors for GetUser User Notes |
The box below lists all fields that might be returned in the call 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).
The XML prototype may be missing some XML fields and attributes. This is a documentation limitation only (see Limitations of This Document).
<?xml version="1.0" encoding="utf-8"?>
<GetUserResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- 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 here ... -->
<LongMessage> string </LongMessage>
<SeverityCode> SeverityCodeType </SeverityCode>
<ShortMessage> string </ShortMessage>
</Errors>
<!-- ... more Errors nodes here ... -->
<HardExpirationWarning> string </HardExpirationWarning>
<Timestamp> dateTime </Timestamp>
<Version> string </Version>
<!-- Call-specific Output Fields -->
<User> UserType
<AboutMePage> boolean </AboutMePage>
<eBayGoodStanding> boolean </eBayGoodStanding>
<eBayWikiReadOnly> boolean </eBayWikiReadOnly>
<EIASToken> string </EIASToken>
<Email> string </Email>
<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>
<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>
<RESTToken> string </RESTToken>
<SellerInfo> SellerType
<AllowPaymentEdit> boolean </AllowPaymentEdit>
<CharityAffiliationDetails> CharityAffiliationDetailsType
<CharityAffiliationDetail> CharityAffiliationDetailType
<AffiliationType> CharityAffiliationTypeCodeType </AffiliationType>
<CharityID> string </CharityID>
<LastUsedTime> dateTime </LastUsedTime>
</CharityAffiliationDetail>
<!-- ... more CharityAffiliationDetail nodes here ... -->
</CharityAffiliationDetails>
<CharityRegistered> boolean </CharityRegistered>
<CheckoutEnabled> boolean </CheckoutEnabled>
<CIPBankAccountStored> boolean </CIPBankAccountStored>
<ExpressEligible> boolean </ExpressEligible>
<ExpressSellerRequirements> ExpressSellerRequirementsType
<CombinedPaymentsAccepted> boolean </CombinedPaymentsAccepted>
<EligiblePayPalAccount> boolean </EligiblePayPalAccount>
<ExpressApproved> boolean </ExpressApproved>
<ExpressSellingPreference> boolean </ExpressSellingPreference>
<FeedbackAsSellerScore minimum="string"> FeedbackRequirementsType (boolean) </FeedbackAsSellerScore>
<FeedbackPublic> boolean </FeedbackPublic>
<FeedbackScore minimum="string"> FeedbackRequirementsType (boolean) </FeedbackScore>
<GoodStanding> boolean </GoodStanding>
<PayPalAccountAcceptsUnconfirmedAddress> boolean </PayPalAccountAcceptsUnconfirmedAddress>
<PositiveFeedbackAsSellerPercent minimum="string"> FeedbackRequirementsType (boolean) </PositiveFeedbackAsSellerPercent>
<PositiveFeedbackPercent minimum="string"> FeedbackRequirementsType (boolean) </PositiveFeedbackPercent>
</ExpressSellerRequirements>
<ExpressWallet> boolean </ExpressWallet>
<GoodStanding> boolean </GoodStanding>
<LiveAuctionAuthorized> boolean </LiveAuctionAuthorized>
<MerchandizingPref> MerchandizingPrefCodeType </MerchandizingPref>
<PaisaPayEscrowEMIStatus> int </PaisaPayEscrowEMIStatus>
<PaisaPayStatus> int </PaisaPayStatus>
<ProStoresPreference> ProStoresCheckoutPreferenceType
</ProStoresPreference>
<QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
<RegisteredBusinessSeller> boolean </RegisteredBusinessSeller>
<SafePaymentExempt> boolean </SafePaymentExempt>
<SchedulingInfo> SchedulingInfoType
<MaxScheduledItems> int </MaxScheduledItems>
<MaxScheduledMinutes> int </MaxScheduledMinutes>
<MinScheduledMinutes> int </MinScheduledMinutes>
</SchedulingInfo>
<SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
<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>
<TransactionPercent> float </TransactionPercent>
</SellerInfo>
<SellerPaymentMethod> SellerPaymentMethodCodeType </SellerPaymentMethod>
<Site> SiteCodeType </Site>
<SkypeID> string </SkypeID>
<!-- ... more SkypeID nodes 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 nodes here ... -->
<VATID> string </VATID>
<VATStatus> VATStatusCodeType </VATStatus>
</User>
</GetUserResponse>
| Return Value | Type | Returned? | Meaning |
|---|---|---|---|
| Standard Output Fields [Jump to call-specific 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 |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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 (repeatable) |
Conditionally |
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. |
| Errors.ErrorParameters | ErrorParameterType (repeatable) |
Conditionally | 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, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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. |
| Call-specific Output 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.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. 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. See Working with Anonymous User Information. |
| User.Email | string | Conditionally |
Email address for the user. You cannot retrieve an email address for any user with whom you do not have a transactional relationship, regardless of site. Email is only returned for applicable calls when you are retrieving your own user data OR when you and the other user are in a transactional relationship and the call is being executed within a certain amount of time after the transaction is created. Based on Trust and Safety policies, the time is unspecified and can vary by site. 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. See Working with Anonymous User Information. |
| 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. To be eligible to list on Express, a seller's feedback needs to be public. See "eBay Express" in the eBay Web Services guide. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. 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. See Working with Anonymous User Information. |
| 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. • 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 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 transactions. Each transaction can result in one feedback entry for a given user (the buyer can leave feedback for the seller, and the seller can leave feedback for the buyer.). That one feedback can be positive, negative, or neutral. The aggregated feedback counts for a particular user represent that user's overall feedback score (referred to as a "feedback rating" on the eBay site). If the user has chosen to make their feedback private and that user is not the user identified in the request's authentication token, FeedbackScore is not returned and FeedbackPrivate is returned with a value of true. To be eligible to list on Express, a seller's feedback score needs to be 100 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResultsExpress, only returned when ItemDetails is set to Fine. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request. 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. See Working with Anonymous User Information. |
| 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 specify Item.DigitalDeliveryDetails in listing requests. 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 specify Item.DigitalDeliveryDetails in listing requests. 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 specify Item.DigitalDeliveryDetails in listing requests. See the eBay Web site online help for current PayPal requirements for listing digital items. Please note that this information cannot necessarily be used to determine whether a seller is eligible to list items on eBay Express, because a seller can have more than one PayPal account (and any of these accounts can be used for a given listing).
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. To be eligible to list on Express, a seller's feedback percent needs to be 98 or higher. See "eBay Express" in the eBay Web Services guide. In GetSearchResults and GetCategoryListings, feedback information is only returned if IncludeFeedback = true in the request.
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: RegistrationAddress for another user (except for Phone) is only returned if you have a transactional relationship with that user AND that user is registered on DE/AT/CH, regardless of your registration site and the site to which you send the request. For example, the seller can see the buyer's registration address if the buyer is registered on DE/AT/CH, or the buyer can see the seller's registration address if the seller is registered on DE/AT/CH. (The buyer and seller won't see their own registration addresses in GetItem.) To be eligible to list on Express US, a seller's registration address must be in the US or Canada. To list on Express Germany, a seller's registration address must be in Germany. See "eBay Express" in the eBay Web Services guide. Note: At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information. 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: 64. 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 country code 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. 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).
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: 64. 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. Also applicable to Half.com (for GetOrders).
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. Also applicable to Half.com (for GetOrders). Max length: 12. 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: 64. 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: 100. 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: 100. 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. See Working with Anonymous User Information. |
| User.RESTToken | string | Conditionally |
This token is for the Trading API. For REST calls, it is recommended that you use the Shopping API instead of the Trading API. See Shopping API for more information. The RESTToken field contains the REST token (if available) for the user who is making the request. Not returned when UserID is for a different user than the one identified in eBayAuthToken. Use the REST token to authenticate REST API calls in the Trading API.
DetailLevel: ReturnAll. |
| User.SellerInfo | SellerType | Conditionally |
Contains information about the user as a seller, such as whether the seller is authorized to list Live Auction items or opts to have items cross-promoted. 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. See eBay Giving Works Program. |
|
User.SellerInfo .CharityAffiliationDetails .CharityAffiliationDetail |
CharityAffiliationDetailType (repeatable) |
Conditionally |
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. See eBay Giving Works for Seller. |
|
User.SellerInfo .CheckoutEnabled |
boolean | Conditionally |
Indicates whether the user as a seller has the option set to default new item listings to go through 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 .CIPBankAccountStored |
boolean | Conditionally |
If true, indicates that the user has stored bank account information with eBay in order to use the "CIP in checkout" feature. Applicable to all eBay sites that support CIP as a payment method.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .ExpressEligible |
boolean | Always |
If true, the user is currently eligible to sell items on eBay Express, based on the data available to eBay at the time you execute the call (e.g., GetUser). Users registered in the US or Canada are eligible to sell on Express US. Users registered in Germany are eligible to sell on Express Germany. However, a user can still be disqualified at any time if their feedback score changes or some other event occurs that would normally disqualify a seller for Express. If false, the user is not currently eligible to sell items on Express. In this case, you can determine probable causes by calling GetUser and examining the fields in the ExpressSellerRequirements node. Note: At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information. Due to latency of batch jobs that update the seller's Express eligibility, it may be possible for the value of ExpressEligible and the values in ExpressSellerRequirements to be inconsistent. For example, if the seller changes their combined payment preference, the value of the CombinedPaymentsAccepted flag in ExpressSellerRequirements could change, but it could take up to 7 days for the seller's Express eligibility to change. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. See Seller Criteria for eBay Express. |
|
User.SellerInfo .ExpressSellerRequirements |
ExpressSellerRequirementsType | Conditionally |
Contains detailed data relating to whether a seller qualifies as an Express seller. Whether a child tag is returned can depend on whether its value would be true or false, whether the seller is registered on an applicable eBay site, or the order of eligibility precedence. The seller requirements are assessed in this order: - ExpressSellingPreference - ExpressApproved - All other settings Due to latency of batch jobs that update the seller's Express eligibility, it may be possible for the value of ExpressEligible and the values in ExpressSellerRequirements to be inconsistent. For example, if the seller changes their combined payment preference, the value of the CombinedPaymentsAccepted flag in ExpressSellerRequirements could change, but it could take up to 7 days for the seller's Express eligibility to change. DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. See Seller Criteria for eBay Express. |
|
User.SellerInfo .ExpressSellerRequirements .CombinedPaymentsAccepted |
boolean | Conditionally |
If true, the seller accepts combined payments. If false, the seller doesn't accept combined payments (and the seller is therefore ineligible for Express, if the site requires this preference).
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .ExpressSellerRequirements .EligiblePayPalAccount |
boolean | Conditionally |
If true, the seller has an eligible PayPal account for Express. Only returned if the site assesses this requirement at the seller level.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .ExpressSellerRequirements .ExpressApproved |
boolean | Conditionally |
If true, indicates eBay has marked the seller as eligible for eBay Express based on direct evaluation. Only returned if true, and no other seller requirement settings are returned in this case. For example, on the eBay Germany site, sellers need to fill out an application to become eligible to list on Express Germany. If they are approved, eBay sets ExpressApproved to true and no other seller requirement settings are relevant. Note: At the end of April 2008, UK and Germany eBay Express will be shutdown. No users will be eligible to list on these sites. All users previously registered on UK and Germany Express will have their registered status revoked. Any Express only items listed on these sites will be ended and credited the full insertion fee to their sellers. Please refer to the respective Express sites for more information.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .ExpressSellerRequirements .ExpressSellingPreference |
boolean | Conditionally |
If true, the seller's preferences in My eBay are set to include listings on eBay Express. If false, the seller prefers not to include listings on Express, so the seller is therefore ineligible for Express (and no other seller requirement settings are returned in this case).
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. See (GetUserPreferences) ExpressPreferences.ExpressSellingPreference. |
|
User.SellerInfo .ExpressSellerRequirements .FeedbackAsSellerScore |
FeedbackRequirementsType (boolean) | Conditionally |
If true, indicates that the seller meets the Express site's minimum feedback requirement (if any) for transactions as a seller (not a buyer).
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo .ExpressSellerRequirements .FeedbackAsSellerScore [ attribute minimum ] |
string | Conditionally | Used to determine whether the seller meets the minimum feedback requirements for Express. |
|
User.SellerInfo .ExpressSellerRequirements .FeedbackPublic |
boolean | Conditionally |
If true, the seller's feedback profile is public. If false, the seller's feedback details are private; that is, User.FeedbackPrivate is true (and the seller is therefore ineligible).
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .ExpressSellerRequirements .FeedbackScore |
FeedbackRequirementsType (boolean) | Conditionally |
If true, indicates that the seller meets the site's minimum total feedback requirement for Express.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo .ExpressSellerRequirements .FeedbackScore [ attribute minimum ] |
string | Conditionally | Used to determine whether the seller meets the minimum feedback requirements for Express. |
|
User.SellerInfo .ExpressSellerRequirements .GoodStanding |
boolean | Conditionally |
If true, the user has a seller account in good standing.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .ExpressSellerRequirements .PayPalAccountAcceptsUnconfirmedAddress |
boolean | Conditionally |
If true, the seller has a PayPal account that accepts a payment from a buyer with an unconfirmed address. Only returned if the site assesses this requirement at the seller level.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
|
User.SellerInfo .ExpressSellerRequirements .PositiveFeedbackAsSellerPercent |
FeedbackRequirementsType (boolean) | Conditionally |
If true, indicates that the seller meets the Express site's minimum positive feedback requirement (if any) for transactions as a seller (not a buyer).
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo .ExpressSellerRequirements .PositiveFeedbackAsSellerPercent [ attribute minimum ] |
string | Conditionally | Used to determine whether the seller meets the minimum feedback requirements for Express. |
|
User.SellerInfo .ExpressSellerRequirements .PositiveFeedbackPercent |
FeedbackRequirementsType (boolean) | Conditionally |
If true, indicates that the seller meets the site's minimum total positive feedback requirement for Express.
DetailLevel: ReturnAll, ReturnSummary. Also returned if DetailLevel is not provided on input. |
| User.SellerInfo .ExpressSellerRequirements .PositiveFeedbackPercent [ attribute minimum ] |
string | Conditionally | Used to determine whether the seller meets the minimum feedback requirements for Express. |
| User.SellerInfo.ExpressWallet | boolean | Always |
If true, the seller has an Express wallet, which is used to store information about multiple credit cards associated with the seller's account.
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 .LiveAuctionAuthorized |
boolean | Conditionally |
If true, the user is authorized to list lot items to the eBay Live Auctions site.
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.
Applicable values: • CustomCode (out) Reserved for internal or future use. • OptIn (out) Seller allows item cross-promotion. • OptOut (out) Seller does not allow item cross-promotion. 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: ItemReturnAttributes, ItemReturnDescription, 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: ItemReturnAttributes, ItemReturnDescription, ReturnAll. 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.
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 .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 have 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< | ||