eBay Feedback API Call Reference Version 1.0.1 Support     Knowledge Base     Forums     All Tutorials     All Code Samples Users Guide Call Reference Making an API Call Tutorials Release Notes

List of All Calls Field Index Enumeration Index Type Index Errors by Number Input Output Samples Change History User Notes

Retrieves a specific type of Detailed Seller Rating (DSR) report which will help a seller to determine what is contributing to lower or higher DSR scores.

A seller can request a report filtered by Transaction, Period, Category, or Shipping Details.

Input is a Request ID for a particular DSR report. Output consists of a DSR average, the total number of ratings received, and a count for each of the one-to-five star ratings received by a seller for each of the following areas: Item As Described, Communication, Shipping Time, and Shipping Charges.

Note the following details for retrieving summary reports:

• Reports typically take 1 hour or less to generate and will take no longer than a day to create. If you attempt to retrieve a report before it is ready, the request will fail and the error message will indicate you should try again in an hour.
• Reports will be held up to 7 days after being generated. The report can be retrieved multiple times during that period. If you do not download a report within 7 days, you must regenerate the report.

See Detailed Seller Ratings for more information about seller DSRs.

Related calls:

• createDSRSummaryByCategory - Creates a seller's DSR summary report for sold items based on the categories they were listed in and a date range.
• createDSRSummaryByPeriod - Creates a seller's DSR summary report for sold items based on a date range.
• createDSRSummaryByShippingDetail - Creates a seller's DSR summary report for sold items based on shipping details for the items and a date range.
• createDSRSummaryByTransaction - Creates a seller's DSR summary report for sold items specified with transaction information.

Back to top

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.

<?xml version="1.0" encoding="utf-8"?>
<getDSRSummaryRequest xmlns="http://www.ebay.com/marketplace/services">
  <jobId> string </jobId>
</getDSRSummaryRequest>

Back to top

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.

<?xml version="1.0" encoding="utf-8"?>
<getDSRSummaryResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- Standard Output Fields -->
  <ack> AckValue </ack>
  <errorMessage> ErrorMessage 
    <error> ErrorData 
      <category> ErrorCategory </category>
      <domain> string </domain>
      <errorId> long </errorId>
      <exceptionId> token </exceptionId>
      <message> string </message>
      <parameter name="string"> ErrorParameter (string) </parameter>
      <!-- ... more parameter nodes here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <DSRSummary> DSRSummary 
    <DSRAverage> double </DSRAverage>
    <DSRType> token </DSRType>
    <rating1Count> int </rating1Count>
    <rating2Count> int </rating2Count>
    <rating3Count> int </rating3Count>
    <rating4Count> int </rating4Count>
    <rating5Count> int </rating5Count>
    <totalRatingCount> int </totalRatingCount>
  </DSRSummary>
  <!-- ... more DSRSummary nodes here ... -->
</getDSRSummaryResponse>

Back to top

New to making API calls? Please see Making an API 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 a DSR summary report that has been previously created.

Description

User magicalbookseller has created a DSR summary report for transactions that ended in the fourth quarter of 2008. She wants to review DSR scores to determine what areas of her business model could use improvement. She must have sent the request to create the report at least an hour earlier.

User magicalbookseller will compare the scores with scores for related criteria. For example, since the report was created for a specific time period, she might compare the report with a report created for the same time period of the previous year.

If the report is not ready, the request will fail. The error message recommends the user try again in an hour.

Input

The only input for this call is jobId, which specifies the report to retrieve.

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

<?xml version="1.0" encoding="UTF-8"?>
<getDSRSummaryRequest xmlns="http://www.ebay.com/marketplace/services">
  <jobId>42374300864923356090</jobId>
</getDSRSummaryRequest>

Output

The response has data for each DSR category. The DSRType indicates the DSR category, ItemAsDescribed, Communication, ShippingTime, and ShippingCharge. The DSRAverage value is critical for compliance with the Seller Performance Policy.

See the following eBay Help pages for more information about DSRs and how they affect sellers:

• Detailed Seller Ratings provides an overview of DSRs.
• Seller Performance Policy provides information about how DSRs figure in to the Seller Performance Policy.

XML format. Also available are the .txt version of this XML and the SOAP equivalent.

<getDSRSummaryResponse xmlns:sct="http://www.ebay.com/soaframework/common/types" xmlns="http://www.ebay.com/marketplace/services">
  <ack>Success</ack>
  <version>1.0.0</version>
  <timestamp>2009-02-16T00:47:41.160Z</timestamp>
  <DSRSummary>
    <DSRType>ItemAsDescribed</DSRType>
    <DSRAverage>4.72</DSRAverage>
    <totalRatingCount>542</totalRatingCount>
    <rating1Count>0</rating1Count>
    <rating2Count>0</rating2Count>
    <rating3Count>27</rating3Count>
    <rating4Count>100</rating4Count>
    <rating5Count>415</rating5Count>
  </DSRSummary>
  <DSRSummary>
    <DSRType>Communication</DSRType>
    <DSRAverage>4.65</DSRAverage>
    <totalRatingCount>542</totalRatingCount>
    <rating1Count>0</rating1Count>
    <rating2Count>0</rating2Count>
    <rating3Count>45</rating3Count>
    <rating4Count>98</rating4Count>
    <rating5Count>399</rating5Count>
  </DSRSummary>
  <DSRSummary>
    <DSRType>ShippingTime</DSRType>
    <DSRAverage>4.16</DSRAverage>
    <totalRatingCount>542</totalRatingCount>
    <rating1Count>1</rating1Count>
    <rating2Count>1</rating2Count>
    <rating3Count>23</rating3Count>
    <rating4Count>400</rating4Count>
    <rating5Count>117</rating5Count>
  </DSRSummary>
  <DSRSummary>
    <DSRType>ShippingCharge</DSRType>
    <DSRAverage>4.31</DSRAverage>
    <totalRatingCount>542</totalRatingCount>
    <rating1Count>0</rating1Count>
    <rating2Count>0</rating2Count>
    <rating3Count>17</rating3Count>
    <rating4Count>340</rating4Count>
    <rating5Count>185</rating5Count>
  </DSRSummary>
</getDSRSummaryResponse>

Back to top

Back to top

This document was generated with a customized version of the apireferencedocs tool [0.5M zip].

© 2009 eBay, Inc. All rights reserved.