GetUser

Use this call to retrieve data for a single, registered eBay user.

Usage Details

GetUser takes as input the eBay user ID for the user whose data you want to review, or the item ID of a successfully concluded listing in which the requestor and target user were participants as buyer and seller in the order.

A successful call returns the data for the specified user in a User container. Site-specific information (such as a subscription) and non-site-specific information (such as registration date) is also returned. Site-specific information depends on the site you specify in the request, while non-site-specific information does not depend on the specified site.

After retrieving the user information, you can:

1. Inspect the properties of the User container to get the needed data values for the eBay user.
2. As applicable for the application, store the data for later use.

Sellers who engage in cross-border trading on sites that require a recoupment agreement must agree to the recoupment terms before adding items to the site. This agreement allows eBay to reimburse a buyer during a dispute and then recoup the cost from the seller. The list of the sites where a user has agreed to the recoupment terms is returned in the GetUser response.

Testing GetUser

Before using GetUser, create one or two test users in the Sandbox. Some data (like email addresses) is returned only under certain conditions (see Email Privacy Policy). Test GetUser with the requestor accessing data for another user and with retrieving the requestor's own data.

GetUser will only return CharityAffiliationDetails if the user is a registered charity seller with the eBay Giving Works provider. Contact Developer Support to get test Sandbox users that are set up as registered charity sellers.

Related Information

See User information.

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.

The XML prototype does not include requester credentials. This is a documentation limitation only (see Standard Requester Credentials for Making Calls).

