eBay Task API is one of 64 APIs that eBay publishes on the APIs.io network, described by a machine-readable OpenAPI specification and an AsyncAPI event-driven specification.
Tagged areas include Task. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.
This API exposes
6 operations
across 5 paths,
and defines 5 schemas.
It is described by OpenAPI 3.0.0, at version v1.9.2.
Requests are made against a single base URL, https://api.ebay.com{basePath}.
6 operations5 paths5 schemas4 GET2 POST
Metadata
The identity and technical contract details declared by the specification.
eBay Task API declares
1 security scheme
for authenticating requests.
It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 2 scopes.
api_auth — The security definitions for this API. Please check individual operations for applicable scopes.
Paths & Operations 6
Across 5 paths, the API surfaces 6 operations — 4 GET, 2 POST. Each is listed below with its method, path, parameters, and response codes.
Task 6
GET
/task
This method returns the details and status for an array of tasks based on a specified feedtype or scheduleid . Specifying both feedtype and scheduleid results in an error. Since schedules are based o…
getTasks6 params→ 200400403500
POST
/task
This method creates an upload task or a download task without filter criteria. When using this method, specify the feedType and the feed file schemaVersion . The feed type specified sets the task as…
createTask2 paramsbody→ 202400403409500
GET
/task/{task_id}/download_input_file
This method downloads the file previously uploaded using uploadFile . Specify the taskid from the uploadFile call. Note: With respect to LMS, this method applies to all feed types except LMSORDERREPO…
getInputFile1 param→ 200400403404500
GET
/task/{task_id}/download_result_file
This method retrieves the generated file that is associated with the specified task ID. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file exte…
getResultFile1 param→ 200400403404500
GET
/task/{task_id}
This method retrieves the details and status of the specified task. The input is taskid . For details of how this method is used, see Working with Order Feeds in the Selling Integration Guide.
getTask1 param→ 200400403404500
POST
/task/{task_id}/upload_file
This method associates the specified file with the specified task ID and uploads the input file. After the file has been uploaded, the processing of the file begins. Reports often take time to genera…
uploadFile2 params→ 200400403404500
Schemas 5
The contract defines 5 schemas that model the data the API accepts and returns. The most detailed are Task (8 properties), TaskCollection (7 properties), CreateTaskRequest (2 properties), UploadSummary (2 properties). Each schema is shown below with its type and property counts.
UploadSummary
object
This container provides summary information on an upload feed (not applicable for download feed types).
2 properties
CreateTaskRequest
object
The type that defines the fields for the createTask method.
2 properties
StreamingOutput
object
File stream
Task
object
The type that defines the fields for the task details.
8 properties
TaskCollection
object
The type that defines the fields for a paginated result set of tasks. The response consists of 0 or more sequenced pages where each page has 0 or more items.
7 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
