eBay Shopping APIVersion 1119

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.



Input

See also Samples.

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).

<?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 This inclusive filter is included to control the amount and type of user data that is retrieved.

If you don't include this field, a default set of fields is returned. Click the Detail Controls link below and see the none column in that table to see the fields that are returned when no IncludeSelector value is used.

To retrieve more data than just the default fields, including detailed Feedback data, the IncludeSelector field can be included, and one to three values can be specified in this field. If multiple values are specified, each value is separated with a comma (,). The enumeration values that can be specified in the IncludeSelector field are discussed below.

Applicable values:

•   Details

Including this value as an IncludeSelector value increases the number of fields that are returned under the User container in the response, including fields related to the user's profile page and eBay Store (if applicable). Compare the none and Details columns in the the Detail Controls table to see which additional fields are returned when the Details value is used in the IncludeSelector field.

•   FeedbackDetails

If this value is included as an IncludeSelector value, the user's last five Feedback entries (as buyer or seller) are returned in the response. A separate FeedbackDetails container is returned for each Feedback entry, with detailed information about that Feedback entry.

•   FeedbackHistory

If this value is included as an IncludeSelector value, a FeedbackHistory container is returned, and this container consists of detailed Feedback data on the eBay user. See FeedbackHistory container (and its child containers) for more information on the type of data that is returned.


See Detail Controls.

UserID string Required An eBay user ID is input into this field to retrieve information about that eBay user.
Standard Input Fields  
MessageID string Optional If you pass a value into the MessageID field in a request, the same value is returned in CorrelationID field 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.



Output

See also Samples.

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).

<?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>
    <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
    <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..5]
Each FeedbackDetails container consists of detailed information about one Feedback entry for the specified eBay user. For FeedbackDetails containers to be returned, the user must include the IncludeSelector field in the request and set its value to FeedbackDetails.

The specified eBay user's last five Feedback entries (as buyer or seller) are returned in the response. It is possible that less than five Feedback entries will be returned if the eBay user does not have five recent Feedback entries.

IncludeSelector: FeedbackDetails
FeedbackDetails.CommentingUser string Conditionally The eBay User ID of the user who left the Feedback entry.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .CommentingUserScore
int Conditionally This integer value is the Feedback score of the user indicated in the CommentingUser field.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .CommentReplaced
boolean Conditionally This boolean value indicates whether or not eBay replaced the Feedback comment with a message that the Feedback comment was removed.

IncludeSelector: FeedbackDetails
FeedbackDetails.CommentText string Conditionally This free-form text is the actual comment that the commenting user left for their order partner. The Feedback comment's purpose is to explain, clarify, or justify the Feedback rating specified in the CommentType field.

The comment is returned as text in the language that the comment was originally left in. This comment will still be displayed even if a submitted Feedback entry is withdrawn.
Max length: 125 (but varies by eBay marketplace).

IncludeSelector: FeedbackDetails
FeedbackDetails.CommentTime dateTime Conditionally This timestamp (in GMT) indicates the date/time that the Feedback entry was submitted to eBay.

IncludeSelector: FeedbackDetails
FeedbackDetails.CommentType CommentTypeCodeType Conditionally This value indicates the rating of the Feedback left by the user identified in the CommentingUser field.

A Positive rating increases a user's Feedback score by a value of 1, a Negative rating decreases a user's Feedback score by a value of 1, and a Neutral rating does not affect a user's Feedback score.

Sellers cannot leave Neutral or Negative ratings for buyers.

Applicable values: See CommentType.
Code so that your app gracefully handles any future changes to this list.

IncludeSelector: FeedbackDetails
FeedbackDetails.Countable boolean Conditionally This boolean value indicates whether or not the Feedback entry will affect the user's Feedback score.

IncludeSelector: FeedbackDetails
FeedbackDetails.FeedbackID string Conditionally Unique identifier for the Feedback entry. This identifier is auto-generated by eBay at the time of Feedback submittal.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .FeedbackRatingStar
FeedbackRatingStarCodeType Conditionally This enumeration value provides the Feedback Rating Star of the user indicated in the CommentingUser field. See FeedbackRatingStarCodeType for the full list of Feedback Rating Stars, and the Feedback score ranges associated with those stars.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .FeedbackResponse
string Conditionally This free-form text is the comment that the recipient of the Feedback may leave in response or rebuttal to the Feedback. Responses to Feedback comments cannot be submitted or edited via the API. This field is returned as an empty tag if no response to the Feedback entry has been submitted.
Max length: 125 (but varies by eBay marketplace).

