eBay Shopping API901

GetUserProfile

This call retrieves public user information based on the user ID you specify. The response contains detailed information about a user.

Usage Details

You specify a user ID (user name) on input. This user ID is a unique value (although the user may choose to change his or her user ID).

The response contains a default set of data about a user, including the feedback score.

If you want more data than the default data, you can use one or more IncludeSelector fields. For example, specify FeedbackHistory in an IncludeSelector field if you want summary feedback data in a FeedbackHistor container. Although the feedback score is returned by default, the data in the FeedbackHistory container is returned only when you specify FeedbackHistory in an IncludeSelector field.

To use multiple IncludeSelector fields in a URL, separate them using a comma. An example is the following URL snippet:
IncludeSelector=FeedbackDetails,FeedbackHistory

For information about specifying affiliate parameters, see Affiliate URL Parameters and HTTP Header Values.



Back to top

Input

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.

<?xml version="1.0" encoding="utf-8"?>
<GetUserProfileRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <IncludeSelector> string </IncludeSelector>
  <UserID> string </UserID>
  <!-- Standard Input Fields -->
  <MessageID> string </MessageID>
</GetUserProfileRequest>
Argument Type Occurrence Meaning
Call-specific Input Fields [Jump to standard fields]
IncludeSelector string Optional Defines standard subsets of fields to return within the response.

If you don't specify this field, a default set of fields is returned. Click "Detail Controls" below and see "none" for the default fields. If you specify this field, then the set of fields returned includes the default fields. If you specify this field, the additional fields returned can affect the call's response time (performance), including in the case of feedback data.

Applicable values:

•   Details

