GET/task
This method returns the details and status for an array of tasks based on a specified feed_type or schedule_id. Specifying both feed_type and schedule_id results in an error. Since schedules are based on feed types, you can specify a schedule (schedule_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 schedule_id, 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.
Input
Resource URI
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
| Parameter | Type | Description |
|---|---|---|
| feed_type | string | The feed type associated with the tasks to be returned. Only use a feedType that is available for your API:
Occurrence: Conditional |
| schedule_id | string | The unique identifier associated with the tasks being returned. A schedule periodically generates a report for the feed type specified by the schedule template. Note: Schedules are currently only available for LMS_ORDER_REPORT.Do not use with the feed_type parameter. Occurrence: Conditional |
| look_back_days | integer | The 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_range | string | Specifies the range of task creation dates 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. Note: Maximum date range window size is 90 days. Valid Format (UTC): yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ For example: Tasks created on September 8, 2019 2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z Occurrence: Conditional |
| limit | integer | The 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 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. Occurrence: Optional |
| offset | integer | The 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 Occurrence: Optional |
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
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| href | string | The path to the call URI that produced the current page of results. Occurrence: Always |
| limit | integer | The 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 Occurrence: Always |
| next | string | The 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 |
| offset | integer | The 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 Occurrence: Always |
| prev | string | The 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 |
| tasks | array of Task | An 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.completionDate | string | The timestamp when the task went into the Occurrence: Conditional |
| tasks.creationDate | string | The date the task was created. Occurrence: Conditional |
| tasks.detailHref | string | The path to the call URI used to retrieve the task. This field points to the GetOrderTask URI if the task is for Occurrence: Conditional |
| tasks.feedType | string | The feed type associated with the task. Occurrence: Always |
| tasks.schemaVersion | string | The schema version number associated with the task. Occurrence: Always |
| tasks.status | FeedStatusEnum | The enumeration value that indicates the state of the task that was submitted in the request. See FeedStatusEnum for information. The values Occurrence: Always |
| tasks.taskId | string | The ID of the task that was submitted in the request. Occurrence: Always |
| tasks.uploadSummary | UploadSummary | This container provides summary information on an upload feed (not applicable for download feed types). Occurrence: Conditional |
| tasks.uploadSummary.failureCount | integer | The number of records, such as the number of listings created or the number of pictures uploaded to a listing, that failed to process during the upload feed. Check the response file and correct any issues mentioned. If the feed fails before processing, no response file is provided. In this case check the REST output response. Occurrence: Conditional |
| tasks.uploadSummary.successCount | integer | The number of records that were successfully processed during the upload feed. Occurrence: Conditional |
| total | integer | The 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.
| Status | Meaning |
|---|---|
| 200 | Success |
| 400 | Bad Request |
| 403 | Forbidden |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 160001 | API_FEED | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay Developer Technical Support for assistance. |
| 160002 | API_FEED | REQUEST | The authentication scope {scope} is incorrect for 'feed_type' {feedType}. Refer to documentation for details about the scopes. |
| 160004 | API_FEED | REQUEST | You must submit either a 'feed_type' or 'schedule_id'. |
| 160005 | API_FEED | REQUEST | Both 'feed_type' and 'schedule_id' were provided. Please remove one of them. |
| 160006 | API_FEED | REQUEST | The 'feed_type' {feedTypeValue} is invalid. |
| 160007 | API_FEED | REQUEST | The 'schedule_id' {scheduleID} is invalid. |
| 160008 | API_FEED | REQUEST | Both 'look_back_days' and 'date_range' were provided. Please remove one of them. |
| 160009 | API_FEED | REQUEST | The 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. |
| 160010 | API_FEED | REQUEST | The 'date_range' must be less than or equal to 90 days. |
| 160011 | API_FEED | REQUEST | The 'look_back_days' value must be greater than zero and less than or equal to 90. |
| 160012 | API_FEED | REQUEST | The 'limit' value must be greater than zero and less than or equal to 500. |
| 160013 | API_FEED | REQUEST | The 'offset' value cannot be less than zero. |
| 160016 | API_FEED | REQUEST | The 'date_range' value is not valid. Ensure that the beginning of the range is before the end of the range. |
| 160029 | API_FEED | REQUEST | The 'offset' value must be a multiple of the 'limit' value. |
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: Get Tasks
This call retrieves the status of a group of tasks based on the criteria.
Input
The input specifies feed_type, date_range, limit, and offset query parameters.
GEThttps://api.ebay.com/sell/feed/v1/task?offset=2&limit=2&feed_type=LMS_ORDER_ACK&date_range=2020-07-06T02:00:00.000Z..2020-07-07T01:00:00.000Z
Output
The output is an array of tasks and the details for each task including taskId, status,
feedType, and so on, as specified by the filter criteria. Since limit was set to 2 and offset was set to 2, the output contains the second page of returned results.