eBay Trading API897

GetSellerDashboard

Use this call to retrieve a brief summary of the requester's status as an eBay seller. The status information can help an eBay seller monitor their selling performance, which can help keep their account in good standing.

The Seller Dashboard is returned for the user identified by the user token you pass in the request.

To be eligible to view a Seller Dashboard, the user needs 10 or more Detailed Seller Ratings (across any of the four rating categories) within the last 12 months. If the user is not eligible, the call returns an error. Use GetFeedback to check the user's Detailed Seller Ratings (DSR).

Note that the this call does not return the correct Seller Dashboard data in the Sandbox. Test this call in production environment to get useful results.

See:
    About Your Seller Dashboard (eBay US online help)
    Zum Thema Verkaufer-Cockpit (eBay Germany online help)

See also the reference documentation for these calls:



Back to top

Input

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

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"?>
<GetSellerDashboardRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- (No call-specific Input fields) -->

  <!-- Standard Input Fields -->
  <ErrorLanguage> string </ErrorLanguage>
  <MessageID> string </MessageID>
  <Version> string </Version>
  <WarningLevel> WarningLevelCodeType </WarningLevel>
</GetSellerDashboardRequest>
Argument Type Occurrence Meaning
(No call-specific fields)
Standard Input Fields  
ErrorLanguage string Optional Use ErrorLanguage to return error strings for the call in a different language from the language commonly associated with the site that the requesting user is registered with. Specify the standard RFC 3066 language identification tag (e.g., en_US).

ID Country
en_AU Australia
de_AT Austria
nl_BE Belgium (Dutch)
fr_BE Belgium (French)
en_CA Canada
fr_CA Canada (French)
zh_CN China
fr_FR France
de_DE Germany
zh_HK Hong Kong
en_IN India
en_IE Ireland
it_IT Italy
nl_NL Netherlands
en_SG Singapore
es_ES Spain
de_CH Switzerland
en_GB United Kingdom
en_US United States

See Tags for the Identification of Languages.

MessageID string Optional Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Version string Conditional The version number of the API code that you are programming against (e.g., 859). The version you specify for a call has these basic effects:
- It indicates the version of the code lists and other data that eBay should use to process your request.
- It indicates the schema version you are using.
You need to use a version that is greater than or equal to the lowest supported version.

For the SOAP API: If you are using the SOAP API, this field is required. Specify the version of the WSDL your application is using.

For the XML API: If you are using the XML API, this field has no effect. Instead, specify the version in the X-EBAY-API-COMPATIBILITY-LEVEL HTTP header. (If you specify Version in the body of an XML API request and it is different from the value in the HTTP header, eBay returns an informational warning that the value in the HTTP header was used instead.)

See:
    Routing the Request (Gateway URLs)
    eBay Schema Versioning Strategy
    Lowest Supported Version

WarningLevel WarningLevelCodeType Optional Controls whether or not to return warnings when the application passes unrecognized or deprecated elements in a request.

An unrecognized element is one that is not defined in any supported version of the schema. Schema element names are case-sensitive, so using WarningLevel can also help you remove any potential hidden bugs within your application due to incorrect case or spelling in field names before you put your application into the Production environment.

WarningLevel only validates elements; it doesn't validate XML attributes. It also doesn't control warnings related to user-entered strings or numbers, or warnings for logical errors.

We recommend that you only use this during development and debugging. Do not use this in requests performed in the Production environment.

Applicable values:

High
(in) Return warnings when the application passes unrecognized or deprecated elements in a request.
Low
(in) Do not return warnings when the application passes unrecognized or deprecated elements in a request. This is the default value if WarningLevel is not specified.

See Warning Level.



Back to top