IncludeSelector: FeedbackDetails
FeedbackDetails.FollowUp string Conditionally This free-form text is the explanation that a user can give to a submitted Feedback response. Follow-ups to Feedback comments cannot be submitted or edited via the API. This field is returned as an empty tag if no Follow-Up to the Feedback response has been submitted.
Max length: 125 (but varies by eBay marketplace).

IncludeSelector: FeedbackDetails
FeedbackDetails
  .FollowUpReplaced
boolean Conditionally This boolean value indicates whether or not eBay replaced the follow-up to the Feedback comment with a message that the follow-up to the Feedback comment was removed.

IncludeSelector: FeedbackDetails
FeedbackDetails.ItemID string Conditionally The unique identifier of the listing associated with the Feedback entry. For Feedback entries that were left for the buyer by the seller, an ItemID value will not be returned to a user that was not involved in the transaction as either the buyer or seller.

IncludeSelector: FeedbackDetails
FeedbackDetails.ItemPrice AmountType (double) Conditionally The purchase price for the order line item associated with the Feedback entry. This field may not be returned for a listing that ended more than 90 days ago. For Feedback entries that were left for the buyer by the seller, an ItemPrice value will not be returned to a user that was not involved in the transaction as either the buyer or seller.

IncludeSelector: FeedbackDetails
FeedbackDetails.ItemTitle string Conditionally The title of the listing for which Feedback was provided. This field may not be returned for a listing that ended more than 90 days ago. For Feedback entries that were left for the buyer by the seller, an ItemTitle value will not be returned to a user that was not involved in the transaction as either the buyer or seller.
Max length: 80.

IncludeSelector: FeedbackDetails
FeedbackDetails
  .ResponseReplaced
boolean Conditionally This boolean value indicates whether or not eBay replaced the response to the Feedback comment with a message that the response to the Feedback comment was removed.

IncludeSelector: FeedbackDetails
FeedbackDetails.Role TradingRoleCodeType Conditionally This enumeration value indicates whether the specified eBay user (and recipient of the Feedback entry) was the buyer or the seller for the corresponding order line item.

Applicable values:

Buyer
(out) This enumeration value indicates the eBay user was the buyer in the correponding transaction.
CustomCode
(out) Reserved for future use.
Seller
(out) This enumeration value indicates the eBay user was the seller in the correponding transaction.

Code so that your app gracefully handles any future changes to this list.

IncludeSelector: FeedbackDetails
FeedbackDetails.TransactionID string Conditionally Unique identifier for the order line item for which the Feedback entry was left. The value of this field is always '0' for auction listings since auctions only have one winner/buyer, and only the ItemID value is needed to identify the transaction. For Feedback entries that were left for the buyer by the seller, a TransactionID value will not be returned to a user that was not involved in the transaction as either the buyer or seller.

IncludeSelector: FeedbackDetails
FeedbackHistory FeedbackHistoryType Conditionally This container consists of numerous statistical data about the specified eBay user's Feedback history, including counts of Positive, Neutral, and Negative Feedback entries for predefined time periods (last week, last month, last 6 months, and last year). For the FeedbackHistory container to be returned, the user must include the IncludeSelector field in the request and set its value to FeedbackHistory.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .AverageRatingDetails
AverageRatingDetailsType Conditionally,
repeatable: [0..*]
Each returned AverageRatingDetails container shows the seller's current rating for the Detailed Seller Rating type (specified in the RatingDetail field), as well as the total count that this seller has been rated for this particular Detailed Seller Rating type.

This container is only returned if applicable. If the specified eBay user only buys on eBay, these containers will not get returned, and Detailed Seller Ratings are not available or applicable for all sellers.

IncludeSelector: FeedbackHistory

See Detailed seller ratings (US help page).

FeedbackHistory
  .AverageRatingDetails.Rating
double Conditionally This value is the seller's average rating (given by buyers) for the DSR area noted in the corresponding RatingDetail field.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .AverageRatingDetails
  .RatingCount
long Conditionally This value is the total count of buyer ratings given for the DSR area noted in the corresponding RatingDetail field.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .AverageRatingDetails
  .RatingDetail