Include most available fields (such as StoreURL) in the response (except fields that can affect the call's response time).

•   FeedbackDetails

Include a container for information about one feedback entry.

•   FeedbackHistory

Include a container for summary feedback data for a user.


Use a comma to specify multiple values. (In this case, the results are cumulative.) See "GetUserProfile Samples" for an example of how to use this field.

See "Detail Controls" for a complete list of fields that can be returned for each selector.

See:
    Detail Controls
    GetUserProfile Samples

UserID string Required Specifies the user whose data will returned by the call.
Standard Input Fields  
MessageID string Optional If you pass a value in MessageID in a request, we'll return the same value in CorrelationID in the response. If you're making a lot of calls, you can use this for tracking that a response is returned for every request and to match particular responses to particular requests. (In this case, specify a different value for each request.) You can specify any value that is useful to you.



Back to top

Output

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.

<?xml version="1.0" encoding="utf-8"?>
<GetUserProfileResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <FeedbackDetails> FeedbackDetailType
    <CommentingUser> string </CommentingUser>
    <CommentingUserScore> int </CommentingUserScore>
    <CommentReplaced> boolean </CommentReplaced>
    <CommentText> string </CommentText>
    <CommentTime> dateTime </CommentTime>
    <CommentType> CommentTypeCodeType </CommentType>
    <Countable> boolean </Countable>
    <FeedbackID> string </FeedbackID>
    <FeedbackResponse> string </FeedbackResponse>
    <FollowUp> string </FollowUp>
    <FollowUpReplaced> boolean </FollowUpReplaced>
    <ItemID> string </ItemID>
    <ItemPrice> AmountType (double) </ItemPrice>
    <ItemTitle> string </ItemTitle>
    <ResponseReplaced> boolean </ResponseReplaced>
    <Role> TradingRoleCodeType </Role>
    <TransactionID> string </TransactionID>
  </FeedbackDetails>
  <!-- ... more FeedbackDetails nodes allowed here ... -->
  <FeedbackHistory> FeedbackHistoryType
    <AverageRatingDetails> AverageRatingDetailsType
      <Rating> double </Rating>
      <RatingCount> long </RatingCount>
      <RatingDetail> FeedbackRatingDetailCodeType </RatingDetail>
    </AverageRatingDetails>
    <!-- ... more AverageRatingDetails nodes allowed here ... -->
    <BidRetractionFeedbackPeriods> FeedbackPeriodType
      <Count> long </Count>
      <PeriodInDays> int </PeriodInDays>
    </BidRetractionFeedbackPeriods>
    <!-- ... more BidRetractionFeedbackPeriods nodes allowed here ... -->
    <NegativeFeedbackPeriods> FeedbackPeriodType
      <Count> long </Count>
      <PeriodInDays> int </PeriodInDays>
    </NegativeFeedbackPeriods>
    <!-- ... more NegativeFeedbackPeriods nodes allowed here ... -->
    <NeutralCommentCountFromSuspendedUsers> long </NeutralCommentCountFromSuspendedUsers>
    <NeutralFeedbackPeriods> FeedbackPeriodType
      <Count> long </Count>
      <PeriodInDays> int </PeriodInDays>
    </NeutralFeedbackPeriods>
    <!-- ... more NeutralFeedbackPeriods nodes allowed here ... -->
    <PositiveFeedbackPeriods> FeedbackPeriodType
      <Count> long </Count>
      <PeriodInDays> int </PeriodInDays>
    </PositiveFeedbackPeriods>
    <!-- ... more PositiveFeedbackPeriods nodes allowed here ... -->
    <TotalFeedbackPeriods> FeedbackPeriodType
      <Count> long </Count>
      <PeriodInDays> int </PeriodInDays>
    </TotalFeedbackPeriods>
    <!-- ... more TotalFeedbackPeriods nodes allowed here ... -->
    <UniqueNegativeFeedbackCount> long </UniqueNegativeFeedbackCount>
    <UniqueNeutralFeedbackCount> long </UniqueNeutralFeedbackCount>
    <UniquePositiveFeedbackCount> long </UniquePositiveFeedbackCount>
  </FeedbackHistory>
  <User> SimpleUserType
    <AboutMeURL> anyURI </AboutMeURL>
    <FeedbackDetailsURL> anyURI </FeedbackDetailsURL>
    <FeedbackPrivate> boolean </FeedbackPrivate>
    <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
    <FeedbackScore> int </FeedbackScore>
    <MyWorldLargeImage> anyURI </MyWorldLargeImage>
    <MyWorldSmallImage> anyURI </MyWorldSmallImage>
    <MyWorldURL> anyURI </MyWorldURL>
    <NewUser> boolean </NewUser>
    <RegistrationDate> dateTime </RegistrationDate>
    <RegistrationSite> SiteCodeType </RegistrationSite>
    <ReviewsAndGuidesURL> anyURI </ReviewsAndGuidesURL>
    <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
    <SellerItemsURL> anyURI </SellerItemsURL>
    <SellerLevel> SellerLevelCodeType </SellerLevel>
    <Status> UserStatusCodeType </Status>
    <StoreName> string </StoreName>
    <StoreURL> anyURI </StoreURL>
    <TopRatedSeller> boolean </TopRatedSeller>
    <UserID> string </UserID>
  </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 ... -->
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetUserProfileResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
FeedbackDetails FeedbackDetailType Conditionally,
repeatable: [0..*]
The FeedbackDetails container has fields (ItemID, etc.) with information about one feedback entry. When you call GetUserProfile, the 5 (maximum) most recent feedback records are returned in FeedbackDetails containers.

IncludeSelector: FeedbackDetails
FeedbackDetails.CommentingUser string Conditionally eBay user ID for the user who left the feedback.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .CommentingUserScore
int Conditionally Feedback score of the user in CommentingUser.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .CommentReplaced
boolean Conditionally Indicates whether eBay replaced the comment with a message that the comment was removed.

IncludeSelector: FeedbackDetails
FeedbackDetails.CommentText string Conditionally Text message left by the user in CommentingUser. Used to provide a more in-depth description of the user's opinion of the transaction. Returned as text in the language that the comment was originally left in.

IncludeSelector: FeedbackDetails
FeedbackDetails.CommentTime dateTime Conditionally Date and time (in GMT) that the feedback was submitted to eBay.

IncludeSelector: FeedbackDetails
FeedbackDetails.CommentType CommentTypeCodeType Conditionally Type of feedback. Can be Positive, Neutral, Negative, or Withdrawn (see the CommentTypeCodeType code list). Positive feedbacks add to the user's total feedback score, negative feedbacks lower the score, and neutral feedbacks do not affect the score (but do affect the overall picture of the user's online reputation).

