feed APIv1.1.0

getTask

GET
/task/{task_id}
This method retrieves the details and status of the specified task. The input is task_id .

For details of 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/task/{task_id}

URI parameters

ParameterTypeDescription
task_idstringThe ID of the task. This ID was generated when the task was created.

Occurrence: Required

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

HTTP response headers

Output container/fieldTypeDescription
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

creationDatestringThe date the task was created.

Occurrence: Conditional

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

feedTypestringThe feed type associated with the task.

Occurrence: Always

schemaVersionstringThe schema version number associated with the task.

Occurrence: Always

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

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

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

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 Task

This call retrieves the status of a specific task.

Input

The input is the task_id.
GET
https://api.ebay.com/sell/feed/v1/task/task-10-3262091

Output

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