FeedbackRatingDetailCodeType Conditionally The value shown in this field indicates the Detailed Seller Rating area. The corresponding Rating value is the average rating that the seller has received for this DSR area, and the RatingCount value is the total number of buyer ratings that the seller has received in this DSR area. 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.

Code so that your app gracefully handles any future changes to this list.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .BidRetractionFeedbackPeriods
FeedbackPeriodType Conditionally,
repeatable: [0..*]
A BidRetractionFeedbackPeriods container shows the cumulative number of Withdrawn Feedback entries (shown in Count field) for the specified time period (shown in PeriodInDays field).

IncludeSelector: FeedbackHistory
FeedbackHistory
  .BidRetractionFeedbackPeriods
  .Count
long Always This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .BidRetractionFeedbackPeriods
  .PeriodInDays
int Always This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 7 days, 30 days, 180 days, and 365 days.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NegativeFeedbackPeriods
FeedbackPeriodType Conditionally,
repeatable: [0..*]
A NegativeFeedbackPeriods container shows the cumulative number of Negative Feedback entries (shown in Count field) for the specified time period (shown in PeriodInDays field).

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NegativeFeedbackPeriods.Count
long Always This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NegativeFeedbackPeriods
  .PeriodInDays
int Always This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 7 days, 30 days, 180 days, and 365 days.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NeutralCommentCountFromSuspendedUsers
long Conditionally Number of Neutral comments received from suspended users. This field is only returned if applicable.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NeutralFeedbackPeriods
FeedbackPeriodType Conditionally,
repeatable: [0..*]
A NeutralFeedbackPeriods container shows the cumulative number of Neutral Feedback entries (shown in Count field) for the specified time period (shown in PeriodInDays field).

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NeutralFeedbackPeriods.Count
long Always This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .NeutralFeedbackPeriods
  .PeriodInDays
int Always This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 7 days, 30 days, 180 days, and 365 days.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .PositiveFeedbackPeriods
FeedbackPeriodType Conditionally,
repeatable: [0..*]
A PositiveFeedbackPeriods container shows the cumulative number of Positive Feedback entries (shown in Count field) for the specified time period (shown in PeriodInDays field).

IncludeSelector: FeedbackHistory
FeedbackHistory
  .PositiveFeedbackPeriods.Count
long Always This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .PositiveFeedbackPeriods
  .PeriodInDays
int Always This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 7 days, 30 days, 180 days, and 365 days.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .TotalFeedbackPeriods
FeedbackPeriodType Conditionally,
repeatable: [0..*]
A TotalFeedbackPeriods container shows the cumulative number of all Feedback entries (shown in Count field) for the specified time period (shown in PeriodInDays field).

IncludeSelector: FeedbackHistory
FeedbackHistory
  .TotalFeedbackPeriods.Count
long Always This integer value indicates the total number of Feedback entries that occurred within the time period specified in the PeriodInDays field.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .TotalFeedbackPeriods
  .PeriodInDays
int Always This integer value indicates the total number of days in the time period for the Feedback count. Typically, the returned time periods are 7 days, 30 days, 180 days, and 365 days.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .UniqueNegativeFeedbackCount
long Conditionally This integer value indicates the total number of Negative Feedback entries that a seller has received from unique buyers, ever since the eBay user first registered on eBay. This field is not applicable to users who only buy on eBay since eBay buyers cannot receive Negative feedback from their order partners.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .UniqueNeutralFeedbackCount
long Conditionally This integer value indicates the total number of Neutral Feedback entries that a seller has received from unique buyers, ever since the eBay user first registered on eBay. This field is not applicable to users who only buy on eBay since eBay buyers cannot receive Neutral feedback from their order partners. This field is only returned if applicable.

IncludeSelector: FeedbackHistory
FeedbackHistory
  .UniquePositiveFeedbackCount
long Conditionally This integer value indicates the total number of Positive Feedback entries that the specified eBay user has received (as a buyer or seller) from unique users, ever since the eBay user first registered on eBay.

IncludeSelector: FeedbackHistory
User SimpleUserType Always This container consists of various details about the eBay user, including Feedback rating, Seller Level, link to profile page, and other information. This container is always returned, but more fields will be returned under this container if the user includes the IncludeSelector field in the request and sets its value to Details.