Output

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

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"?>
<GetSellerDashboardResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <!-- Call-specific Output Fields -->
  <BuyerSatisfaction> BuyerSatisfactionDashboardType
    <Alert> SellerDashboardAlertType
      <Severity> SellerDashboardAlertSeverityCodeType </Severity>
      <Text> string </Text>
    </Alert>
    <!-- ... more Alert nodes allowed here ... -->
    <Status> BuyerSatisfactionStatusCodeType </Status>
  </BuyerSatisfaction>
  <Performance> PerformanceDashboardType
    <Alert> SellerDashboardAlertType
      <Severity> SellerDashboardAlertSeverityCodeType </Severity>
      <Text> string </Text>
    </Alert>
    <Site> SiteCodeType </Site>
    <!-- ... more Site values allowed here ... -->
    <Status> PerformanceStatusCodeType </Status>
  </Performance>
  <!-- ... more Performance nodes allowed here ... -->
  <PowerSellerStatus> PowerSellerDashboardType
    <Alert> SellerDashboardAlertType
      <Severity> SellerDashboardAlertSeverityCodeType </Severity>
      <Text> string </Text>
    </Alert>
    <!-- ... more Alert nodes allowed here ... -->
    <Level> SellerLevelCodeType </Level>
  </PowerSellerStatus>
  <SearchStanding> SearchStandingDashboardType
    <Status> SearchStandingStatusCodeType </Status>
  </SearchStanding>
  <SellerAccount> SellerAccountDashboardType
    <Alert> SellerDashboardAlertType
      <Severity> SellerDashboardAlertSeverityCodeType </Severity>
      <Text> string </Text>
    </Alert>
    <!-- ... more Alert nodes allowed here ... -->
    <Status> SellerAccountStatusCodeType </Status>
  </SellerAccount>
  <SellerFeeDiscount> SellerFeeDiscountDashboardType
    <Percent> float </Percent>
  </SellerFeeDiscount>
  <!-- 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>
</GetSellerDashboardResponse>
Return Value Type Occurrence Meaning
Call-specific Output Fields [Jump to standard fields]
BuyerSatisfaction BuyerSatisfactionDashboardType Conditionally Rates your level of customer service. This information helps you to keep track of how well you are providing members with positive buying experiences.

This element is not returned for all sites.

See:
    About Your Seller Dashboard: Buyer Satisfaction
    Zum Thema Verkaeufer-Cockpit: Kaeuferzufriedenheit

BuyerSatisfaction.Alert SellerDashboardAlertType Conditionally,
repeatable: [0..*]
The BuyerSatisfaction.Alert container is only returned if eBay has posted one or more informational or warning messages related to the seller's buyer satisfaction rating.
BuyerSatisfaction.Alert
  .Severity
SellerDashboardAlertSeverityCodeType Conditionally The severity level helps you understand whether the alert is identifying a problem (a warning or strong warning) or if it is informational in nature. This field is present if an alert has been issued to your account.

Applicable values:

CustomCode
(out) Reserved for internal (or future) use.
Informational
(out) The alert message is informational in nature.

Some examples: you might get a PowerSeller status message if your PowerSeller level has been increased, a policy-compliance message if you have no recent policy violations, a buyer-satisfaction message if you are providing excellent customer service, or a seller-account message if there is a new notice available about your payment status.
StrongWarning
(out) The alert message is a strong warning that indicates a serious problem.

For example, you might get a PowerSeller status strong warning if you have lost your PowerSeller status because of policy violations, or you might get a policy-compliance strong warning if your account has been restricted.
Warning
(out) The alert message is a warning that identifies a problem.

For example, you might get a PowerSeller status warning if you missed the PowerSeller sales requirements in the past month. Or you might get a policy-compliance warning if you recently listed an item with excessive shipping costs, or a seller-account warning if a collections message asks you to pay now to make sure no restrictions are placed on your account.

BuyerSatisfaction.Alert.Text string Conditionally The warning or informational alert text. When you parse this text, note that some alerts may use plain text while others can include HTML. Returned only if the seller has been issued an alert.
BuyerSatisfaction.Status BuyerSatisfactionStatusCodeType Always This field indicates the seller's buyer satisfaction rating. To determine this rating, eBay considers your detailed seller ratings, your overall feedback rating, and whatever buyer protection claims might exist on your account. eBay uses the buyer satisfaction rating to see if you are eligible for certain rewards, or if you need additional guidance to help you give better service.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Excellent
(out) You are doing an excellent job as an eBay seller. Be sure to continue providing members with a positive buying experience. A buyer satisfaction rating of Excellent ensures that you are eligible for eBay incentives.
Good
(out) You are doing a good job as an eBay seller. Buyers have been satisfied with your customer service. Be sure to continue providing members with a positive buying experience. A buyer satisfaction rating of Good ensures that you are eligible for eBay incentives.
Poor
(out) You are not doing a good job as an eBay seller. Some of your buyers have not been satisfied with your service. Improve your customer service to earn a higher buyer satisfaction rating. If your customer service continues to receive poor responses from customers, your buyer satisfaction rating can drop and could put your eBay seller's account at risk.
Unacceptable
(out) You are doing an unacceptable job as an eBay seller. Improve your selling practices immediately. Your account may be suspended because of your unacceptable customer service.
VeryPoor
(out) You are doing a very poor job as an eBay seller. You need to improve your selling practices immediately. Too many of your customers have not been satisfied with your customer service and you are at risk of losing your eBay account.

