feed APIv1.1.0

getOrderTasks

GET
/order_task
This method returns the details and status of an array of order tasks based on the specified feed_type. You can limit the tasks returned by specifying filters such as, the creation date range or period of time (look_back_days).

Input

Resource URI (production)

GET https://api.ebay.com/sell/feed/v1/order_task?

URI parameters

ParameterTypeDescription
feed_typestringThe feed type associated with the task. The only presently supported value is LMS_ORDER_REPORT.

Occurrence: Required

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 order tasks creation date range. This range is used to filter the results. The filtered results are filtered to include only tasks with a creation date that is equal to this date or is within specified range. Only orders less than 90 days old can be retrieved. Do not use with the look_back_days parameter.

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

Occurrence: Conditional

limitintegerThe 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

offsetintegerThe number of orders tasks to skip in the result set before returning the first order 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.

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

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

See OAuth access tokens for more information.

Output

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.

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 OrderTaskAn array of the order 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: Always

tasks.detailHrefstringThe path to the call URI used to retrieve the task.

Occurrence: Always

tasks.feedTypestringThe feed type associated with the task.

Occurrence: Always

tasks.filterCriteriaOrderFilterCriteriaA container that returns the filter criteria used.

Occurrence: Conditional

tasks.filterCriteria.creationDateRangeDateRangeThe creation date range of the orders you want returned.

Occurrence: Conditional

tasks.filterCriteria.creationDateRange.fromstringThe beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required.

Format: UTC yyyy-MM-ddThh:mm:ss.SSSZ

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

Occurrence: Conditional

tasks.filterCriteria.creationDateRange.tostringThe end date for the date range, which is inclusive. If the parent type is included, both the from and/or the to fields become conditionally required.

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

Occurrence: Conditional

tasks.filterCriteria.modifiedDateRangeDateRangeThe modified date range of the orders you want returned.

Occurrence: Conditional

tasks.filterCriteria.modifiedDateRange.fromstringThe beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required.

Format: UTC yyyy-MM-ddThh:mm:ss.SSSZ

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

Occurrence: Conditional

tasks.filterCriteria.modifiedDateRange.tostringThe end date for the date range, which is inclusive. If the parent type is included, both the from and/or the to fields become conditionally required.

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

Occurrence: Conditional

tasks.filterCriteria.orderStatusOrderStatusEnumThe order status of the orders returned. If the filter is omitted from createOrderTask call, orders that are in both ACTIVE and COMPLETED states are returned.

Occurrence: Conditional

tasks.schemaVersionstringThe schema version number associated with the create 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

totalintegerThe total number of order 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.

StatusMeaning
200Success
400Bad Request
403Forbidden
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.
160004API_FEEDREQUESTYou must submit a 'feed_type'.
160006API_FEEDREQUESTThe 'feed_type' {feedTypeValue} 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.
160029API_FEEDREQUESTThe '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.

Sample 1: Retrieves Order Tasks Based on the Criteria

This call retrieves an array of tasks based on the criteria.

Input

The input is feed_type.
GET
https://api.ebay.com/sell/feed/v1/order_task?feed_type=LMS_ORDER_REPORT

Output

The output is an array of tasks and the details for each task, such as the taskId, status, feedType, filterCriteria, etc.