Applicable values:

CustomCode
(out) Reserved for internal or future use.
IndependentlyWithdrawn
(out) Applies to the eBay Motors site only. Feedback is withdrawn based on the decision of a third party.
Negative
(out) Negative feedback. Decreases total feedback score.
Neutral
(out) Neutral feedback. No effect on total feedback score.
Positive
(out) Positive feedback. Increases total feedback score.
Withdrawn
(out) Withdrawn feedback. Removes the effect of the original feedback on total feedback score. Comments from withdrawn feedback are still visible.



IncludeSelector: FeedbackDetails
FeedbackDetails.Countable boolean Conditionally Specifies if a user's feedback score is or is not countable. This field is returned only when a user's feedback score is not countable (value is false).

IncludeSelector: FeedbackDetails
FeedbackDetails.FeedbackID string Conditionally Unique identifier for the feedback entry.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .FeedbackResponse
string Conditionally Textual comment that the user targeted by feedback may leave in response or rebuttal to the feedback.

IncludeSelector: FeedbackDetails
FeedbackDetails.FollowUp string Conditionally Explanation a user can give to a response.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .FollowUpReplaced
boolean Conditionally Indicates whether eBay replaced the follow-up with a message that the follow-up was removed.

IncludeSelector: FeedbackDetails
FeedbackDetails.ItemID string Conditionally The ID that uniquely identifies the item listing.

IncludeSelector: FeedbackDetails
FeedbackDetails.ItemPrice AmountType (double) Conditionally The final price for the item, associated with the currency identified by the currencyId attribute of the AmountType. Not returned if a listing ended more than 90 days ago.

IncludeSelector: FeedbackDetails
FeedbackDetails.ItemTitle string Conditionally Name of the listing for which feedback was provided. Returned as CDATA. Not returned if a listing ended more than 90 days ago.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .ResponseReplaced
boolean Conditionally Indicates whether eBay replaced the response with a message that the response was removed.

IncludeSelector: FeedbackDetails
FeedbackDetails.Role TradingRoleCodeType Conditionally Indicates whether the user who was the feedback recipient was a Buyer or the Seller for that transaction.

Applicable values:

Buyer
(out) Acting as buyer.
CustomCode
(out) Reserved for future use
Seller
(out) Acting as seller.



IncludeSelector: FeedbackDetails
FeedbackDetails.TransactionID string Conditionally Unique identifier for the transaction about which this feedback entry was left. This field is not returned in the case of TransactionIDs from Chinese auction listings, because a value of zero is used for TransactionIDs in such cases.

IncludeSelector: FeedbackDetails
FeedbackHistory FeedbackHistoryType Always Summary feedback data for a user. Contains counts of positive, neutral, and negative feedback for predefined time periods.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .AverageRatingDetails
AverageRatingDetailsType Conditionally,
repeatable: [0..*]
Container for information about detailed seller ratings (DSRs) that buyers have left for a seller. Sellers have access to the number of ratings they've received, as well as to the averages of DSRs they've received in each DSR area (i.e., to the average of ratings in the item-description area, etc.).

IncludeSelector: FeedbackHistory
FeedbackHistory
  .AverageRatingDetails.Rating
double Conditionally An average detailed seller rating applying to the area in the corresponding RatingDetail field.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .AverageRatingDetails
  .RatingCount
long Conditionally The number of detailed seller ratings in the area in the corresponding RatingDetail field.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .AverageRatingDetails
  .RatingDetail
