Skip to main content

GET/order_task/{task_id}

This method retrieves the task details and status of the specified task. The input is task_id.

For details about how this method is used, see Working with Order Feeds in the Selling Integration Guide.

Input

Resource URI (production)

GET https://api.ebay.com/sell/feed/v1/order_task/{task_id}

URI parameters

ParameterTypeDescription
task_idstringThe ID of the task. This ID is generated when the task was created by the createOrderTask method.

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.fulfillment

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/fieldTypeDescription
completionDatestring

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

creationDatestring

The date the task was created.

Occurrence: Always

detailHrefstring

The path to the call URI used to retrieve the task.

Occurrence: Always

feedTypestring

The feed type associated with the task.

Occurrence: Always

filterCriteriaOrderFilterCriteria

A container that returns the filter criteria used.

Occurrence: Conditional

filterCriteria.creationDateRangeDateRange

The creation date range of the orders you want returned. Set the date range so it contains less than 10 days (maximum). If you do not specify a DateRange, results from the last 10 days will be returned by default.

Occurrence: Conditional

filterCriteria.creationDateRange.fromstring

The 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 March 31, 2021
2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z

Occurrence: Conditional

filterCriteria.creationDateRange.tostring

The 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 March 31, 2021
2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z

Occurrence: Conditional

filterCriteria.modifiedDateRangeDateRange

The modified date range of the orders you want returned.

Note: This container is for future use. At this time, the createOrderTask method only supports order creation date filters and not modified order date filters.

Occurrence: Conditional

filterCriteria.modifiedDateRange.fromstring

The 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 March 31, 2021
2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z

Occurrence: Conditional

filterCriteria.modifiedDateRange.tostring

The 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 March 31, 2021
2021-03-31T00:00:00.000Z..2021-03-31T00:00:00.000Z

Occurrence: Conditional

filterCriteria.orderStatusOrderStatusEnum

The 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

schemaVersionstring

The schema version number associated with the create task.

Occurrence: Always

statusFeedStatusEnum

The 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

taskIdstring

The ID of the task that was submitted in the request.

Occurrence: Always

uploadSummaryUploadSummary

This container provides summary information on an upload feed (not applicable for download feed types).

Occurrence: Conditional

uploadSummary.failureCountinteger

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

uploadSummary.successCountinteger

The number of records that were successfully processed during the upload feed.

Occurrence: Conditional

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.
160003API_FEEDREQUESTTask {taskID} 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: Retrieve an Order Task

This call returns the status of the specified order task. When the status is COMPLETED, use the getResultFile method to return the report file. See OrderReport for the definitions and a sample of the fields contained in the returned file.

Input

The input is the task_id.

GEThttps://api.ebay.com/sell/feed/v1/order_task/task-10-3********4

Output

The output is the order status and the criteria specified when the task was created.