eBay Trading API
|
Retrieves a brief summary of the requester's status as an eBay seller. (The requester is the user identified by the user token you pass in the request.)
This status information can help an eBay seller monitor their selling performance and keep their account in good standing.
To be eligible to view their 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.
The Seller Dashboard does not return the correct data in the Sandbox. Test this call in production 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:
| Output Detail Controls Samples Change History Top Errors for GetSellerDashboard |
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"> <!-- Standard Input Fields --> <ErrorLanguage> string </ErrorLanguage> <MessageID> string </MessageID> <Version> string </Version> <WarningLevel> WarningLevelCodeType </WarningLevel> </GetSellerDashboardRequest>
| Argument | Type | Occurrence | Meaning |
|---|
| 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 ----- ----- de_AT Austria de_CH Switzerland de_DE Germany en_AU Australia en_CA Canada en_GB United Kingdom en_SG Singapore en_US United States es_ES Spain fr_BE Belgium (French) fr_CA Canada (French) fr_FR France it_IT Italy nl_BE Belgium (Dutch) nl_NL Netherlands zh_CN China en_IN India en_IE Ireland zh_HK Hong Kong |
| MessageID | string | Optional |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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., 549). 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:
|
| 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 in your production code. 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. |
| Input Detail Controls Samples Change History Top Errors for GetSellerDashboard |
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).
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"?>
<GetSellerDashboardResponse xmlns="urn:ebay:apis:eBLBaseComponents">
<!-- 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 here ... -->
<LongMessage> string </LongMessage>
<SeverityCode> SeverityCodeType </SeverityCode>
<ShortMessage> string </ShortMessage>
</Errors>
<!-- ... more Errors nodes here ... -->
<HardExpirationWarning> string </HardExpirationWarning>
<Timestamp> dateTime </Timestamp>
<Version> string </Version>
<!-- Call-specific Output Fields -->
<BuyerSatisfaction> BuyerSatisfactionDashboardType
<Alert> SellerDashboardAlertType
<Severity> SellerDashboardAlertSeverityCodeType </Severity>
<Text> string </Text>
</Alert>
<!-- ... more Alert nodes here ... -->
<Status> BuyerSatisfactionStatusCodeType </Status>
</BuyerSatisfaction>
<Performance> PerformanceDashboardType
<Alert> SellerDashboardAlertType
<Severity> SellerDashboardAlertSeverityCodeType </Severity>
<Text> string </Text>
</Alert>
<Site> SiteCodeType </Site>
<!-- ... more Site nodes here ... -->
<Status> PerformanceStatusCodeType </Status>
</Performance>
<!-- ... more Performance nodes here ... -->
<PolicyCompliance> PolicyComplianceDashboardType
<Alert> SellerDashboardAlertType
<Severity> SellerDashboardAlertSeverityCodeType </Severity>
<Text> string </Text>
</Alert>
<!-- ... more Alert nodes here ... -->
<Status> PolicyComplianceStatusCodeType </Status>
</PolicyCompliance>
<PowerSellerStatus> PowerSellerDashboardType
<Alert> SellerDashboardAlertType
<Severity> SellerDashboardAlertSeverityCodeType </Severity>
<Text> string </Text>
</Alert>
<!-- ... more Alert nodes 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 here ... -->
<Status> SellerAccountStatusCodeType </Status>
</SellerAccount>
<SellerFeeDiscount> SellerFeeDiscountDashboardType
<Percent> float </Percent>
</SellerFeeDiscount>
</GetSellerDashboardResponse>
| Return Value | Type | Occurrence | Meaning |
|---|
| Standard Output Fields [Jump to call-specific 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 Ack.
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 |
In most cases, all calls support a MessageID element in the request and a CorrelationID element in the response. If you pass a message ID in a request, we will return the same value in CorrelationID in the response. You can use this for tracking that a response is returned for every request and to match particular responses to particular requests. If you do not pass MessageID in the request, CorrelationID is not returned. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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, 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 | The index of the parameter in the list of parameter types returned within the error type. |
| 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) Application-level error • Warning (out) Warning or informational error |
| 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 Time Values in the eBay Web Services guide for information about this time format and converting to and from the GMT time zone. Note: GetCategories, GetAttributesCS, GetCategory2CS, GetAttributesXSL, GetProductFinder, GetProductFinderXSL, and GetProductSearchPage 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 "Standard Data for All Calls" in the eBay Web Services Guide for information on using the response version when troubleshooting "CustomCode" values that appear in the response. |
| Call-specific Output Fields | |||
| BuyerSatisfaction | BuyerSatisfactionDashboardType | Always |
Rates your level of customer service. This information helps you to keep track of how well you are providing members with positive buying experiences.
See:
|
| BuyerSatisfaction.Alert | SellerDashboardAlertType | Conditionally,
repeatable: [0..*] |
A message to help you understand your buyer satisfaction status. Not returned if there are no existing alerts. |
|
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. • StrongWarning (out) The alert message is a strong warning that indicates a serious problem. • Warning (out) The alert message is a warning that identifies a problem. |
| 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 |
Your buyer satisfaction rating, as a qualitative summary. 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:
|
| Performance.Alert | SellerDashboardAlertType | Conditionally | An informational or warning message pertaining to the seller. Alerts can be issued to denote seller status changes, account standings, or other types of messages related to the account. This field is returned only if the seller has been issued an alert on the respective eBay site. |
| 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. • StrongWarning (out) The alert message is a strong warning that indicates a serious problem. • Warning (out) The alert message is a warning that identifies a problem. |
| 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) to which the associated performance status relates. A performance status is returned 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 |
Performance rating of the seller for the associated eBay region. A rating is given for all regions, even if the seller has not sold to all regions. Default values are as follows: US = AboveStandard; UK/Ireland = Standard, Germany/Switzerland/Austria = Standard. 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. |
| PolicyCompliance | PolicyComplianceDashboardType | Always |
Rating on how well you are following eBay rules and policies in your selling practices, and alerts you if your account or listings have any policy violations. eBay's policies and rules are guidelines that help to create a safe, fair, and enjoyable trading environment for all eBay members. If you violate certain policies, your account can be restricted without notice. This is true even if your status shows a good level of policy compliance. Because of this, understanding and following eBay's policies can help you to avoid restrictions on your account. Policy compliance directly affects your PowerSeller status. See:
|
| PolicyCompliance.Alert | SellerDashboardAlertType | Conditionally,
repeatable: [0..*] |
A message to help you understand your eBay policy compliance status. |
|
PolicyCompliance.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. • StrongWarning (out) The alert message is a strong warning that indicates a serious problem. • Warning (out) The alert message is a warning that identifies a problem. |
| PolicyCompliance.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. |
| PolicyCompliance.Status | PolicyComplianceStatusCodeType | Always |
Rating on how well you are following eBay's selling policies.
Applicable values: • CustomCode (out) Reserved for internal or future use. • Failing (out) You need to increase your compliance with the eBay selling policies and rules immediately. Your account is at risk and may be suspended. • Fair (out) You could do a better job of following eBay policies and you are at risk of having your listings canceled. • Good (out) You're doing a good job of selling and are in line with eBay policies. • Poor (out) You are doing a poor job of following the eBay selling policies and rules. Your selling status and privileges are at risk. |
| 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:
|
| PowerSellerStatus.Alert | SellerDashboardAlertType | Conditionally,
repeatable: [0..*] |
A message to help you understand your PowerSeller status. If you have policy violations, it is a good idea to check to see the policies you violated and to take steps to improve your selling practices. Violations can result in listing cancellations, restrictions on your account, and loss of PowerSeller status and privileges. |
|
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. • StrongWarning (out) The alert message is a strong warning that indicates a serious problem. • Warning (out) The alert message is a warning that identifies a problem. |
| 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 |
Your eBay PowerSeller tier. PowerSellers are distinguished in 5 tiers based on average monthly sales. Benefits and services vary for each tier. eBay calculates eligibility for each tier monthly.
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) |
| SearchStanding | SearchStandingDashboardType | Always |
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.
See:
|
| 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. |
| SellerAccount | SellerAccountDashboardType | Always |
The status of your latest eBay invoice. Includes any alerts issued to your account to help you identify possible problems.
See:
|
| SellerAccount.Alert | SellerDashboardAlertType | Conditionally,
repeatable: [0..*] |
A message to help you understand your account status. Not returned if there are no outstanding alerts. |
| 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. • StrongWarning (out) The alert message is a strong warning that indicates a serious problem. • Warning (out) The alert message is a warning that identifies a problem. |
| 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 |
Indicates your account status. This helps you understand if you are making timely payments or if your account is at risk of restrictions because of late payments. 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:
|
| SellerFeeDiscount.Percent | float | Conditionally | PowerSeller discount as a percentage. For example, a 5% discount is returned as 0.05. |
| Input Output Samples Change History Top Errors for GetSellerDashboard |
This call does not support varying Detail Levels. You do not need to pass DetailLevel in the request.
| Input Output Detail Controls Change History Top Errors for GetSellerDashboard |
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.
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 is the .txt version of this XML. <?xml version="1.0" encoding="utf-8"?> <GetSellerDashboardRequest xmlns="urn:ebay:apis:eBLBaseComponents"> <RequesterCredentials> <eBayAuthToken>YOURTOKENHERE</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. Also available is the .txt version of this XML. <?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>
| Input Output Detail Controls Samples Top Errors for GetSellerDashboard |
| Version | Description |
|---|---|
| 635 2009-09-16 |
|
| 605 2009-02-18 |
|
This document was generated with a customized version of the apireferencedocs tool.
© 2005–2009 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.