feed APIv1.1.0

getResultFile

GET
/task/{task_id}/download_result_file
This method retrieves the generated file that is associated with the specified task ID. Report files are comma-separated value gzip files with a file extension of .csv.gz.

For details about how this method is used, see see Working with Order Feeds in the Selling Integration Guide.

Note: The status of the task to retrieve must be in the COMPLETED or COMPLETED_WITH_ERROR state before this method can retrieve the file. You can use the getTask or getTasks method to retrieve the status of the task.

Input

Resource URI (production)

GET https://api.ebay.com/sell/feed/v1/task/{task_id}/download_result_file

URI parameters

ParameterTypeDescription
task_idstringThe ID of the task associated with the file you want to download. This ID was generated when the task was created.

Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the authorization code grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope/sell.inventory

https://api.ebay.com/oauth/api_scope/sell.fulfillment

https://api.ebay.com/oauth/api_scope/sell.marketing

https://api.ebay.com/oauth/api_scope/commerce.catalog.readonly

https://api.ebay.com/oauth/api_scope/sell.analytics.readonly

See OAuth access tokens for more information.

Output

HTTP response headers

See HTTP response headers for details.

HeaderMeaning
content-dispositionReturns metadata for the downloaded file.

The response of this call is a CSV_GZIP file.

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
403Forbidden
404Not Found
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
160001API_FEEDAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance.
160002API_FEEDREQUESTThe authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes.
160003API_FEEDREQUESTTask {taskID} does not exist.
160014API_FEEDREQUESTNo file found for task ID {taskID}.

Warnings

Samples

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

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Download a Result File

This call downloads the results file associated with the specified task.

Input

The input is the task ID as a URI parameter.
GET
https://api.ebay.com/sell/feed/v1/task/task-16481199/download_result_file

Output

The output is an HTTP status. If the call is successful, the results file associated with the task is downloaded.