GetUserContactDetails

Use this call to retrieve contact information for a specified user, given that a bidding relationship (as either a buyer or seller) exists between the caller and the user.

The bidder must be bidding on the seller's active item, or an eBay user must have made an offer on the item using Best Offer. In addition, the item must be in either the eBay Motors (SiteID=100) category, or in Business & Industrial category.

Sellers can use GetUserContactDetails to retrieve contact information for both bidders and users who have made offers (via Best Offer) during an active listing. Buyers can also use this call to contact sellers of an item they are bidding on or have made an offer on (via Best Offer). The following additional restrictions apply:

• The item specified in ItemID must be currently active.
• Sellers of an item can only use GetUserContactDetails to retrieve contact details for their bidders, and vice versa. Bidders cannot retrieve contact details for other bidders.

Usage Details

When calling GetUserContactDetails, supply the ItemID value for the item for which there is a bidding relationship between you and the user for whom you are seeking information, the eBay user ID for the target user (in the ContactID field), and your eBay user ID (in the RequesterID field).

If the GetUserContactDetails execution is successful, it returns the available information on the requested user. If unsuccessful, the call returns an error construct (see Error Handling). Note that if a warning occurs, the result set will contain both normal data and an error construct.

GetUserContactDetails returns all available contact information except street address and email address. Sellers who wish to send an email to bidders should use AddMemberMessagesAAQToBidder.

Testing GetUserContactDetails

You can test this call in the Sandbox. GetUserContactDetails requires that a "bidding" relationship exists between the two parties. That is, the message recipient must be bidding on, or have made a Best Offer on, an active item that the seller is selling.

To test the call, create a seller in the Sandbox and list an item in eBay Motors or in the Business & Industrial category. You must allow Best Offers on your item to test sending messages to users who make Best Offers on your items. Create a buyer in the Sandbox, and place a bid or place an offer (via Best Offer) on that item.

Retrieve the bidder contact details by call GetUserContactDetails with the test seller's token and their eBay user ID in the RequesterID field, the test buyer specified in ContactID, and the item you created in ItemID.

To test retrieving seller contact details, call GetUserContactDetails with the test buyer's token and their eBay user ID in the RequesterID field, the test seller specified in ContactID, and the item you created in ItemID.

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"?>
<GetUserContactDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Input Fields -->
  <ContactID> string </ContactID>
  <ItemID> string </ItemID>
  <RequesterID> string </RequesterID>
  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetUserContactDetailsRequest>

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"?>
<GetUserContactDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <ContactAddress> AddressType
    <CityName> string </CityName>
    <CompanyName> string </CompanyName>
    <Country> CountryCodeType </Country>
    <Name> string </Name>
    <Phone> string </Phone>
    <StateOrProvince> string </StateOrProvince>
  </ContactAddress>
  <RegistrationDate> dateTime </RegistrationDate>
  <UserID> string </UserID>
  <!-- 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>
</GetUserContactDetailsResponse>

Detail Controls

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.

Retrieves user data for a buyer involved in a bidding relationship with the caller.

Description

Seller m***************r wants to review the information for the high bidder on an book she is selling.

Input

XML format.

<?xml version="1.0" encoding="utf-8"?>
<GetUserContactDetailsRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>A*******3</eBayAuthToken>
  </RequesterCredentials>
  <RequesterID>m***************r</RequesterID>
  <ItemID>1**********2</ItemID>
  <ContactID>b************r</ContactID>
</GetUserContactDetailsRequest>

Output

XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetUserContactDetailsResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2019-11-06T17:01:57.533Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_API6_19105226_R1</Build>
  <UserID>b********r</UserID>
  <ContactAddress>
    <Name>B*******l B***r</Name>
    <CityName>San Jose</CityName>
    <StateOrProvince>CA</StateOrProvince>
    <CountryName>United States</CountryName>
    <Phone>1-***-***-***5</Phone>
    <CompanyName>
    </CompanyName>
  </ContactAddress>
  <RegistrationDate>2004-02-23T08:00:00.000Z</RegistrationDate>
</GetUserContactDetailsResponse>

Change History