IncludeSelector: none (not controlled by IncludeSelector)
User.AboutMeURL anyURI Always The URL to the eBay About Me page. Only returned if one exists for the eBay user.

IncludeSelector: none (not controlled by IncludeSelector)
User.FeedbackDetailsURL anyURI Always The URL to the eBay user's Feedback Profile page, which has full details of the eBay user's Feedback History, including Feedback Ratings, Feedback Comments, and Detailed Seller Ratings.

IncludeSelector: none (not controlled by IncludeSelector)
User.FeedbackPrivate boolean Always This boolean value indicates whether or not the eBay user has chosen to make their Feedback Profile private in My eBay. A private Feedback Profile only means that individual Feedback comments are hidden, but other Feedback statistics will still be displayed, including the total Feedback score and the Positive Feedback Percentage.

Sellers on eBay marketplaces do not have the option of making their Feedback Profile private, and they will be blocked from listing if they try to list items with a private Feedback Profile.

IncludeSelector: none (not controlled by IncludeSelector)
User.FeedbackRatingStar FeedbackRatingStarCodeType Always This enumeration value indicates the eBay user's Feedback Rating Star. A different colored star is associated with each Feedback Score range. For more details on the Feedback Score ranges (and colored stars associated with each range), see FeedbackRatingStarCodeType.

Applicable values: See FeedbackRatingStar.
Code so that your app gracefully handles any future changes to this list.

IncludeSelector: none (not controlled by IncludeSelector)
User.FeedbackScore int Always The aggregate Feedback score of an eBay user. A user's Feedback score is determined by the total number of Positive Feedback ratings minus the total number of Negative Feedback ratings the user has received. Any Neutral Feedback ratings do not affect the Feedback Score.

A user's Feedback Score is a quantitative expression of the desirability of dealing with that user as a buyer or a seller. A buyer can leave Positive, Neutral, or Negative Feedback for the seller, but a seller can only leave Positive Feedback for the buyer.

IncludeSelector: none (not controlled by IncludeSelector)
User.MyWorldLargeImage anyURI Conditionally The URL to the large version of the eBay user's profile image/logo. This field is only returned if available.

IncludeSelector: Details
User.MyWorldSmallImage anyURI Conditionally The URL to the small version of the eBay user's profile image/logo. This field is only returned if available.

IncludeSelector: Details
User.MyWorldURL anyURI Conditionally The URL to the eBay user's home page (formerly called 'My World'). The home page shows Feedback statistics and has multiple links, such as a link to the seller's eBay Store and a link to the seller's other items.

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.

IncludeSelector: none (not controlled by IncludeSelector)
User.RegistrationDate dateTime Always This timestamp indicates when the 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 enumeration value returned in this field indicates the eBay site on which the user first created an eBay account. If a bidder's user information is made anonymous, the value -99 is returned.

Applicable values: See RegistrationSite.
Code so that your app gracefully handles any future changes to this list.

IncludeSelector: none (not controlled by IncludeSelector)
User.ReviewsAndGuidesURL anyURI Conditionally The URL to a page where it shows any product reviews/ratings that have been given by the eBay user.

IncludeSelector: Details
User.SellerBusinessType SellerBusinessCodeType Always This enumeration value indicates the type of seller account held by the eBay user - a Private (non-business) account or a Commercial (business) account.

Applicable values:

Commercial
(out) This enumeration value indicates that the type of seller account is a commercial (or business seller account).
CustomCode
(out) Reserved for internal or future use.
Private
(out) This enumeration value indicates that the type of seller account is a private seller account (or non-business account).
Undefined
(out) This enumeration value indicates that the type of seller account is undefined, or cannot be determined.

Code so that your app gracefully handles any future changes to this list.

IncludeSelector: none (not controlled by IncludeSelector)
User.SellerItemsURL anyURI Always The URL for an eBay marketplace page that displays a list of the seller's active listings.

IncludeSelector: none (not controlled by IncludeSelector)
User.SellerLevel SellerLevelCodeType Conditionally The enumerated value in this field indicates the current Power Seller level of the eBay user. There are five Power Seller tiers, and each tier is based on average monthly sales. Available benefits and services to the seller vary for each tier.

This field is only returned if the eBay user is a Power Seller, and is not returned at all on some eBay marketplaces.

Applicable values: See SellerLevel.
Code so that your app gracefully handles any future changes to this list.

