startDownloadJob

Begins processing the data for a report file to download. You must use the getJobStatus or getRecurringJobExecutionStatus calls to determine when the report data is available for download.



Back to top

Input Output Samples Change History User Notes
startDownloadJob 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"?>
<startDownloadJobRequest xmlns="http://www.ebay.com/marketplace/services">
  <downloadJobType> token </downloadJobType>
  <downloadRequestFilter> DownloadRequestFilter
    <activeInventoryReportFilter> ActiveInventoryReportFilter
      <auctionItemDetails> AuctionItemDetails
        <includeBidCount> boolean </includeBidCount>
        <includeReservePriceMet> boolean </includeReservePriceMet>
      </auctionItemDetails>
      <fixedPriceItemDetails> FixedPriceItemDetails
        <includeVariations> boolean </includeVariations>
      </fixedPriceItemDetails>
      <includeListingType> IncludeListingType </includeListingType>
    </activeInventoryReportFilter>
    <dateFilter> DateFilter
      <endTime> dateTime </endTime>
      <startTime> dateTime </startTime>
    </dateFilter>
    <feeSettlementReportFilter> FeeSettlementReportFilter
      <startTime> dateTime </startTime>
    </feeSettlementReportFilter>
    <siteFilter> SiteFilter
      <globalId> token </globalId>
      <!-- ... more globalId nodes here ... -->
    </siteFilter>
  </downloadRequestFilter>
  <recurringJob> boolean </recurringJob>
  <UUID> string </UUID>
</startDownloadJobRequest>
Argument Type Occurrence Meaning
downloadJobType token Required Specifies the report you want to download. Each Bulk Data Exchange job can only have one job type per job. For instance, if you are downloading a SoldReport, it will only have pre-defined SoldReport data within the file.

