DownloadFileRequest
Downloads a file (typically a report) from eBay.

Using downloadFile with the Bulk Data Exchange API

If you are using Large Merchant Services, the most common uses of this call are to download responses to large-volume requests and to download reports.

After you have uploaded a data file that includes requests (such as multiple AddFixedPriceItem requests), you need to use the BDX getStatus call to determine when a response file is ready to download. After the BDX upload processing is complete, you call downloadFile to retrieve the response.

To get a report, you begin by using the Bulk Data Exchange API's startDownloadJob call, and then use startDownloadJob to start the report processing.

The Bulk Data Exchange API assigns a jobId for your report and you need to use the BDX getStatus call to determine when the report is ready to download. After the BDX download processing is complete, your application can call downloadFile to download the report.

Using downloadFile for Custom Item Specifics

You can also use downloadFile to download recommendations for custom Item Specifics. This is a very large data set that can't be retrieved through a more traditional synchronous call.

You do not use the Bulk Data Exchange API at all for this use case. (You also do not use uploadFile.) Instead, you call GetCategorySpecifics in the Trading API to obtain the necessary file and task reference IDs, and then pass them in the downloadFile call to retrieve the recommendations file. See GetCategorySpecifics for details.

Fields
fileReferenceId ( string ) [1]
A unique Id assigned to a file. For example, the Bulk Data Exchange API assigns this ID to a file when startDownloadJob is called and then it creates the file.
lt;br> Pass the fileReferenceId into a File Transfer service downloadFile call. The File Transfer API uses this identifier to keep track of the files that are downloaded.
See the Field Index to learn which calls use fileReferenceId.

taskReferenceId ( string ) [1]
This is ID is determimed by a service (or API) that interacts with the File Transfer API.

For instance, the Bulk Data Exchange API uses a job ID as a primary identifier, so, if you're using the Bulk Data Exchange API, enter the job ID as the taskReferenceId.
See the Field Index to learn which calls use taskReferenceId.

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.