Skip to main content

GET/schedule/{schedule_id}/download_result_file

This method downloads the latest Order Report generated by the schedule. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz). Specify the schedule_id path parameter to download its last generated file.

Input

Resource URI

GET https://api.ebay.com/sell/feed/v1/schedule/{schedule_id}/download_result_file

This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com root URI with api.sandbox.ebay.com

URI parameters

ParameterTypeDescription
schedule_idstringThis path parameter is the unique identifier of the schedule for which to retrieve the latest Order Report.

Use the getSchedules method to retrieve schedule IDs.

Occurrence: Required

HTTP request headers

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

All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.

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.

Request payload

This call has no payload.

Request fields

This call has no field definitions.

Output

HTTP response headers

See HTTP response headers for details.

HeaderMeaning
content-dispositionIt contains the file metadata like file name.

Response payload

The response of this call is a compressed or uncompressed CSV, XML, or JSON file.

This call has no payload.

Response fields

This call has no field definitions.

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.
160021API_FEEDREQUESTNo file found for 'schedule_id' {scheduleID}.
160038API_FEEDREQUESTThe schedule id {schedule_id} does not exist.

Warnings

This call has no 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: Retrieves the Result File

This sample returns a file containing the latest result file generated by the specified schedule (10-1***7-1******0).

Input

The input is the schedule_ID as a path parameter.

GEThttps://api.ebay.com/sell/feed/v1/schedule/10-1***7-1******0/download_result_file

Output

The output is an HTTP status. If the call is successful, the latest generated file for the specified is downloaded. This method has no response payload.

Got thoughts? Click the feedback button – your insights help us improve!