FeedbackRatingDetailCodeType Conditionally The area of a specific average detailed seller rating. Users retrieve detailed ratings as averages of the ratings left by buyers. When buyers leave an overall Feedback rating (positive, neutral, or negative) for a seller, they also can leave ratings in four areas: item as described, communication, shipping time, and charges for shipping and handling.

Applicable values:

Communication
(out) Detailed seller rating in the area of "communication."
CustomCode
(out) Reserved for internal or future use.
ItemAsDescribed
(out) Detailed seller rating in the area of "item as described."
ShippingAndHandlingCharges
(out) Detailed seller rating in the area of "charges for shipping and handling." Inapplicable to motor vehicle items.
ShippingTime
(out) Detailed seller rating in the area of "shipping time." Inapplicable to motor vehicle items.



IncludeSelector: FeedbackHistory
FeedbackHistory
  .BidRetractionFeedbackPeriods
FeedbackPeriodType Always,
repeatable: [1..*]
Bid retractions count, for multiple predefined time periods preceding the call.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .BidRetractionFeedbackPeriods
  .Count
long Always Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .BidRetractionFeedbackPeriods
  .PeriodInDays
int Always Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NegativeFeedbackPeriods
FeedbackPeriodType Always,
repeatable: [1..*]
Negative feedback entries count, for multiple predefined time periods preceding the call.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NegativeFeedbackPeriods.Count
long Always Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NegativeFeedbackPeriods
  .PeriodInDays
int Always Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NeutralCommentCountFromSuspendedUsers
long Conditionally Number of neutral comments received from suspended users.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NeutralFeedbackPeriods
FeedbackPeriodType Always,
repeatable: [1..*]
Neutral feedback entries count, for multiple predefined time periods preceding the call.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NeutralFeedbackPeriods.Count
long Always Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NeutralFeedbackPeriods
  .PeriodInDays
int Always Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .PositiveFeedbackPeriods
FeedbackPeriodType Always,
repeatable: [1..*]
Positive feedback entries count, for multiple predefined time periods preceding the call.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .PositiveFeedbackPeriods.Count
long Always Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .PositiveFeedbackPeriods
  .PeriodInDays
int Always Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .TotalFeedbackPeriods
FeedbackPeriodType Always,
repeatable: [1..*]
Total feedback score, for multiple predefined time periods preceding the call.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .TotalFeedbackPeriods.Count
long Always Count of the feedbacks received by the user for the time period prior to the call indicated in PeriodInDays.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .TotalFeedbackPeriods
  .PeriodInDays
int Always Indicates the time period for the feedback count. Returns a value indicating the number of days prior to the call for which feedbacks of the particular type are counted.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .UniqueNegativeFeedbackCount
long Always Total number of negative Feedback comments received by the user, including weekly repeats.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .UniqueNeutralFeedbackCount
long Conditionally Total number of neutral Feedback comments received by the user, including weekly repeats.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .UniquePositiveFeedbackCount
long Always Total number of positive Feedback comments received by the user, including weekly repeats.

IncludeSelector: FeedbackHistory
User SimpleUserType Always Contains the returned user data for the specified eBay user.

IncludeSelector: none (not controlled by IncludeSelector)
User.AboutMeURL anyURI Always A link to the user's AboutMe page.

IncludeSelector: none (not controlled by IncludeSelector)
User.FeedbackDetailsURL anyURI Always The URL of feedback details.

IncludeSelector: none (not controlled by IncludeSelector)
User.FeedbackPrivate boolean Always 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. If a bidder's user information is made anonymous, the value -99 is returned.

IncludeSelector: none (not controlled by IncludeSelector)
User.FeedbackRatingStar FeedbackRatingStarCodeType Always Visual indicator of user's feedback score.

Applicable values:

Blue
(out) Blue Star, feedback score 50-99.
CustomCode
(out) Placeholder value. See token.
Green
(out) Green Star, feedback score 5,000-9,999.
GreenShooting
(out) Green Shooting Star, feedback score 500,000-900,000.
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.