Applicable values:
ActiveInventoryReport
A report that contains all of the active listings for a specific seller ID. The eBay servers read the credential information passed in by the seller's application to determine which seller's data to retrieve.
FeeSettlementReport
A report that contains all of the fees that you have incurred as invoices are generated by the eBay servers. This report gives large merchants the ability to look at their fees for many listings in one file.
SoldReport
Lists all items that have been sold by this seller (sold items that were submitted to the Large Merchant Service by the seller's application).

When an item is sold, the eBay application creates an 'order' for the seller. If only one item is sold, there is one order ID and one line item ID associated with the sale. However, if multiple items are sold as part of the same transaction, there is one order ID for the sale, and multiple line item IDs - one line item ID for each item sold.

Therefore, the Sold Report returns the order IDs and line item IDs for every order associated with the seller who is making the request. Sellers use this information to make inventory updates and start order fulfillment.

When orders have been fulfilled, the seller will probably want to remove them from the list of all orders that comes back every time they receive a SoldReport. To do this, they can acknowledge each order that has been fulfulled (using order ID or line item ID) by uploading a list of the fulfulled order information using an OrderAck request.

After you upload a data file with an OrderAck request, the orders (or line items within an order) will no longer appear in the SoldReport. (After you send the first OrderAck call, future SoldReports that you request will only contain unacknowledged orders and line items.)
downloadRequestFilter DownloadRequestFilter Optional Request filter.
downloadRequestFilter
  .activeInventoryReportFilter 		ActiveInventoryReportFilter Optional Specify what needs to be included as part of active inventory report.
downloadRequestFilter
  .activeInventoryReportFilter
  .auctionItemDetails 		AuctionItemDetails Optional Specify filters specific to auction items.
downloadRequestFilter
  .activeInventoryReportFilter
  .auctionItemDetails
  .includeBidCount 		boolean Optional Specify if bid count on the auction needs to be included as part of the report.
downloadRequestFilter
  .activeInventoryReportFilter
  .auctionItemDetails
  .includeReservePriceMet 		boolean Optional Specify if report needs to included if reserve price has been met.
downloadRequestFilter
  .activeInventoryReportFilter
  .fixedPriceItemDetails 		FixedPriceItemDetails Optional Specify filters specific to fixed price items.
downloadRequestFilter
  .activeInventoryReportFilter
  .fixedPriceItemDetails
  .includeVariations 		boolean Optional Specify if variation details are needed to be included as part of the report.
downloadRequestFilter
  .activeInventoryReportFilter
  .includeListingType 		IncludeListingType Optional Specify the type of listing(s) you would like the report to include - Chinese, FixedPriceItem or both.

Applicable values:

•   Auction

(in) Chinese Acution type.

•   AuctionAndFixedPrice

(in) Listing type is chinese Auction or fixed price.

•   FixedPrice

(in) Listing type is fixed price.
downloadRequestFilter
  .dateFilter 		DateFilter Optional Reserved for future use.
downloadRequestFilter
  .dateFilter.endTime 		dateTime Optional Reserved for future use.
downloadRequestFilter
  .dateFilter.startTime 		dateTime Required Reserved for future use.
downloadRequestFilter
  .feeSettlementReportFilter 		FeeSettlementReportFilter Optional Lets you request only the data within specific parameters, such as a date range.
downloadRequestFilter
  .feeSettlementReportFilter
  .startTime 		dateTime Required The start time of the invoice period.

An 'invoice' is the eBay term for the bill that is sent to the seller by the eBay application.

The FeeSettlementReport is based on fees from a given billing cycle for which there is an invoice. The FeeSettlementReport will be generated based on the last available invoice since the specified start time.
downloadRequestFilter
  .siteFilter 		SiteFilter Optional Reserved for future use.
downloadRequestFilter
  .siteFilter.globalId 		token Required,
repeatable: [1..*]		 Reserved for future use.
recurringJob boolean Optional It is an internal tag used to specify whether the download job is started as part of the recurring job request or not.
UUID string Required A Universally Unique Identifier (UUID) provided by the seller's application.



Back to top

Input Output Samples Change History User Notes
startDownloadJob 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"?>
<startDownloadJobResponse xmlns="http://www.ebay.com/marketplace/services">
  <!-- 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 nodes here ... -->
      <severity> ErrorSeverity </severity>
      <subdomain> string </subdomain>
    </error>
    <!-- ... more error nodes here ... -->
  </errorMessage>
  <timestamp> dateTime </timestamp>
  <version> string </version>
  <!-- Call-specific Output Fields -->
  <jobId> string </jobId>
</startDownloadJobResponse>
Return Value Type Occurrence Meaning
Standard Output Fields   [Jump to call-specific fields]
ack AckValue Always Returns the acknowledgement of the call success or failure.

Applicable values:

•   Failure

(out) 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.

•   PartialFailure

(out) Reserved for future use.

•   Success

(out) The request was processed successfully, but something occurred that may affect your application or the user.

•   Warning

(out) The request that triggered the error was processed successfully but with some warnings.
errorMessage ErrorMessage Conditionally Description of an error or warning that occurred when eBay processed the request. Not returned if the ack value 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

(out) 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

(out) 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

(out) 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 Bulk Data Exchange 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 get 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

(out) 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

(out) 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:
BulkDataExchangeService
The error is specific to the BulkDataExchangeService 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. This value is returned in GMT, the ISO 8601 date and time format (YYYY- MM- DDTHH:MM:SS.SSSZ). See the "dateTime" type for information about the time format, and for details on converting to and from the GMT time zone.
version string Always The release version that eBay used to process the request. Developer Technical Support may ask you for the version value if you work with them to troubleshoot issues.

Note: The version in use is normally the latest release version, as specified in the release notes. Note that eBay releases the API to international sites about a week after the API version is released to the US site.
Call-specific Output Fields
jobId string Always Job ID assigned by the Bulk Data Exchange service when startDownloadJobRequest is called. Pass this jobId into a File Transfer service downloadJobRequest.



Back to top

Input Output Samples Change History User Notes
startDownloadJob Samples

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

Note: Some item IDs, user IDs, or other data in these samples might no longer be active on eBay. If necessary, you can substitute current eBay data in your requests.

Sample: Basic Call

Begins the Bulk Data Exchange service processing for data files that you want to download - such as report files.

Description

User megaonlinemerchant wants to start the processing for the data file that contains her SoldReport. After the processing is complete, she will download this file from the eBay servers using the File Transfer service DownloadFile call.

As a result of this call, megaonlinemerchant will begin to monitor the status of the processing, so that she will know when to download the file that contains the SoldReport data.

Input

In the following startDownloadJob request sample, you will see that you only need to enter the job type of the report you want to create and a unique identifier (UUID). 

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

<?xml version="1.0" encoding="utf-8"?>
<startDownloadJobRequest xmlns="http://www.ebay.com/marketplace/services">
   <downloadJobType>SoldReport</downloadJobType>
   <UUID>f7f28d10-83bd-11df-8395-0800200c9a66</UUID>
</startDownloadJobRequest>

Output

The response includes a Success or Failure acknowledgement, the version number of the Bulk Data Exchange service, and a timestamp. It is easy to assume that the startDownloadJob response contains the SoldReport data. Remember that this is not the case - the SoldReport data is in a file that you have to download using the File Transfer service after the processing for this job has completed. 

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

<startDownloadJobResponse xmlns="http://www.ebay.com/marketplace/services">
   <ack>Success</ack>
   <version>1.2.0</version>
   <timestamp>2010-06-29T20:40:05.671Z</timestamp>
   <jobId>50000016056</jobId>
</startDownloadJobResponse>



Back to top

Input Output Samples Change History User Notes
startDownloadJob Change History
Version Description
1.0.0
2008-11-29
  • (added) New call



Back to top

Input Output Samples Change History User Notes
User-Contributed Notes
   
 
 
 

This document was generated with a customized version of the apireferencedocs tool.

© 2008–2010 eBay, Inc. All rights reserved. This documentation and the API may only be used in accordance with the eBay Developers Program and API License Agreement.