(Not all values in BuyerSatisfactionStatusCodeType apply to this field.)
Performance PerformanceDashboardType Always,
repeatable: [1..*]
Provides information about the seller's performance within different eBay regions. A seller's performance rating can be Top-Rated, Above Standard, Standard, and Below Standard.

See:
    Top-Rated Seller Status
    About Your Seller Dashboard: Performance Status
    Zum Thema Verkaeufer-Cockpit: Leistung

Performance.Alert SellerDashboardAlertType Conditionally The Performance.Alert container is only returned if eBay has posted one or more informational or warning messages related to the seller's performance rating.
Performance.Alert.Severity SellerDashboardAlertSeverityCodeType Conditionally The severity level helps you understand whether the alert is identifying a problem (a warning or strong warning) or if it is informational in nature. This field is present if an alert has been issued to your account.

Applicable values:

CustomCode
(out) Reserved for internal (or future) use.
Informational
(out) The alert message is informational in nature.

Some examples: you might get a PowerSeller status message if your PowerSeller level has been increased, a policy-compliance message if you have no recent policy violations, a buyer-satisfaction message if you are providing excellent customer service, or a seller-account message if there is a new notice available about your payment status.
StrongWarning
(out) The alert message is a strong warning that indicates a serious problem.

For example, you might get a PowerSeller status strong warning if you have lost your PowerSeller status because of policy violations, or you might get a policy-compliance strong warning if your account has been restricted.
Warning
(out) The alert message is a warning that identifies a problem.

For example, you might get a PowerSeller status warning if you missed the PowerSeller sales requirements in the past month. Or you might get a policy-compliance warning if you recently listed an item with excessive shipping costs, or a seller-account warning if a collections message asks you to pay now to make sure no restrictions are placed on your account.

Performance.Alert.Text string Conditionally The warning or informational alert text. When you parse this text, note that some alerts may use plain text while others can include HTML. Returned only if the seller has been issued an alert.
Performance.Site SiteCodeType Always,
repeatable: [1..*]
The eBay site(s) on which the seller's performance is being evaluated.
A seller's performance status is evaluated for three specific regions: US, UK/Ireland, and Germany/Switzerland/Austria. The Site field is repeated to show all sites in each region, if applicable.

Applicable values: See Site.
Performance.Status PerformanceStatusCodeType Always This field indicates the seller's performance rating. This rating is an overall performance for the eBay site(s) found in the Site field(s).

Applicable values:

AboveStandard
(out) Your seller performance rating is Above Standard.
BelowStandard
(out) Your seller performance rating is Below Standard.
CustomCode
(out) Reserved for internal use.
Standard
(out) Your seller performance rating is Standard.
TopRated
(out) You are a Top-Rated seller.

PowerSellerStatus PowerSellerDashboardType Conditionally Provides information about your PowerSeller status, such as whether or not you meet the PowerSeller requirements. Your PowerSeller status directly affects your discount (SellerFeeDiscount).

For eBay Germany and France, you must be a registered business seller to see your PowerSeller status.

See:
    About Your Seller Dashboard: PowerSeller Status
    PowerSeller Benefits and Requirements
    Zum Thema Verkaeufer-Cockpit: PowerSeller-Status

PowerSellerStatus.Alert SellerDashboardAlertType Conditionally,
repeatable: [0..*]
The PowerSellerStatus.Alert container is only returned if eBay has posted one or more informational or warning messages related to the seller's PowerSeller status.
PowerSellerStatus.Alert
  .Severity