IncludeSelector: none (not controlled by IncludeSelector)
User.FeedbackScore int Always The aggregate feedback score of 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 aggregate feedback score of a user represents 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, then FeedbackScore is not returned and FeedbackPrivate is returned with a value of true.

If a bidder's user information is made anonymous, the value -99 is returned.

IncludeSelector: none (not controlled by IncludeSelector)
User.MyWorldLargeImage anyURI Conditionally Location of a user's image on the MyWorld page (large version).

IncludeSelector: Details
User.MyWorldSmallImage anyURI Conditionally Location of a user's image on the MyWorld page (small version).

IncludeSelector: Details
User.MyWorldURL anyURI Conditionally A link to the URL of the user's MyWorld page.

IncludeSelector: Details
User.NewUser boolean Always 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.

IncludeSelector: none (not controlled by IncludeSelector)
User.RegistrationDate dateTime Always The date the specified user originally registered with eBay. If a bidder's user information is made anonymous, the value -99 is returned.

IncludeSelector: none (not controlled by IncludeSelector)
User.RegistrationSite SiteCodeType Always The eBay site with which the user is registered. If a bidder's user information is made anonymous, the value -99 is returned.

Applicable values: See RegistrationSite.

IncludeSelector: none (not controlled by IncludeSelector)
User.ReviewsAndGuidesURL anyURI Conditionally The URL of reviews and guides.

IncludeSelector: Details
User.SellerBusinessType SellerBusinessCodeType Always Type of seller account.

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.



IncludeSelector: none (not controlled by IncludeSelector)
User.SellerItemsURL anyURI Always URL for seller's other items.

IncludeSelector: none (not controlled by IncludeSelector)
User.SellerLevel SellerLevelCodeType Conditionally The user's eBay PowerSeller tier. No longer returned for the US, DE/AT/CH, and UK/IE sites. Note that SellerLevel may be suppressed for other sites, as well.

Applicable values:

Bronze
(out) Bronze
CustomCode
(out) Reserved for internal or future use
Diamond
(out) Diamond
Gold
(out) Gold
None
(out) None
Platinum
(out) Platinum
Silver
(out) Silver
Titanium
(out) Titanium



IncludeSelector: none (not controlled by IncludeSelector)
User.Status UserStatusCodeType Always The registration-related status of the user.

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 is pending a verification of credit card information
CreditCardVerifyHalfOptIn
(out) User has completed the registration for Half.com and opted to automatically also be registered with eBay, but the verification of credit card information is still pending
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
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
UnconfirmedExpress
(out) Half.com User; user has completed the registration for Half.com and opted to automatically also be registered with eBay, but the registration confirmation is still pending
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



IncludeSelector: none (not controlled by IncludeSelector)
User.StoreName string Conditionally The name of the seller's eBay Store.

IncludeSelector: Details
User.StoreURL anyURI Conditionally The URL of the seller's eBay Store page.

IncludeSelector: Details
User.TopRatedSeller boolean Conditionally Coming soon. Returned when seller is certified as a top-rated seller, and is qualified for benefits such as final value fee discount and increased visibility in fixed-price searches.

IncludeSelector: none (not controlled by IncludeSelector)
User.UserID string Always The user's unique eBay user ID.

When reporting UserIDs in bidding situations (such was when listing the high bidder in an auction), eBay replaces the UserID value with an anonymous bidder name value, such as "a***o".

IncludeSelector: none (not controlled by IncludeSelector)
Standard Output Fields  
Ack AckCodeType Always Indicates whether the call was successfully processed by eBay.

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 particular 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 If you pass a value in MessageID 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. Only returned if MessageID was used.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors or warnings (if any) that were raised when eBay processed the request.

Application-level errors occur due to problems with business-level data on the client side or on the eBay server side. For example, an error would occur if the request contains an invalid combination of fields, or it is missing a required field, or the value of the field is not recognized. An error could also occur if eBay encountered a problem in our internal business logic while processing the request.