<?xml version="1.0" encoding="utf-8"?>
<GetUserRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <IncludeFeatureEligibility> boolean </IncludeFeatureEligibility>
  <ItemID> ItemIDType (string) </ItemID>
  <UserID> string </UserID>
  <!-- Standard Input Fields -->
  <DetailLevel> DetailLevelCodeType </DetailLevel>
  <!-- ... more DetailLevel values allowed here ... -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetUserRequest>

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"?>
<GetUserResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <User> UserType
    <AboutMePage> boolean </AboutMePage>
    <BusinessRole> BusinessRoleType </BusinessRole>
    <eBayGoodStanding> boolean </eBayGoodStanding>
    <eBayWikiReadOnly> boolean </eBayWikiReadOnly>
    <EIASToken> string </EIASToken>
    <Email> string </Email>
    <EnterpriseSeller> boolean </EnterpriseSeller>
    <FeedbackPrivate> boolean </FeedbackPrivate>
    <FeedbackRatingStar> FeedbackRatingStarCodeType </FeedbackRatingStar>
    <FeedbackScore> int </FeedbackScore>
    <IDVerified> boolean </IDVerified>
    <Membership> MembershipDetailsType
      <Program> MembershipDetailType
        <ExpiryDate> dateTime </ExpiryDate>
        <ProgramName> string </ProgramName>
        <Site> SiteCodeType </Site>
      </Program>
      <!-- ... more Program nodes allowed here ... -->
    </Membership>
    <NewUser> boolean </NewUser>
    <PositiveFeedbackPercent> float </PositiveFeedbackPercent>
    <QualifiesForSelling> boolean </QualifiesForSelling>
    <RegistrationAddress> AddressType
      <CityName> string </CityName>
      <CompanyName> string </CompanyName>
      <Country> CountryCodeType </Country>
      <CountryName> string </CountryName>
      <Name> string </Name>
      <Phone> string </Phone>
      <PostalCode> string </PostalCode>
      <StateOrProvince> string </StateOrProvince>
      <Street> string </Street>
      <Street1> string </Street1>
      <Street2> string </Street2>
    </RegistrationAddress>
    <RegistrationDate> dateTime </RegistrationDate>
    <SellerInfo> SellerType
      <AllowPaymentEdit> boolean </AllowPaymentEdit>
      <CharityAffiliationDetails> CharityAffiliationDetailsType
        <CharityAffiliationDetail> CharityAffiliationDetailType
          <AffiliationType> CharityAffiliationTypeCodeType </AffiliationType>
          <CharityID> string </CharityID>
          <LastUsedTime> dateTime </LastUsedTime>
        </CharityAffiliationDetail>
        <!-- ... more CharityAffiliationDetail nodes allowed here ... -->
      </CharityAffiliationDetails>
      <CharityRegistered> boolean </CharityRegistered>
      <CheckoutEnabled> boolean </CheckoutEnabled>
      <CIPBankAccountStored> boolean </CIPBankAccountStored>
      <DomesticRateTable> boolean </DomesticRateTable>
      <FeatureEligibility> FeatureEligibilityType
        <QualifiedForAuctionOneDayDuration> boolean </QualifiedForAuctionOneDayDuration>
        <QualifiedForFixedPriceOneDayDuration> boolean </QualifiedForFixedPriceOneDayDuration>
        <QualifiesForBuyItNow> boolean </QualifiesForBuyItNow>
        <QualifiesForBuyItNowMultiple> boolean </QualifiesForBuyItNowMultiple>
        <QualifiesForVariations> boolean </QualifiesForVariations>
      </FeatureEligibility>
      <GoodStanding> boolean </GoodStanding>
      <InternationalRateTable> boolean </InternationalRateTable>
      <PaymentMethod> SellerPaymentMethodCodeType </PaymentMethod>
      <QualifiesForB2BVAT> boolean </QualifiesForB2BVAT>
      <RecoupmentPolicyConsent> RecoupmentPolicyConsentType
        <Site> SiteCodeType </Site>
        <!-- ... more Site values allowed here ... -->
      </RecoupmentPolicyConsent>
      <RegisteredBusinessSeller> boolean </RegisteredBusinessSeller>
      <SafePaymentExempt> boolean </SafePaymentExempt>
      <SchedulingInfo> SchedulingInfoType
        <MaxScheduledItems> int </MaxScheduledItems>
        <MaxScheduledMinutes> int </MaxScheduledMinutes>
        <MinScheduledMinutes> int </MinScheduledMinutes>
      </SchedulingInfo>
      <SellerBusinessType> SellerBusinessCodeType </SellerBusinessType>
      <SellerLevel> SellerLevelCodeType </SellerLevel>
      <SellerPaymentAddress> AddressType
        <CityName> string </CityName>
        <Country> CountryCodeType </Country>
        <CountryName> string </CountryName>
        <InternationalName> string </InternationalName>
        <InternationalStateAndCity> string </InternationalStateAndCity>
        <InternationalStreet> string </InternationalStreet>
        <Name> string </Name>
        <Phone> string </Phone>
        <PostalCode> string </PostalCode>
        <StateOrProvince> string </StateOrProvince>
        <Street1> string </Street1>
        <Street2> string </Street2>
      </SellerPaymentAddress>
      <StoreOwner> boolean </StoreOwner>
      <StoreSite> SiteCodeType </StoreSite>
      <StoreURL> anyURI </StoreURL>
      <TopRatedSeller> boolean </TopRatedSeller>
      <TopRatedSellerDetails> TopRatedSellerDetailsType
        <TopRatedProgram> TopRatedProgramCodeType </TopRatedProgram>
        <!-- ... more TopRatedProgram values allowed here ... -->
      </TopRatedSellerDetails>
      <TransactionPercent> float </TransactionPercent>
    </SellerInfo>
    <Site> SiteCodeType </Site>
    <Status> UserStatusCodeType </Status>
    <TUVLevel> int </TUVLevel>
    <UniqueNegativeFeedbackCount> int </UniqueNegativeFeedbackCount>
    <UniqueNeutralFeedbackCount> int </UniqueNeutralFeedbackCount>
    <UniquePositiveFeedbackCount> int </UniquePositiveFeedbackCount>
    <UserID> UserIDType (string) </UserID>
    <UserIDChanged> boolean </UserIDChanged>
    <UserIDLastChanged> dateTime </UserIDLastChanged>
    <UserSubscription> EBaySubscriptionTypeCodeType </UserSubscription>
    <!-- ... more UserSubscription values allowed here ... -->
    <VATID> string </VATID>
    <VATStatus> VATStatusCodeType </VATStatus>
  </User>
  <!-- Standard Output Fields -->
  <Ack> AckCodeType </Ack>
  <Build> string </Build>
  <CorrelationID> string </CorrelationID>
  <Errors> ErrorType
    <ErrorClassification> ErrorClassificationCodeType </ErrorClassification>
    <ErrorCode> token </ErrorCode>
    <ErrorParameters ParamID="string"> ErrorParameterType
      <Value> string </Value>
    </ErrorParameters>
    <!-- ... more ErrorParameters nodes allowed here ... -->
    <LongMessage> string </LongMessage>
    <SeverityCode> SeverityCodeType </SeverityCode>
    <ShortMessage> string </ShortMessage>
  </Errors>
  <!-- ... more Errors nodes allowed here ... -->
  <HardExpirationWarning> string </HardExpirationWarning>
  <Timestamp> dateTime </Timestamp>
  <Version> string </Version>
</GetUserResponse>

Detail Controls

DetailLevel

The DetailLevel input field influences which call-specific fields may be returned. (All standard output fields are returned regardless of DetailLevel.)

The none column indicates the fields that are returned when you do not specify a DetailLevel.

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.

Retrieves the data for a single user registered on the eBay site.

Description

A potential buyer has found a rare Harry potter book on eBay, and it is listed by the seller m***************r. The potential buyer is interested in getting information about the seller. This call retrieves detailed information on m***************r, which helps the buyer determine if the seller is trustworthy.

Input