SellerDashboardAlertSeverityCodeType Conditionally The severity level helps you understand whether the alert is identifying a problem (a warning or strong warning) or if it is informational in nature. This field is present if an alert has been issued to your account.

Applicable values:

CustomCode
(out) Reserved for internal (or future) use.
Informational
(out) The alert message is informational in nature.

Some examples: you might get a PowerSeller status message if your PowerSeller level has been increased, a policy-compliance message if you have no recent policy violations, a buyer-satisfaction message if you are providing excellent customer service, or a seller-account message if there is a new notice available about your payment status.
StrongWarning
(out) The alert message is a strong warning that indicates a serious problem.

For example, you might get a PowerSeller status strong warning if you have lost your PowerSeller status because of policy violations, or you might get a policy-compliance strong warning if your account has been restricted.
Warning
(out) The alert message is a warning that identifies a problem.

For example, you might get a PowerSeller status warning if you missed the PowerSeller sales requirements in the past month. Or you might get a policy-compliance warning if you recently listed an item with excessive shipping costs, or a seller-account warning if a collections message asks you to pay now to make sure no restrictions are placed on your account.

PowerSellerStatus.Alert.Text string Conditionally The warning or informational alert text. When you parse this text, note that some alerts may use plain text while others can include HTML. Returned only if the seller has been issued an alert.
PowerSellerStatus.Level SellerLevelCodeType Conditionally This field indicates the seller's eBay PowerSeller tier. PowerSellers are distinguished in five tiers based on average monthly sales. Benefits and services vary for each tier. eBay calculates eligibility for each tier on a monthly basis.

Applicable values:

Bronze
(out) Bronze (lowest tier)
CustomCode
(out) Reserved for internal or future use
Gold
(out) Gold (between Silver and Platinum)
None
(out) Not a PowerSeller (eBay has not yet evaluated your PowerSeller status, or you have not chosen to be a member of the PowerSeller program, or you lost your PowerSeller status due to a policy violation.)
Platinum
(out) Platinum (between Gold and Titanium)
Silver
(out) Silver (between Bronze and Gold)
Titanium
(out) Titanium (highest tier)

See eBay US PowerSeller Requirements and Levels.

SearchStanding SearchStandingDashboardType Conditionally Provides information about the visibility level you have earned for your listings. The higher your search standing rating, the higher your items will be placed in search results sorted by Best Match. Because your search standing rating is directly tied to your customer service record, this rating is an important way that eBay rewards you as a good seller--it encourages you to give buyers the best possible shopping experience.

This element is not returned for all sites. Beginning at the end of 2009, eBay stopped returning it for sellers registered on several large sites, including the US, German, and UK sites.

See:
    About Your Seller Dashboard: Search Standing
    Zum Thema Verkaeufer-Cockpit: Platzierung in der Suche

SearchStanding.Status SearchStandingStatusCodeType Always Your earned search standing status. To qualify for a Standard or Raised search standing, make sure your ratings meet or exceed the required minimum levels in buyer satisfaction (see BuyerSatisfaction.Status in this call) and detailed seller ratings (DSRs). See GetFeedback for details.

Applicable values:

CustomCode
(out) Reserved for internal or future use.
Lowered
(out) Your listings may receive lower placement in search results that are sorted by Best Match. You earn this standing when you have not been successful in providing eBay buyers with the customer service they expect. You can still take positive steps to improve your customer service and increase your ratings.
Raised
(out) Your listings may receive higher placement in search results that are sorted by Best Match. You earn this standing when you provide excellent customer service to eBay buyers (such as good BuyerSatisfaction.Status and high detailed seller ratings). If you already have a raised search standing, you can still boost your ratings and increase the visibility of your items by maintaining or improving your customer service.
Standard
(out) Listings recieve standard placement in search results that are sorted by Best Match.

See (GetFeedback) FeedbackSummary.SellerRatingSummaryArray.

SellerAccount SellerAccountDashboardType Always The status of your latest eBay invoice. Includes any alerts issued to your account to help you identify possible problems.

See:
    About Your Seller Dashboard: Account Status
    Zum Thema Verkaeufer-Cockpit: Kontostand