Only returned if there were warnings or errors.
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.

See Errors by Number.

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 Errors by Number.

Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. You can usually predict where these will occur by looking at the "replaceable_value" indicators in our Errors by Number page.

See Errors by Number.

Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error. You can usually predict where these will occur by looking at the "replaceable_value" indicators in our Errors by Number page.
Errors.ErrorParameters.Value string Conditionally The value of the variable.
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.

See Errors by Number.

Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error caused the request to fail.

If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re-send the request to eBay.

If the source of the problem is on eBay's side, you 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.

When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.

Applicable values:

CustomCode
(out) Reserved for internal or future use
Error
(out) The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.
Warning
(out) The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.

See:
    Errors by Number
    Checklist for Going Live for more information see the eBay Features Guide.

Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.

See Errors by Number.

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 the "dateTime" type for information about this time format and converting to and from the GMT time zone.
Version string Always The release version that eBay used to process the request.

Note: This is usually the latest release version, as specified in the release notes. (eBay releases the API to international sites about a week after we release it to the US site.)

If a field in the response returns the token "CustomCode", it usually means that the field is a code type (a token or enumeration), and that in your request URL (or HTTP header) you specified a version that is older than the version in which the token was added to the call.

See Schema Versioning Strategy.



Back to top

Detail Controls


IncludeSelector

The IncludeSelector input field gives you control over which call-specific output fields may be returned from your queries. IncludeSelector accepts a set of preset values, each of which permits the return of a different set of fields. (All standard output fields are returned regardless of IncludeSelector.)

The table below details the fields that each IncludeSelector value controls. In addition, the table includes a none column that shows the fields that are not controlled by IncludeSelector settings. Note that some fields are returned only when certain conditions are met; see the associated field documentation for a clarification of these conditions.

YThe field is always returned.
(Y)The field is conditionally returned. See the field documentation for clarification of conditions.

Output Field none Details FeedbackDetails FeedbackHistory
FeedbackDetails--(Y)-
FeedbackDetails.CommentingUser--(Y)-
FeedbackDetails.CommentingUserScore--(Y)-
FeedbackDetails.CommentReplaced--(Y)-
FeedbackDetails.CommentText--(Y)-
FeedbackDetails.CommentTime--(Y)-
FeedbackDetails.CommentType--(Y)-
FeedbackDetails.Countable--(Y)-
FeedbackDetails.FeedbackID--(Y)-
FeedbackDetails.FeedbackResponse--(Y)-
FeedbackDetails.FollowUp--(Y)-
FeedbackDetails.FollowUpReplaced--(Y)-
FeedbackDetails.ItemID--(Y)-
FeedbackDetails.ItemPrice--(Y)-
FeedbackDetails.ItemTitle--(Y)-
FeedbackDetails.ResponseReplaced--(Y)-
FeedbackDetails.Role--(Y)-
FeedbackDetails.TransactionID--(Y)-
FeedbackHistory---Y
FeedbackHistory.AverageRatingDetails---(Y)
FeedbackHistory.AverageRatingDetails.Rating---(Y)
FeedbackHistory.AverageRatingDetails.RatingCount---(Y)
FeedbackHistory.AverageRatingDetails.RatingDetail---(Y)
FeedbackHistory.BidRetractionFeedbackPeriods---Y
FeedbackHistory.BidRetractionFeedbackPeriods.Count---Y
FeedbackHistory.BidRetractionFeedbackPeriods.PeriodInDays---Y
FeedbackHistory.NegativeFeedbackPeriods---Y
FeedbackHistory.NegativeFeedbackPeriods.Count---Y
FeedbackHistory.NegativeFeedbackPeriods.PeriodInDays---Y
FeedbackHistory.NeutralCommentCountFromSuspendedUsers---(Y)
FeedbackHistory.NeutralFeedbackPeriods---Y
FeedbackHistory.NeutralFeedbackPeriods.Count---Y
FeedbackHistory.NeutralFeedbackPeriods.PeriodInDays---Y
FeedbackHistory.PositiveFeedbackPeriods---Y
FeedbackHistory.PositiveFeedbackPeriods.Count---Y
FeedbackHistory.PositiveFeedbackPeriods.PeriodInDays---Y
FeedbackHistory.TotalFeedbackPeriods---Y
FeedbackHistory.TotalFeedbackPeriods.Count---Y
FeedbackHistory.TotalFeedbackPeriods.PeriodInDays---Y
FeedbackHistory.UniqueNegativeFeedbackCount---Y
FeedbackHistory.UniqueNeutralFeedbackCount---(Y)
FeedbackHistory.UniquePositiveFeedbackCount---Y
UserY---
User.AboutMeURLY---
User.FeedbackDetailsURLY---
User.FeedbackPrivateY---
User.FeedbackRatingStarY---
User.FeedbackScoreY---
User.MyWorldLargeImage-(Y)--
User.MyWorldSmallImage-(Y)--
User.MyWorldURL-(Y)--
User.NewUserY---
User.RegistrationDateY---
User.RegistrationSiteY---
User.ReviewsAndGuidesURL-(Y)--
User.SellerBusinessTypeY---
User.SellerItemsURLY---
User.SellerLevel(Y)---
User.StatusY---
User.StoreName-(Y)--
User.StoreURL-(Y)--
User.TopRatedSeller(Y)(Y)(Y)(Y)
User.UserIDY---


