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.

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"?>
<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>

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"?>
<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>

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.

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

Description

The user named m***************r 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 m***************r is a PowerSeller in good standing with plenty of detailed seller ratings, she is eligible to retrieve her Seller Dashboard information.

XML format.

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

Output

The response returns all of m***************r'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>2019-11-04T22:49:49.284Z</Timestamp>
  <Ack>Success</Ack>
  <Version>1131</Version>
  <Build>E1131_CORE_APISELLING_19099826_R1</Build>
  <SellerFeeDiscount>
    <Percent>0.0</Percent>
  </SellerFeeDiscount>
  <PowerSellerStatus>
    <Level>None</Level>
  </PowerSellerStatus>
  <SellerAccount>
    <Status>Current</Status>
    <Alert>
      <Severity>Informational</Severity>
      <Text>See the new notice about your payment by visiting Seller Dashboard on eBay web site.</Text>
    </Alert>
  </SellerAccount>
  <Performance>
    <Site>US</Site>
    <Status>AboveStandard</Status>
  </Performance>
  <Performance>
    <Site>UK</Site>
    <Site>Ireland</Site>
    <Status>AboveStandard</Status>
  </Performance>
  <Performance>
    <Site>Germany</Site>
    <Site>Austria</Site>
    <Site>Switzerland</Site>
    <Status>AboveStandard</Status>
  </Performance>
</GetSellerDashboardResponse>

Change History