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:
Back to top
|Output Samples Change History User Notes|
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>
DSR summary report will be based on DSRs left for items that were listed in specified categories only.
Category IDs are site-specific. If a specified category ID doesn't match an existing category for the site, an invalid-category warning message is returned. To determine valid categories, you can use either the Shopping API or the Trading API. In the Shopping API, use the FindItemsAdvanced call with the CategoryHistogram value in the IncludeSelector field to retrieve matching category information. In the Trading API, use calls like GetCategories and GetCategoryFeatures to determine valid values for the site.
If you specify more than 30 categories, only the first 30 will be used.
Specifies the time period used for collecting DSR data for purchased items. The time period applies to either the end date of the item transaction or the date the item was listed.
The date range must not exceed 90 days and must not start more than 16 months before the current date.
|dateRange.dateFrom||dateTime||Required||The starting point of the date range. DSRs will be aggregated for items with the specified date range event (transaction end date or listing date) on or after the dateFrom value and before or on the dateTo value.|
|dateRange.dateTo||dateTime||Required||The end point of the date range. DSRs will be aggregated for items with the specified date range event (transaction end date or listing date) on or after the dateFrom value and before or on the dateTo value.|
Type of item event upon which the date range will be based.
Date Range Event Types include:
Back to top
|Input Samples Change History User Notes|
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>
|Call-specific Output Fields [Jump to standard fields]|
A unique identifier associated with the create report request. The jobId is used as input for the getDSRSummary call to retrieve the requested report.
Max length: 20.
|Standard Output Fields|
Indicates whether there are any errors or warnings associated with the processing of the request.
Errors occurred that prevented the request from being processed successfully.
Reserved for future use.
The request was processed successfully without errors or warnings.
The request was processed successfully, but some warnings were returned.
|errorMessage||ErrorMessage||Conditionally||Information for an error or warning that occurred when eBay processed the request. Not returned when responseStatus is Success.|
|Details about a single error.|
There are three categories of errors: request errors, application errors, and system errors.
An error occurred due to a problem with the request, such as missing or invalid fields. 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. Once the problem in the application or data is resolved, resend the corrected request to eBay.
An error occurred due to a problem with the request, such as invalid or missing data. The problem must be corrected before the request can be made again. 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 data is resolved, resend the request to eBay with the corrected data.
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.
Name of the domain upon which the error occurred.
|errorMessage.error.errorId||long||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.|
|errorMessage.error.exceptionId||token||Conditionally||Unique identifier for an exception associated with an error.|
|errorMessage.error.message||string||Conditionally||A detailed description of the condition that resulted in the error.|
|Some warning and error messages return one or more variables that contain contextual information about the error. This is often the field or value that triggered the error.|
[ attribute name ]
|string||Conditionally||The name of the parameter in the list of parameter types returned within the error type.|
Indicates whether the error caused the request to fail (Error) or not (Warning).
If the request fails and the source of the problem is within the application (such as a missing required element), please change the application before you retry the request. If the problem is due to end-user input data, please alert the end-user to the problem and provide the means for them to correct the data. Once the problem in the application or data is resolved, you can attempt to re- send the request to eBay.
If the source of the problem is on eBay's side, you 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.
When a warning occurs, the error is returned in addition to the business data. In this case, you do not need to retry the request (as the original request was successful). However, depending on the cause or nature of the warning, you might need to contact either the end user or eBay to effect a long term solution to the problem to prevent it from reoccurring in the future.
The request that triggered the error was not processed successfully. When a serious application-level error occurs, the error is returned instead of the business data.
The request was processed successfully, but something occurred that may affect your application or the user. For example, eBay may have changed a value the user sent in. In this case, eBay returns a normal, successful response and also returns the warning.
Name of the subdomain upon which the error occurred.
|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 the "dateTime" type for information about this time format and converting to and from the GMT time zone.|
|version||string||Always||The version of the response payload schema. Indicates the version of the schema that eBay used to process the request. Developer Technical Support may ask you for the version value when you work with them to troubleshoot issues.|
Back to top
|Input Output Change History User Notes|
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.
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.
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>
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
|Input Output Samples User Notes|
Back to top
|Input Output Samples Change History User 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.