DetailLevel

This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.

Back to top

Samples

New to making API calls? Please see Making an API Call.

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.

Available samples:

Sample: Basic Call

Retrieves the default set of information pertaining to a user.

Input

This example specifies a UserID to obtain the default set of information about a user.

URL format (HTTP GET). See also the non-wrapped version of this URL. For results in a format other than XML, 
specify a different value for responseencoding.
http://open.api.ebay.com/shopping?
   callname=GetUserProfile&
   responseencoding=XML&
   appid=YourAppIDHere&
   siteid=0&
   version=525&
   UserID=hypothetical-user

   Here is the same input in XML format (HTTP POST). Note that this does not include standard values.

XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<GetUserProfileRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <UserID>hypothetical-user</UserID>
</GetUserProfileRequest>

Output

The output from this sample shows the default set of user information returned by the call.

XML format. Also available is the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<GetUserProfileResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2007-07-24T21:05:05.781Z</Timestamp> 
  <Ack>Success</Ack> 
  <Build>e525_core_APILW_5028523_R1</Build> 
  <Version>525</Version> 
  <User>
    <FeedbackScore>1047</FeedbackScore> 
    <FeedbackPrivate>false</FeedbackPrivate> 
    <FeedbackRatingStar>Red</FeedbackRatingStar> 
    <NewUser>false</NewUser> 
    <RegistrationDate>2005-07-22T20:50:00.000Z</RegistrationDate> 
    <RegistrationSite>US</RegistrationSite> 
    <Status>Confirmed</Status> 
    <SellerBusinessType>Undefined</SellerBusinessType> 
    <UserID>hypothetical-user</UserID> 
    <SellerItemsURL>http://search.ebay.com/_W0LMsarsrhypothetical-userQQhtZ-1</SellerItemsURL> 
    <AboutMeURL>http://members.ebay.com/aboutme/hypothetical-user</AboutMeURL> 
    <FeedbackDetailsURL>http://feedback.ebay.com/ws/eBayISAPI.dll?ViewFeedback&userid=hypothetical-user&ssPageName=STRG:ME:UFS</FeedbackDetailsURL> 
  </User>
</GetUserProfileResponse>

Back to list of samples

Sample: Returning Detailed User Information

Setting the Details IncludeSelector retrieves detailed user information, including the StoreURL field and other data.

Input

This sample uses Details as an IncludeSelector. If you use Details, the StoreURL field and other information is returned in addition to the default set of information.

