Home
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.
This method is supported in Sandbox environment. To access the endpoint, just replace the api.ebay.com
root URI with api.sandbox.ebay.com
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.
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.
This call has no payload.
This call has no field definitions.
This call has no response headers.
Output container/field | Type | Description |
---|---|---|
completionDate | string | The timestamp when the task went into the Occurrence: Conditional |
creationDate | string | The date the task was created. Occurrence: Conditional |
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 |
feedType | string | The feed type associated with the task. Occurrence: Always |
schemaVersion | string | The schema version number associated with the task. Occurrence: Always |
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 |
taskId | string | The ID of the task that was submitted in the request. Occurrence: Always |
uploadSummary | UploadSummary | This container provides summary information on an upload feed (not applicable for download feed types). Occurrence: Conditional |
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 |
uploadSummary.successCount | integer | The number of records that were successfully processed during the upload feed. Occurrence: Conditional |
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 |
403 | Forbidden |
404 | Not Found |
500 | Internal Server Error |
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. |
160003 | API_FEED | REQUEST | Task {taskID} does not exist. |
This call has no warnings.
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.
This call retrieves the status of a specific task.
The input is the task_id.
GEThttps://api.ebay.com/sell/feed/v1/task/task-10-3********1
The output is taskId, status, feedType, creationDate, and completionDate.