SellerAccount.Alert SellerDashboardAlertType Conditionally,
repeatable: [0..*]
The SellerAccount.Alert container is only returned if eBay has posted one or more informational or warning messages to the seller's account.
SellerAccount.Alert.Severity SellerDashboardAlertSeverityCodeType Conditionally The severity level helps you understand whether the alert is identifying a problem (a warning or strong warning) or if it is informational in nature. This field is present if an alert has been issued to your account.

Applicable values:

CustomCode
(out) Reserved for internal (or future) use.
Informational
(out) The alert message is informational in nature.

Some examples: you might get a PowerSeller status message if your PowerSeller level has been increased, a policy-compliance message if you have no recent policy violations, a buyer-satisfaction message if you are providing excellent customer service, or a seller-account message if there is a new notice available about your payment status.
StrongWarning
(out) The alert message is a strong warning that indicates a serious problem.

For example, you might get a PowerSeller status strong warning if you have lost your PowerSeller status because of policy violations, or you might get a policy-compliance strong warning if your account has been restricted.
Warning
(out) The alert message is a warning that identifies a problem.

For example, you might get a PowerSeller status warning if you missed the PowerSeller sales requirements in the past month. Or you might get a policy-compliance warning if you recently listed an item with excessive shipping costs, or a seller-account warning if a collections message asks you to pay now to make sure no restrictions are placed on your account.

SellerAccount.Alert.Text string Conditionally The warning or informational alert text. When you parse this text, note that some alerts may use plain text while others can include HTML. Returned only if the seller has been issued an alert.
SellerAccount.Status SellerAccountStatusCodeType Always This field indicates the status of your seller's account. Specifically, you'll find out if your account is current and active, or if your account has a past due balance or is on hold. For more details about your account, you can go to your Seller Account page on the eBay site (login to My eBay), or you can call GetAccount.

Applicable values:

Current
(out) Your account is current.
CustomCode
(out) Reserved for internal or future use.
OnHold
(out) Your account is on hold and risking suspension.
PastDue
(out) Your account is past due.

See GetAccount.

SellerFeeDiscount SellerFeeDiscountDashboardType Conditionally Provides information about the PowerSeller discount level you have earned, if any. As a PowerSeller, you can earn discounts on your monthly invoice Final Value Fees based on how well you're rated as a seller. Only returned for members of the eBay US or Canada PowerSeller program.

See:
    About Your Seller Dashboard: PowerSeller Discount
    Zum Thema Verkaeufer-Cockpit: PowerSeller-Rabatt

SellerFeeDiscount.Percent float Conditionally PowerSeller discount as a percentage. For example, a 5% discount is returned as 0.05.
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) Request processing failed
Success
(out) Request processing succeeded
Warning
(out) Request processing completed with warning information being included in the response message

(Not all values in AckCodeType apply to this field.)
Build string Always This refers to the specific 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 Most Trading API calls support a MessageID element in the request and a CorrelationID element in the response. If you pass in a MessageID in a request, the same value will be returned in the CorrelationID field in the response. Pairing these values can help you track and confirm that a response is returned for every request and to match specific responses to specific requests. If you do not pass a MessageID value in the request, CorrelationID is not returned.

Note: GetCategories is designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, the MessageID and CorrelationID fields aren't applicable. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, MessageID and CorrelationID are applicable.
Errors ErrorType Conditionally,
repeatable: [0..*]
A list of application-level errors (if any) that occurred when eBay processed the request.

See Error Handling.

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.

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 the "Errors by Number" document.
Errors.ErrorParameters ErrorParameterType Conditionally,
repeatable: [0..*]
This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters
  [ attribute ParamID ]
string Conditionally This optional element carries a list of context-specific error variables that indicate details about the error condition. These are useful when multiple instances of ErrorType are returned.
Errors.ErrorParameters.Value string Conditionally The value of the variable (e.g., the attribute set ID)
Errors.LongMessage string Conditionally A more detailed description of the condition that raised the error.
Errors.SeverityCode SeverityCodeType Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user.

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.

If the source of the problem is within the application (such as a missing required element), 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, 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.


See the Compatible Application Check section of the eBay Features Guide for more information.
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.

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.