The input needed for the potential buyer to get information on the seller is the UserID for m***************r.

XML format.

<?xml version="1.0" encoding="utf-8"?> 
<GetUserRequest xmlns="urn:ebay:apis:eBLBaseComponents"> 
  <RequesterCredentials> 
    <eBayAuthToken>A*******3</eBayAuthToken> 
  </RequesterCredentials> 
  <UserID>m***************r</UserID>
</GetUserRequest> 

Output

The important information in the output includes the FeedbackScore, PositiveFeedbackPercent, eBayGoodStanding, and the SellerInfo. This information helps the potential buyer to decide whether or not to bid on the seller's listing.

XML format.
<?xml version="1.0" encoding="UTF-8"?>
<GetUserResponse 
  xmlns="urn:ebay:apis:eBLBaseComponents">
 <Timestamp>2019-11-05T22:43:42.456Z</Timestamp>
 <Ack>Success</Ack>
 <Version>1123</Version>
  <Build>E1123_CORE_APISIGNIN_19059235_R1</Build>
  <User>
    <AboutMePage>false</AboutMePage>
    <EIASToken>n******************************************************=</EIASToken>
    <Email>Invalid Request</Email>
    <FeedbackScore>431</FeedbackScore>
    <UniqueNegativeFeedbackCount>0</UniqueNegativeFeedbackCount>
    <UniquePositiveFeedbackCount>128</UniquePositiveFeedbackCount>
    <PositiveFeedbackPercent>100.0</PositiveFeedbackPercent>
    <FeedbackPrivate>false</FeedbackPrivate>
    <FeedbackRatingStar>Turquoise</FeedbackRatingStar>
    <IDVerified>true</IDVerified>
    <eBayGoodStanding>true</eBayGoodStanding>
    <NewUser>false</NewUser>
    <RegistrationDate>2004-02-10T22:49:58.000Z</RegistrationDate>
    <Site>US</Site>
    <Status>Confirmed</Status>
    <UserID>m***************r</UserID>
    <UserIDChanged>false</UserIDChanged>
    <UserIDLastChanged>2004-02-10T22:50:12.000Z</UserIDLastChanged>
    <VATStatus>NoVATTax</VATStatus>
    <SellerInfo>
      <AllowPaymentEdit>true</AllowPaymentEdit>
      <CheckoutEnabled>true</CheckoutEnabled>
      <CIPBankAccountStored>false</CIPBankAccountStored>
      <GoodStanding>true</GoodStanding>
      <LiveAuctionAuthorized>false</LiveAuctionAuthorized>
      <MerchandizingPref>OptIn</MerchandizingPref>
      <QualifiesForB2BVAT>false</QualifiesForB2BVAT>
      <SellerGuaranteeLevel>NotEligible</SellerGuaranteeLevel>
      <SchedulingInfo>
        <MaxScheduledMinutes>30240</MaxScheduledMinutes>
        <MinScheduledMinutes>0</MinScheduledMinutes>
        <MaxScheduledItems>3000</MaxScheduledItems>
      </SchedulingInfo>
      <StoreOwner>true</StoreOwner>
      <StoreURL>http://stores.ebay.com/m***************r</StoreURL>
      <SellerBusinessType>Private</SellerBusinessType>
      <StoreSite>US</StoreSite>
      <PaymentMethod>PayPal</PaymentMethod>
      <CharityRegistered>false</CharityRegistered>
      <SafePaymentExempt>true</SafePaymentExempt>
      <TransactionPercent>33.3</TransactionPercent>
      <RecoupmentPolicyConsent/>
      <DomesticRateTable>false</DomesticRateTable>
      <InternationalRateTable>false</InternationalRateTable>
    </SellerInfo>
    <BusinessRole>FullMarketPlaceParticipant</BusinessRole>
    <PayPalAccountLevel>Verified</PayPalAccountLevel>
    <PayPalAccountType>Premier</PayPalAccountType>
    <PayPalAccountStatus>Active</PayPalAccountStatus>
    <EBaySubscription>SellerReportsPlus</EBaySubscription>
    <EBaySubscription>CustomCode</EBaySubscription>
    <EBaySubscription>SellingManager</EBaySubscription>
    <EBaySubscription>FileExchange</EBaySubscription>
    <UserSubscription>SellerReportsPlus</UserSubscription>
    <UserSubscription>CustomCode</UserSubscription>
    <UserSubscription>SellingManager</UserSubscription>
    <UserSubscription>FileExchange</UserSubscription>
    <eBayWikiReadOnly>false</eBayWikiReadOnly>
    <MotorsDealer>false</MotorsDealer>
    <UniqueNeutralFeedbackCount>0</UniqueNeutralFeedbackCount>
    <EnterpriseSeller>false</EnterpriseSeller>
  </User>
</GetUserResponse>

Change History