Detailed Seller Ratings

This is the base class for all requests. Creates a Detailed Seller Ratings (DSR) summary report based on a specific list of transactions for the seller for which the call is made (and not for any other seller). A transactions is specified as a combination of tem ID and transaction ID. Sellers can use this call to retrieve DSR data for specific types of inventory, such as items associated with a promotional sale or items from a specific manufacturer or supplier. This call provides flexibility. The seller supplies the list of transactions and can determine the list using whatever criteria he wishes.

Creates a seller's DSR summary report for sold items specified with transaction information.

getDSRSummary The transactionKey consists of a combination of an item ID and a transaction ID. This combination uniquely identifies a given transaction. 10,000 10 createDSRSummaryByTransaction Yes 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.

Creates a seller's DSR summary report for sold items based on a date range.

getDSRSummary 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. Note the following restrictions when specifying a date range: <ul> <li>Date ranges cannot be more than 90 days in duration or the call will fail.</li> <li>Date ranges cannot be specified to begin more than 16 months before the current date or the call will fail. </li> <li>When retriiving DSR summary reports for a date range, if there are more than 5,000 transanctions in the time period, only the 5,000 most recent transactions will be processed and a warning will be returned. < /li> </ul> createDSRSummaryByPeriod Yes Type of item event upon which the date range will be based. Date Range Event Types include: <dl> <dt> TransactionEndDate </dt> <dd> The specified date range relates to the date transactions were ended. </dd> <dt> ListingDate </dt> <dd> The specified date range relates to the date items were listed. </dd> </dl> TransactionEndDate createDSRSummaryByPeriod No 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

Creates a seller's DSR summary report for sold items based on the categories they were listed in and a date range.

Creates a seller's DSR summary report for sold items based on shipping details for the items and a date range.

getDSRSummary 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. createDSRSummaryByShippingDetail Yes Type of item event upon which the date range will be based. Date Range Event Types include: <dl> <dt> TransactionEndDate </dt> <dd> The specified date range relates to the date transactions were ended. </dd> <dt> ListingDate </dt> <dd> The specified date range relates to the date items were listed. </dd> </dl> TransactionEndDate createDSRSummaryByShippingDetail No Specifies whether to aggregate DSRs for items for which buyers did not pay any shipping or handling charges or for items for which buyers were charged for shipping and handling. Shipping Cost Types include: <dl> <dt> Free </dt> <dd> Limits DSRs to items for which shipping was provided free of charge. </dd> <dt> Paid </dt> <dd> Limits DSRs to items for which there was a charge for shipping and handling. </dd> </dl> If you don't specify this field, DSRs for items for which buyers did or did not pay shipping and handling charges will be aggregated. createDSRSummaryByShippingDetail No Specifies whether to aggregate DSRs from items with domestic shipping destinatinos or international shipping destinations. Shipping Destination Types include: <dl> <dt> Domestic </dt> <dd> Limits DSRs to items with domestic shipping desstinations. </dd> <dt> International </dt> <dd> Limits DSRs to items with international shipping desstinations. </dd> </dl> If you don't specify this field, DSRs for items shipped to both domestic and international destinations will be aggregated. createDSRSummaryByShippingDetail No Country to which items were shipped. DSRs will be aggregated for items shipped to the specified countries only. Use the two-letter ISO 3166 country code to indicate the country where items were shipped. For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site: <a href="http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html"> http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html</a>. If you don't specify this field, no restriction for specific country shipping destinations applies to the request. 30 createDSRSummaryByShippingDetail No Shipping service used to ship items. You can specify multiple shipping services. DSRs will be aggregated for items that used the specified shipping services only. Use one of the transaction calls in the Trading API, such as <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html">GetSellerTransactions</a> to determine what shipping services buyers selected (e.g., TransactionArray.Transaction.ShippingServiceSelected.ShippingService). Alternatively, use <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GeteBayDetails.html">GeteBayDetails</a> in the Trading API with DetalName set to ShippingServiceDetails to retrieve the currently supported shipping service names. If you don't specify this field, no shipping service restriction applies to the request. 30 createDSRSummaryByShippingDetail No 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: <ul> <li>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. </li> <li>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.</li> </ul>

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

