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

Call Index Field Index Enumeration Index Type Index Errors by Number Input Output Samples Change History User Notes

createDSRSummaryByCategory

Creates a Detailed Seller Ratings (DSR) summary report based on the category or categories items were listed in and a date range. Specified categories can be either leaf categories or parent categories. Date range can be by transaction end date or by listing date

See also the reference documentation for this call:

• getDSRSummary - Retrieves a specific type of DSR report which can be filtered by Transaction, Period, Category, or Shipping Details.

Back to top

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

<?xml version="1.0" encoding="utf-8"?>
<createDSRSummaryByCategoryRequestnull">
  <!-- Call-specific Input Fields -->
  <categoryId> string </categoryId>
  <!-- ... more categoryId values allowed here ... -->
  <dateRange> DateRange
    <dateFrom> dateTime </dateFrom>
    <dateTo> dateTime </dateTo>
  </dateRange>
  <dateRangeEventType> token </dateRangeEventType>
</createDSRSummaryByCategoryRequest>

Back to top

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

<?xml version="1.0" encoding="utf-8"?>
<createDSRSummaryResponsenull">
  <!-- Call-specific Output Fields -->
  <jobId> string </jobId>
  <!-- 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 values allowed here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes allowed here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
</createDSRSummaryResponse>

Back to top

createDSRSummaryByCategory Samples

New to making API calls? Please see Making an API Call.

Note: Some data in these samples might no longer be active. If necessary, you can substitute current data in your requests.

Creates a DSR summary report for a specific time period based upon the category in which the sold items were listed.

Description

User magicalbookseller has been listing some books in the Wholesale & Bulk Lots category. She wants to know how the DSR scores left for books listed in this category compare to DSRs for books listed in other categories, such as Fiction Books or Children's Books. For comparison purposes, she is going to use a standard date range, the month of January.

Input

The categoryId field specifies that only transactions for items listed in the specified category (29399) will be considered for aggregating DSR scores.

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

<?xml version="1.0" encoding="UTF-8"?>
<createDSRSummaryByCategoryRequest xmlns="http://www.ebay.com/marketplace/services">
  <dateRange>
    <dateFrom>2009-01-01</dateFrom>
    <dateTo>2009-01-31</dateTo>
  </dateRange>
  <dateRangeEventType>TransactionEndDate</dateRangeEventType>
  <categoryId>29399</categoryId>
</createDSRSummaryByCategoryRequest>

Output

The response includes a jobId, which is used with the getSummaryReport call to retrieve the DSR summary report when it is ready. Most reports are ready within an hour of sending the requests to create them.

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

<createDSRSummaryResponse 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-18T22:37:44.142Z</timestamp>
  <jobId>68352539771487201092</jobId>
</createDSRSummaryResponse>

Back to top

createDSRSummaryByCategory Change History

Back to top

User-Contributed Notes

Copyright © 2009–2012 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developer Network and API License Agreement.