Input
Resource URI (production)
URI parameters
| Parameter | Type | Description |
|---|---|---|
| feed_type | string | The feed type. Occurrence: Required |
| 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 | The 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 yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ Tasks created on September 8, 2019 2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z Maximum: 90 days Occurrence: Conditional |
| limit | integer | The maximum number of order tasks that can be returned on each page of the paginated response. If this parameter is omitted, the default value is used. Default: 10 Maximum: 500 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
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
| Output container/field | Type | Description |
|---|---|---|
| href | string | The path to the call URI that produced the current page of results. Occurrence: Conditional |
| 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. 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 | This value indicates the offset used for the current page of tasks being returned. For example, if the initial request used an offset of 0 and a limit of 3. Then on the first page of results, this value would be 0, and items 1-3 are returned. For the second page, this value is 3 and so on. 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 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.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 LMS_ORDER_REPORT or will be null if this task is for LMS_ORDER_ACK. 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 |
| 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 a 'feed_type'. |
| 160006 | API_FEED | REQUEST | The 'feed_type' {feedTypeValue} 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
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.