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)
URI parameters
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/field | Type | Description |
|---|---|---|
| completionDate | string | The timestamp when the task went into the Occurrence: Conditional |
| creationDate | string | The date the task was created. Occurrence: Always |
| detailHref | string | The path to the call URI used to retrieve the task. Occurrence: Always |
| feedType | string | The feed type associated with the task. Occurrence: Always |
| filterCriteria | OrderFilterCriteria | A container that returns the filter criteria used. Occurrence: Conditional |
| filterCriteria.creationDateRange | DateRange | 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.from | string | The beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required. Occurrence: Conditional |
| filterCriteria.creationDateRange.to | string | 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. Occurrence: Conditional |
| filterCriteria.modifiedDateRange | DateRange | 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.from | string | The beginning date in the range. If the parent type is included, both the from and/or the to fields become conditionally required. Occurrence: Conditional |
| filterCriteria.modifiedDateRange.to | string | 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. Occurrence: Conditional |
| filterCriteria.orderStatus | OrderStatusEnum | The order status of the orders returned. If the filter is omitted from createOrderTask call, orders that are in both Occurrence: Conditional |
| schemaVersion | string | The schema version number associated with the create 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 |
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 |
| 403 | Forbidden |
| 404 | Not Found |
| 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. |
| 160003 | API_FEED | REQUEST | Task {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.