URL format (HTTP GET). See also the non-wrapped version of this URL. For results in a format other than XML, 
specify a different value for responseencoding.
http://open.api.ebay.com/shopping?
   callname=GetUserProfile&
   responseencoding=XML&
   appid=YourAppIDHere&
   siteid=0&
   version=525&
   UserID=hypothetical-user&
   IncludeSelector=Details

   Here is the same input in XML format (HTTP POST). Note that this does not include standard values.

XML format (HTTP POST). Also available are the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<GetUserProfileRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <UserID>hypothetical-user</UserID>
  <IncludeSelector>Details</IncludeSelector>
</GetUserProfileRequest>

Output

The output from this sample shows the information that you can obtain by using the Details IncludeSelector.

XML format. Also available is the .txt version of this XML and the SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<GetUserProfileResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2007-07-24T21:05:05.781Z</Timestamp> 
  <Ack>Success</Ack> 
  <Build>e525_core_APILW_5028523_R1</Build> 
  <Version>525</Version> 
  <User>
    <FeedbackScore>1047</FeedbackScore> 
    <FeedbackPrivate>false</FeedbackPrivate> 
    <FeedbackRatingStar>Red</FeedbackRatingStar> 
    <NewUser>false</NewUser> 
    <RegistrationDate>2005-07-22T20:50:00.000Z</RegistrationDate> 
    <RegistrationSite>US</RegistrationSite> 
    <Status>Confirmed</Status> 
    <SellerBusinessType>Undefined</SellerBusinessType> 
    <UserID>hypothetical-user</UserID> 
    <StoreURL>http://stores.ebay.com/Hypothetical+Store</StoreURL> 
    <StoreName>Hypothetical Store</StoreName> 
    <SellerItemsURL>http://search.ebay.com/_W0LMsarsrhypothetical-userQQhtZ-1</SellerItemsURL> 
    <AboutMeURL>http://members.ebay.com/aboutme/hypothetical-user</AboutMeURL> 
    <MyWorldURL>http://myworld.ebay.com/hypothetical-user</MyWorldURL> 
    <MyWorldSmallImage>http://i2.ebayimg.ebay.com/01/u/000/00/23/9bc1_0.JPG?set_id=23</MyWorldSmallImage> 
    <MyWorldLargeImage>http://i2.ebayimg.ebay.com/01/u/000/77/23/9bc1_7.JPG?set_id=23</MyWorldLargeImage> 
    <ReviewsAndGuideURL>http://search.reviews.us.ebay.com/members/hypothetical-user</ReviewsAndGuideURL> 
    <FeedbackDetailsURL>http://feedback.ebay.com/ws/eBayISAPI.dll?ViewFeedback&userid=hypothetical-user&ssPageName=STRG:ME:UFS</FeedbackDetailsURL> 
  </User>
</GetUserProfileResponse>

Back to list of samples



Back to top

Change History

Version Description
897
2014-10-21
  • SiteCodeType (modified): 'Russia' added as enumeration value to support selling on the new Russia site.
629
2009-08-05
  • SimpleUserType.TopRatedSeller (added): Returned when seller is rated a Top-Rated Seller.
623
2009-06-24
  • SellerLevel.Diamond (added): New top-tier seller level.
  • SimpleUserType.PositiveFeedbackPercent (added): The percentage value of a user's positive feedback. This field was not added to the schema, it just didn't support this call before this release.
  • FeedbackRatingStarCodeType.RedShooting (modified): Modified to cover 100,000 to 499,999, instead of 'over 100,000'.
  • FeedbackRatingStarCodeType.GreenShooting,FeedbackRatingStarCodeType.SilverShooting (added): Added GreenShooting for feedback scores from 500,000 to 999,999; and SilverShooting Star for feedback scores that are 1,000,000 and above.
549
2008-01-24
  • User.UniqueNeutralFeedbackCount (added): A new element has been added to return total count of neutral Feedback entries received by the user, including weekly repeats.
525
2007-08-08
  • (added) New call.

Back to top

User-Contributed Notes