feed APIv1.2.0


This method returns the details and status for an array of tasks based on a specified feed_type or scheduledId. Specifying both feed_type and scheduledId results in an error. Since schedules are based on feed types, you can specify a schedule (scheduled_id) that returns the needed feed_type.

If specifying the feed_type, limit which tasks are returned by specifying filters, such as the creation date range or period of time using look_back_days. Also, by specifying the feed_type, both on-demand and scheduled reports are returned.

If specifying a scheduledId, the schedule template (that the schedule ID is based on) determines which tasks are returned (see schedule_id for additional information). Each scheduledId applies to one feed_type.


Resource URI (production)

URI parameters

feed_typestringThe feed type associated with the tasks to be returned. The only presently supported value is LMS_ORDER_REPORT. Do not use with the scheduled_id parameter. Since schedules are based on feed types, you can specify a schedule (scheduled_id) that returns the needed feed_type.

Occurrence: Conditional

schedule_idstringThe schedule ID associated with the task. A schedule periodically generates a report for the feed type specified by the schedule template (see scheduleTemplateId in createSchedule). Do not use with the feed_type parameter.

Occurrence: Conditional

look_back_daysintegerThe number of previous days in which to search for tasks. Do not use with the date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used.

Default: 7

Range: 1-90 (inclusive)

Occurrence: Conditional

date_rangestringThe tasks creation date range. This range is used to filter the results. The results are filtered to include only tasks with a creation date that is equal to this date or is within specified range. Only tasks that are less than 90 days can be retrieved.

Format: UTC

For example:

Tasks within a range

Tasks created on September 8, 2019

Maximum: 90 days

Occurrence: Conditional

limitintegerThe maximum number of tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.

If this parameter is omitted, the default value is used.

Default: 10

Maximum: 500

Occurrence: Optional

offsetintegerThe number of tasks to skip in the result set before returning the first task in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.

Default: 0

Occurrence: Optional

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):






See OAuth access tokens for more information.


HTTP response headers

Output container/fieldTypeDescription
hrefstringThe path to the call URI that produced the current page of results.

Occurrence: Always

limitintegerThe value of the limit parameter submitted in the request, which is the maximum number of tasks to return per page, from the result set. A result set is the complete set of tasks returned by the method.

Note: Though this parameter is not required to be submitted in the request, the parameter defaults to 10 if omitted.

Note: If this is the last or only page of the result set, the page may contain fewer tasks than the limit value. To determine the number of pages in a result set, divide the total value (total number of tasks matching input criteria) by this limit value, and then round up to the next integer. For example, if the total value was 120 (120 total tasks) and the limit value was 50 (show 50 tasks per page), the total number of pages in the result set is three, so the seller would have to make three separate getTasks calls to view all tasks matching the input criteria.

Occurrence: Always

nextstringThe path to the call URI for the next page of results. This value is returned if there is an additional page of results to return from the result set.

Occurrence: Conditional

offsetintegerThe number of results skipped in the result set before listing the first returned result. This value can be set in the request with the offset query parameter.

Note: The items in a paginated result set use a zero-based list where the first item in the list has an offset of 0.

Occurrence: Always

prevstringThe path to the call URI for the previous page of results. This is returned if there is a previous page of results from the result set.

Occurrence: Conditional

tasksarray of TaskAn array of the tasks on this page. The tasks are sorted by creation date. An empty array is returned if the filter criteria excludes all tasks.

Occurrence: Always

tasks.completionDatestringThe timestamp when the task went into the COMPLETED or COMPLETED_WITH_ERROR state. This state means that eBay has compiled the report for the seller based on the seller’s filter criteria, and the seller can run a getResultFile call to download the report.

Occurrence: Conditional

tasks.creationDatestringThe date the task was created.

Occurrence: Conditional

tasks.detailHrefstringThe path to the call URI used to retrieve the task. This field points to the GetOrderTask URI if the task is for LMS_ORDER_REPORT or will be null if this task is for LMS_ORDER_ACK.

Occurrence: Conditional

tasks.feedTypestringThe feed type associated with the task.

Occurrence: Always

tasks.schemaVersionstringThe schema version number associated with the task.

Occurrence: Always

tasks.statusFeedStatusEnumThe enumeration value that indicates the state of the task that was submitted in the request. See FeedStatusEnum for information.

The values COMPLETED and COMPLETED_WITH_ERROR indicate the Order Report file is ready to download.

Occurrence: Always

tasks.taskIdstringThe ID of the task that was submitted in the request.

Occurrence: Always

tasks.uploadSummaryUploadSummaryThis container provides summary information on an upload feed. It is available for upload feed types (suppressed for download feed types).

Occurrence: Conditional

tasks.uploadSummary.failureCountintegerThe number of records that failed to process during the upload feed.

Occurrence: Conditional

tasks.uploadSummary.successCountintegerThe number of records that were successfully processed during the upload feed.

Occurrence: Conditional

totalintegerThe total number of tasks that match the input criteria.

Occurrence: Always

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.

400Bad Request
500Internal Server Error

Error codes

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

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.
160004API_FEEDREQUESTYou must submit either a 'feed_type' or 'schedule_id'.
160005API_FEEDREQUESTBoth 'feed_type' and 'schedule_id' were provided. Please remove one of them.
160006API_FEEDREQUESTThe 'feed_type' {feedTypeValue} is invalid.
160007API_FEEDREQUESTThe 'schedule_id' {scheduleID} is invalid.
160008API_FEEDREQUESTBoth 'look_back_days' and 'date_range' were provided. Please remove one of them.
160009API_FEEDREQUESTThe format of the 'date_range' is invalid. The format for a date range is yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ.
160010API_FEEDREQUESTThe 'date_range' must be less than or equal to 90 days.
160011API_FEEDREQUESTThe 'look_back_days' value must be greater than zero and less than or equal to 90.
160012API_FEEDREQUESTThe 'limit' value must be greater than zero and less than or equal to 500.
160013API_FEEDREQUESTThe 'offset' value cannot be less than zero.
160016API_FEEDREQUESTThe 'date_range' value is not valid. Ensure that the beginning of the range is before the end of the range.
160029API_FEEDREQUESTThe 'offset' value must be a multiple of the 'limit' value.



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: Get Task

This call retrieves the status of a group of tasks based on the criteria.


The inputs are feed_type and date_range.


The output is taskId, status, feedType, creationDate, and completionDate.