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

createDSRSummaryByPeriod

Creates a Detailed Seller Ratings (DSR) summary report based on a date range. The date range is based on either transaction end dates or listing dates.

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

createDSRSummaryByPeriod 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"?>
<createDSRSummaryByPeriodRequestnull">
  <!-- Call-specific Input Fields -->
  <dateRange> DateRange
    <dateFrom> dateTime </dateFrom>
    <dateTo> dateTime </dateTo>
  </dateRange>
  <dateRangeEventType> token </dateRangeEventType>
</createDSRSummaryByPeriodRequest>

Back to top

createDSRSummaryByPeriod 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

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

Description

User magicalbookseller has had a steady increase in sales over time and wants to understand how these changes have been affecting her DSRs. She wants to know how the DSR scores for items sold in December of 2008 compare to items sold the previous month or the same month the previous year. This sample illustrates how to request a DSR summary report for December 2008.

Input

The dateRangeEventType value, TransactionEndDate specifies that the date range is based upon when items sold (i.e., transaction end date). The dateFrom and dateTo fields specify the date range.

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

<?xml version="1.0" encoding="UTF-8"?>
<createDSRSummaryByPeriodRequest xmlns="http://www.ebay.com/marketplace/services">
  <dateRange>
    <dateFrom>2008-12-01T00:00:00.000Z</dateFrom>
    <dateTo>2008-12-31T23:59:59.999Z</dateTo>
  </dateRange>
  <dateRangeEventType>ListingDate</dateRangeEventType>
</createDSRSummaryByPeriodRequest>

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:45:48.567Z</timestamp>
  <jobId>73657470931103444722</jobId>
</createDSRSummaryResponse>

Back to top

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