GetUserProfile

Note: All calls in the Shopping API have been deprecated and will be decommissioned on February 5, 2025. An alternative to this API is the Browse API, which also has advanced search capabilities.

Note: Developers using Shopping API calls must authenticate with an OAuth application access token in the HTTP header X-EBAY-API-IAF-TOKEN and use OAuth application access tokens with a scope that includes https://api.ebay.com/oauth/api_scope. See the client credentials grant flow topic for more information on generating and managing OAuth application access tokens. See the Specifying OAuth scopes topic for more information on OAuth scopes.

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

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are (or soon will be) non-operational.

<?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>

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

See also the Deprecated Objects link above. Fields presented in this color are deprecated, and fields presented in this color are not returned (or soon will not be returned) or are not operational (or soon will be non-operational).

<?xml version="1.0" encoding="utf-8"?>
<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>

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.

DetailLevel

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

Samples

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:

• Basic Call ↓ - Retrieves the default set of information pertaining to a user.
• Returning Detailed User Information ↓ - Setting the Details IncludeSelector retrieves detailed user information, including the StoreURL field and other data.

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&
   siteid=0&
   version=967&
   UserID=h***************r

   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>h***************r</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>h***************r</UserID>
    <SellerItemsURL>http://search.ebay.com/_W0LMsarsrh***************rQQhtZ-1</SellerItemsURL>
    <AboutMeURL>http://members.ebay.com/aboutme/h***************r</AboutMeURL>
    <FeedbackDetailsURL>http://feedback.ebay.com/ws/eBayISAPI.dll?ViewFeedback&userid=h***************r&ssPageName=STRG:ME:UFS</FeedbackDetailsURL>
  </User>
</GetUserProfileResponse>

Back to list of samples

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&
   siteid=0&
   version=967&
   UserID=h***************r&
   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>h***************r</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>h***************r</UserID>
    <StoreURL>http://stores.ebay.com/H****************e</StoreURL>
    <StoreName>H****************e</StoreName>
    <SellerItemsURL>http://search.ebay.com/_W0LMsarsrh***************rQQhtZ-1</SellerItemsURL>
    <AboutMeURL>http://members.ebay.com/aboutme/h***************r</AboutMeURL>
    <MyWorldURL>http://myworld.ebay.com/h***************r</MyWorldURL>
    <MyWorldSmallImage>http://i2.ebayimg.ebay.com/01/u/000/00/23/9*****.JPG?set_id=23</MyWorldSmallImage>
    <MyWorldLargeImage>http://i2.ebayimg.ebay.com/01/u/000/77/23/9****7.JPG?set_id=23</MyWorldLargeImage>
    <ReviewsAndGuideURL>http://search.reviews.us.ebay.com/members/h***************r</ReviewsAndGuideURL>
    <FeedbackDetailsURL>http://feedback.ebay.com/ws/eBayISAPI.dll?ViewFeedback&userid=h***************r&ssPageName=STRG:ME:UFS</FeedbackDetailsURL>
  </User>
</GetUserProfileResponse>

Back to list of samples

Change History