createDSRSummaryByShippingDetail

Creates a Detailed Seller Ratings (DSR) summary report based the shipping information associated with items and a date range. Shipping information consists of the shipping cost type (Free or Paid), the shipping destination (Domestic or International), the countries to which items were shipped, and the shipping services used. 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.

createDSRSummaryByShippingDetail 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"?>
<createDSRSummaryByShippingDetailRequestnull">
  <!-- Call-specific Input Fields -->
  <dateRange> DateRange
    <dateFrom> dateTime </dateFrom>
    <dateTo> dateTime </dateTo>
  </dateRange>
  <dateRangeEventType> token </dateRangeEventType>
  <shippingCostType> token </shippingCostType>
  <shippingDestinationType> token </shippingDestinationType>
  <shippingService> token </shippingService>
  <!-- ... more shippingService values allowed here ... -->
  <shipToCountry> token </shipToCountry>
  <!-- ... more shipToCountry values allowed here ... -->
</createDSRSummaryByShippingDetailRequest>

Argument	Type	Occurrence	Meaning

dateRange	DateRange	Required	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.
dateRangeEventType	token	Optional	Type of item event upon which the date range will be based. Date Range Event Types include: TransactionEndDate The specified date range relates to the date transactions were ended. ListingDate The specified date range relates to the date items were listed. Default: TransactionEndDate.
shippingCostType	token	Optional	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: Free Limits DSRs to items for which shipping was provided free of charge. Paid Limits DSRs to items for which there was a charge for shipping and handling. 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.
shippingDestinationType	token	Optional	Specifies whether to aggregate DSRs from items with domestic shipping destinatinos or international shipping destinations. Shipping Destination Types include: Domestic Limits DSRs to items with domestic shipping desstinations. International Limits DSRs to items with international shipping desstinations. If you don't specify this field, DSRs for items shipped to both domestic and international destinations will be aggregated.
shippingService	token	Optional, repeatable: [0..30]	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 GetSellerTransactions to determine what shipping services buyers selected (e.g., TransactionArray.Transaction.ShippingServiceSelected.ShippingService). Alternatively, use GeteBayDetails 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.
shipToCountry	token	Optional, repeatable: [0..30]	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: http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html. If you don't specify this field, no restriction for specific country shipping destinations applies to the request.

createDSRSummaryByShippingDetail 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>

Return Value	Type	Occurrence	Meaning

Call-specific Output Fields [Jump to standard fields]

jobId

string

Always

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

ack	AckValue	Always	Indicates whether there are any errors or warnings associated with the processing of the request. Applicable values: • Failure Errors occurred that prevented the request from being processed successfully. • PartialFailure Reserved for future use. • Success The request was processed successfully without errors or warnings. • Warning 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.
errorMessage.error	ErrorData	Conditionally, repeatable: [0..*]	Details about a single error.
errorMessage.error.category	ErrorCategory	Conditionally	There are three categories of errors: request errors, application errors, and system errors. Applicable values: • Application 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. • Request 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. • System 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.
errorMessage.error.domain	string	Conditionally	Name of the domain upon which the error occurred. Domains include: Marketplace A business or validation error occurred for the Feedback Service. SOA An exception occurred in the Service Oriented Architecture (SOA) framework.
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.
errorMessage.error.parameter	ErrorParameter (string)	Conditionally, repeatable: [0..*]	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.
errorMessage.error.parameter [ attribute name ]	string	Conditionally	The name of the parameter in the list of parameter types returned within the error type.
errorMessage.error.severity	ErrorSeverity	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. Applicable values: • Error 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. • Warning 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.
errorMessage.error.subdomain	string	Conditionally	Name of the subdomain upon which the error occurred. Subdomains include: Merchandising The error is specific to the Feedback service. MarketplaceCommon The error is common to all Marketplace services.
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.

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

Sample: Basic Call

Creates a DSR summary report for transactions for items for which shipping or handling was free.

Description

User magicalbookseller has been offering free shipping on many of her listings. She wants to know how the DSR scores for items with no shipping or handling charges compare with items that buyers were required to pay for shipping and handling. This sample shows how she can create a report for transactions in which buyers paid no shipping or handling charges.

Input

The shippingCostType value, Free, specifies that the DSR summary report should be based on transactions for items for which buyers paid no shipping or handling charges.

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

<?xml version="1.0" encoding="UTF-8"?>
<createDSRSummaryByShippingDetailRequest xmlns="http://www.ebay.com/marketplace/services">
  <dateRange>
    <dateFrom>2009-01-12T20:15:01.645Z</dateFrom>
    <dateTo>2009-02-12T20:15:01.645Z</dateTo>
  </dateRange>
  <dateRangeEventType>TransactionEndDate</dateRangeEventType>
  <shippingCostType>Free</shippingCostType>
</createDSRSummaryByShippingDetailRequest>

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-12T20:35:30.574Z</timestamp>
  <jobId>15391754781043436153</jobId>
</createDSRSummaryResponse>

createDSRSummaryByShippingDetail Change History

Version	Description
1.2.2 2010-08-30	shipToCountry, shippingDestinationType (modified): The definitions for these fields have changed. Formerly, the fields referred to the "ship to" country. Now, the fields refer to buyer country-of-residence. For the current definitions, see the field descriptions above. Additionally, 3 new values (US, UK, and DE) can be used in the shippingDestinationType input field.
1.0.1 2009-06-24	timestamp (modified): Datatype changed from xs:date to xs:dateTime.
1.0.0 2009-02-04	(added) New call

User-Contributed Notes