eBay Trading APIVersion 1173

User Account Call Index

This Call Reference describes the elements and attributes for each eBay User Account call below.

The details in this Call Reference apply if you are developing applications with the Trading WSDL or Trading Schema (XSD) file, or if you are using one of the eBay SDKs. If you are using an SDK, note that there can be differences between the calls outlined in this reference and the calls in the SDK. For details, see eBay SDKs.

Please note that eBay also has REST-Based Selling and Buying APIs for developers who prefer using REST APIs.

For the original alphabetical Call Index page, go here.



User Account Details Calls | Buying and Selling Activity Calls | Account Settings and Preferences Calls | Notification Calls | Miscellaneous My eBay Calls | Token/User Authentication Calls | VeRO Program Calls |

Call Summary Samples

User Account Details Calls

GetUser Retrieves data pertaining to a single eBay user. view
GetAccount Returns a seller's invoice data for their eBay account, including the account's summary data. view
GetSellerDashboard Retrieves a brief summary of the requester's status as an eBay seller. view
GetApiAccessRules Reports how many Trading API calls your application has made and is allowed to make per hour or day. view
  Note: If you prefer REST-Based APIs, the following are alternatives to the preceding calls:

Buying and Selling Activity Calls

GetMyeBaySelling Returns items from the Selling section of the user's My eBay account, including items that the user is currently selling (the Active list), items that have bids, sold items, and unsold items. view
GetMyeBayBuying Returns items from the Buying section of the user's My eBay account, including items that the user is watching, bidding on, has won, has not won, and has made best offers on. view

Account Settings and Preferences Calls

GetUserPreferences Retrieves the specified user preferences for the authenticated caller. view
SetUserPreferences Type defining the SetUserPreferences request container. view
GetShippingDiscountProfiles Returns the shipping discount profiles defined by the user, along with other combined payment-related details such as packaging and handling costs. view
SetShippingDiscountProfiles Enables a seller to define shipping cost discount profiles for things such as combined payments for shipping and handling costs. view
GetTaxTable Retrieves the tax table for a user on a given site or retrieves the valid jurisdictions (if any) for a given site. view
SetTaxTable Sets the tax table for a seller on a given site. view
  Note: If you prefer REST-Based APIs, the following are alternatives to the preceding calls:

Notification Calls

GetNotificationPreferences Retrieves the requesting application's notification preferences. view
SetNotificationPreferences Manages notification and alert preferences for applications and users. view
GetNotificationsUsage Retrieves usage information about platform notifications for a given application. Guide only

Miscellaneous My eBay Calls

AddToWatchList Adds one or more items to the user's My eBay watch list. view
RemoveFromWatchList Enables a user to remove one or more items from their My eBay watch list. view
SetUserNotes Enables users to add, replace, and delete My eBay notes for items that are being tracked in the My eBay All Selling and All Buying areas. view
GetMyeBayReminders Requests totals for the Buying and Selling reminders from the user's My eBay account. view

Token/User Authentication Calls

ConfirmIdentity Returns the ID of a user who has gone through an application's consent flow process for obtaining an authorization token. view
FetchToken Retrieves an authentication token for a user. view
GetChallengeToken Retrieves a botblock token and URLs for an image or audio clip that the user is to match. view
GetClientAlertsAuthToken Retrieves a token required for the GetUserAlerts call in the Client Alerts API. view
GetSessionID Retrieves a session ID that identifies a user and your application when you make a FetchToken request. view
GetTokenStatus Requests current status of user token. view
RevokeToken Voluntarily revokes a token before it would otherwise expire. view
ValidateChallengeInput Validates the user response to a GetChallengeToken botblock challenge. Guide only
ValidateTestUserRegistration Requests to enable a test user to sell items in the Sandbox environment. view

VeRO Program Calls

GetVeROReasonCodeDetails Retrieves details about VeRO reason codes for a given site or all sites. You must be a member of the Verified Rights Owner (VeRO) Program to use this call. Guide only
GetVeROReportStatus Retrieves status information about VeRO reported items. You must be a member of the Verified Rights Owner (VeRO) Program to use this call. Guide only
VeROReportItems Reports items that allegedly infringe your copyright, trademark, or other intellectual property rights. You must be a member of the Verified Rights Owner (VeRO) Program to use this call. Guide only


Standard Requester Credentials for Making Calls

The prototypes and tables do not include the RequesterCredentials container and fields. For example, the input sections do not include eBayAuthToken. For information about authenticating requests, please refer to the guide for the API or SDK you are using. If you are using the Trading API, pass the RequesterCredentials node in the request XML as in the snippet below for most XML requests (exceptions are FetchToken and GetSessionID). In SOAP requests, pass the token and the RequesterCredentials in the SOAP header. See Standard Data for All Calls for fuller examples and information, including a SOAP example.

<RequesterCredentials>
  <eBayAuthToken>string</eBayAuthToken>
</RequesterCredentials>