createDSRSummaryByCategory, createDSRSummaryByPeriod, createDSRSummaryByShippingDetail, createDSRSummaryByTransaction Detailed Seller Ratings http://pages.ebay.com/help/feedback/detailed-seller-ratings.html more information about seller DSRs The Request ID for a particular DSR report. 20 getDSRSummary Yes Output for the create calls returns a job ID, which is used as input for the GetDSRSummary call to retrieve the aggregated DSR values. A unique identifier associated with the create report request. The jobId is used as input for the getDSRSummary call to retrieve the requested report. 20 createDSRSummaryByCategory createDSRSummaryByPeriod createDSRSummaryByShippingDetail createDSRSummaryByTransaction Always Returns a specific type of DSR report requested by a seller. The report will include a list of detailed seller ratings for each of the following areas: Item As Described, Communication, Shipping Time, and Shipping Charges. A list of detailed seller ratings for one of the following areas: Item As Described, Communication, Shipping Time, and Shipping Charges. This list includes 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 a particular DSR area. The detailed seller rating system is based on a one-to-five-star scale. Five stars is the highest rating, and one star is the lowest. getDSRSummary Always Each transaction key is specified as a combination of transaction ID and item ID. ID of the listing associated with the transaction for which the seller is collecting DSRs. createDSRSummaryByTransaction Yes Unique identifier for a transaction from the listing indicated by itemId. In the Trading API, you can use <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetItemTransactions.html"> GetItemTransactions</a> or <a href="http://developer.ebay.com/DevZone/XML/docs/Reference/eBay/GetSellerTransactions.html"> GetSellerTransactions</a> to determine the appropriate transaction IDs. 19 (Note: The eBay database specifies 38. Currently, transaction IDs are usually 9 to 12 digits.) createDSRSummaryByTransaction No Date range for collecting DSRs. The date range is associated with either transaction end dates or item listing dates. 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. createDSRSummaryByCategory createDSRSummaryByPeriod createDSRSummaryByShippingDetail Yes 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. createDSRSummaryByCategory createDSRSummaryByPeriod createDSRSummaryByShippingDetail Yes A list of detailed seller ratings for one of the following areas: Item As Described, Communication, Shipping Time, and Shipping Charges. This list includes 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 a particular DSR area. The detailed seller rating system is based on a one-to-five-star scale. Five stars is the highest rating, and one star is the lowest. One of the areas in which a buyer can provide a seller a detailed seller rating. The detailed seller rating system is based on a one-to-five-star scale. Five stars is the highest rating, and one star is the lowest. Applicable values: <dl> <dt>ItemAsDescribed</dt> <dd>Detailed seller ratings on how well the Item Title and Description actually described the item purchased by the buyer. This includes the condition of the item and whether the selling terms of the item were honored or not.</dd> <dt>Communication</dt> <dd>Detailed seller ratings on how promptly and clearly the seller communicated with the buyer during the transaction. This includes how well the seller responded to the buyer's emails and proactively provided order status updates when needed. </dd> <dt>ShippingTime</dt> <dd>Detailed seller ratings on how effectively the seller set clear expectations for shipping time up front in the Item Description. This includes how long it took the seller to mail the item and whether the terms for weekend shipping were clearly specified in the Item Description or not. </dd> <dt>ShippingCharges</dt> <dd>Detailed seller ratings on how appropriate the shipping charges and fees were in relation to the seller's time and direct costs associated with packaging materials, handling, and shipping.</dd> </dl> getDSRSummary Always Average rating for a particular DSR area. The average rating is computed on a rolling 12-month basis and has a value of 1.00 to 5.00 when at least ten ratings have been received. Otherwise, the value is 0.00. getDSRSummary Always The total number of ratings a seller has received for a particular DSR area. getDSRSummary Always The total number of 1-star ratings received by a seller for a particular DSR area. getDSRSummary Always The total number of 2-star ratings received by a seller for a particular DSR area. getDSRSummary Always The total number of 3-star ratings received by a seller for a particular DSR area. getDSRSummary Always The total number of 4-star ratings received by a seller for a particular DSR area. getDSRSummary Always The total number of 5-star ratings received by a seller for a particular DSR area. getDSRSummary Always Base response container for all service operations. Contains error information associated with the request. Indicates whether there are any errors or warnings associated with the processing of the request. Always Information for an error or warning that occurred when eBay processed the request. Not returned when responseStatus is Success. Conditionally 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. Always This value represents the date and time when eBay processed the request. The time zone of this value is <a href="types/simpleTypes.html#dateTime">GMT</a> 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. Always Indicates the status of the call. The request was processed successfully without errors or warnings. Errors occurred that prevented the request from being processed successfully. The request was processed successfully, but some warnings were returned. Reserved for future use. ErrorMessage to indicate any Error/Warning that occured as part of service call. Any run time error will not be reported here, but will be reported as part of a SOAP fault. Details about a single error. Conditionally This represents error details. 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. Conditionally Name of the domain upon which the error occurred. Domains include: <dl> <dt> Marketplace </dt> <dd> A business or validation error occurred for the Feedback Service. </dd> <dt> SOA </dt> <dd> An exception occurred in the Service Oriented Architecture (SOA) framework. </dd> </dl> Conditionally 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. Conditionally There are three categories of errors: request errors, application errors, and system errors. Conditionally A detailed description of the condition that resulted in the error. Conditionally Name of the subdomain upon which the error occurred. Subdomains include: <dl> <dt> Merchandising </dt> <dd> The error is specific to the Feedback service. </dd> <dt> MarketplaceCommon </dt> <dd> The error is common to all Marketplace services. </dd> </dl> Conditionally Unique identifier for an exception associated with an error. Conditionally 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. Conditionally Contextual information associated with an error. The name of the parameter in the list of parameter types returned within the error type. Conditionally Indicates whether the error is a severe error (causing the request to fail) or an informational error (a warning) that should be communicated to the user. 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. There are three categories of error: request errors, application errors, and system errors. Request and application errors are caused primarily by invalid data passed in the request. System errors are caused primarily by application failures and cannot be corrected by changing request values. 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. 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. 1.0.0