Errors.ShortMessage string Conditionally A brief description of the condition that raised the error.
HardExpirationWarning string Conditionally Expiration date of the user's authentication token. Only returned within the 7-day period prior to a token's expiration. To ensure that user authentication tokens are secure and to help avoid a user's token being compromised, tokens have a limited life span. A token is only valid for a period of time (set by eBay). After this amount of time has passed, the token expires and must be replaced with a new token.
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 Time Values section in the eBay Features Guide for information about this time format and converting to and from the GMT time zone.

Note: GetCategories and other Trading API calls are designed to retrieve very large sets of metadata that change once a day or less often. To improve performance, these calls return cached responses when you request all available data (with no filters). When this occurs, this time value reflects the time the cached response was created. Thus, this value is not necessarily when the request was processed. However, if you specify an input filter to reduce the amount of data returned, the calls retrieve the latest data (not cached). When this occurs, this time value does reflect when the request was processed.
Version string Always The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. See the Standard Data for All Calls section in the eBay Features Guide for information on using the response version when troubleshooting CustomCode values that appear in the response.



Back to top

Detail Controls


DetailLevel

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



Back to top

Samples

New to making API calls? Please see Routing the Request.

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.

Sample: Basic Call

Gets all available Seller Dashboard information for the user who is making the request.

Description

The user named magicalbookseller has been successful at selling a lot of books. Now she wants to know if her PowerSeller status has changed and how high her listings are being placed in search results that are sorted by Best Match.

Input

As this sample shows, you only need to pass in the seller's user token.

As magicalbookseller is a PowerSeller in good standing with plenty of detailed seller ratings, she is eligible to retrieve her Seller Dashboard information.

XML format (HTTP POST). Also available are the .txt version of this XML.

<?xml version="1.0" encoding="utf-8"?>
<GetSellerDashboardRequest xmlns="urn:ebay:apis:eBLBaseComponents">
  <RequesterCredentials>
    <eBayAuthToken>ABC...123</eBayAuthToken>
  </RequesterCredentials>
</GetSellerDashboardRequest>

Output

The response returns all of magicalbookseller's Seller Dashboard information. As she is interested in her PowerSeller status, she's delighted to see that her tier has been upgraded to Gold, as shown in the PowerSellerStatus.Level field.

Unfortunately, when she checks the SearchStanding.Status field, she discovers that her search standing is lowered. As there is no alert to explain why this happened, she should check her detailed seller ratings (using the eBay site or the GetFeedback call). She can also review eBay's tips on how to improve detailed seller ratings, and make sure she is adhering to eBay's policies.

XML format.
<?xml version="1.0" encoding="utf-8"?>
<GetSellerDashboardResponse xmlns="urn:ebay:apis:eBLBaseComponents">
  <Timestamp>2008-05-01T06:22:13.909Z</Timestamp>
  <Ack>Success</Ack>
  <Version>563</Version>
  <Build>e563_core_Bundled_6525779_R1</Build>
  <SearchStanding>
    <Status>Lowered</Status>
  </SearchStanding>
  <SellerFeeDiscount>
    <Percent>0.05</Percent>
  </SellerFeeDiscount>
  <PowerSellerStatus>
    <Level>Gold</Level>
    <Alert>
      <Severity>Informational</Severity>
      <Text>Congratulations! Your PowerSeller level increased this month.</Text>
    </Alert>
  </PowerSellerStatus>
  <PolicyCompliance>
    <Status>Good</Status>
  </PolicyCompliance>
  <BuyerSatisfaction>
    <Status>Good</Status>
  </BuyerSatisfaction>
  <SellerAccount>
    <Status>Current</Status>
  </SellerAccount>
</GetSellerDashboardResponse>



Back to top

Change History

Version Description
897
2014-10-21
  • SiteCodeType (modified): 'Russia' added as enumeration value to support selling on the new Russia site.
635
2009-09-16
  • Performance (added): Your seller performance status is now returned for the following eBay regions: US, UK/Ireland, and Germany/Switzerland/Austria. Your seller status can be either TopRated, AboveStandard, Standard, or BelowStandard. The seller status is returned in a Performance container along with any alerts that might have been issued to the authenticated seller. Alerts can be either a warning or informational in nature.
605
2009-02-18
  • BuyerSatisfactionStatusCodeType (modified): Excellent and VeryPoor have been added and NeedsWork has been deprecated.



Back to top

User-Contributed Notes