IncludeSelector: none (not controlled by IncludeSelector)
User.Status UserStatusCodeType Always The enumeration value returned in this field indicates the current status of the eBay user. A value of Confirmed is typically returned for an active eBay user.

Applicable values: See Status.
Code so that your app gracefully handles any future changes to this list.

IncludeSelector: none (not controlled by IncludeSelector)
User.StoreName string Conditionally The name of the seller's eBay Store. This field is only applicable to eBay sellers that have eBay Store subscriptions.

IncludeSelector: Details
User.StoreURL anyURI Conditionally The URL of the seller's eBay Store page. This field is only applicable to eBay sellers that have eBay Store subscriptions.

IncludeSelector: Details
User.TopRatedSeller boolean Conditionally Coming soon. This boolean field is only returned if true, and indicates if the eBay user has Top-Rated Seller status. Top-Rated sellers are eligible to get the 'Top-Rated Plus' badge on all of their active listings (meeting Top-Rated Plus requirements), and qualify for other benefits such as Final Value Fee discounts and increased visibility in search results.

IncludeSelector: none (not controlled by IncludeSelector)
User.UserID string Always The unique identifier of the eBay user. An eBay user ID is unique across all eBay marketplaces.

This field is generally always returned, but it may be masked depending on the situation. For example, if anyone other than the seller of the listing runs a GetItemStatus call on an active auction listing with one or or bids, the UserID value will be masked something like this - b***r.

IncludeSelector: none (not controlled by IncludeSelector)
Standard Output Fields  
Ack AckCodeType Always A token representing the application-level acknowledgement code that indicates the response status (e.g., success). The AckCodeType list specifies the possible values for the Ack field.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Failure
(out) This value indicates that the call request processing failed.
Success
(out) This value indicates that the call request was processed successfully without any issues.
Warning
(out) This value indicates that the call request was successful, but processing was not without any issues. These issues can be checked in the Errors container, that will also be returned when one or more known issues occur with the call request.

(Not all values in AckCodeType apply to this field.)

Code so that your app gracefully handles any future changes to this list.
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.

Code so that your app gracefully handles any future changes to this list.

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 This is the value of the request parameter noted in the ParamID attribute. So, if the ParamID value was ItemID, the value in this field would be the actual value of that ItemID.
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.

Code so that your app gracefully handles any future changes to this list.

See:
    Errors by Number
    Error Handling

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 version of the API call that eBay used to process the request.

Note: Note that some calls are not always updated with each WSDL release, so it is possible that version numbers will differ by API call.
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.



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.FeedbackRatingStar--(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.



Samples

New to making API calls? Please see Making a 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. See also the non-wrapped version of this URL. For results in a format other than XML, 
specify a different value for responseencoding.
https://open.api.ebay.com/shopping?
   callname=GetUserProfile&
   responseencoding=XML&
   appid=YourAppIDHere&
   siteid=0&
   version=967&
   UserID=hypothetical-user

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

XML format. Also available is 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 SOAP equivalent.

<?xml version="1.0" encoding="utf-8"?>
<GetUserProfileResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2016-05-24T21:05:05.781Z</Timestamp> 
  <Ack>Success</Ack> 
  <Build>e967_core_APILW_5028523_R1</Build> 
  <Version>967</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. See also the non-wrapped version of this URL. For results in a format other than XML, 
specify a different value for responseencoding.
https://open.api.ebay.com/shopping?
   callname=GetUserProfile&
   responseencoding=XML&
   appid=YourAppIDHere&
   siteid=0&
   version=967&
   UserID=hypothetical-user&
   IncludeSelector=Details

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

XML format. Also available is 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 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



Change History

Change Date Description
1119
2019-08-02
  • GetUserProfile (modified): Shopping API endpoint updated to support 'https' protocol. So, the following production endpoint should be used for all Shopping API calls: https://open.api.ebay.com/shopping. The http://open.api.ebay.com/shopping endpoint will still be supported for the time being, but is subject to be wired off.
0897
2014-10-21
  • SiteCodeType (modified): 'Russia' added as enumeration value to support selling on the new Russia site.
0629
2009-08-05
  • SimpleUserType.TopRatedSeller (added): Returned when seller is rated a Top-Rated Seller.
0623
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.
0549
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.
0525
2007-08-08
  • (added) New call.