{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Task API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Task", "type": "folder" }, "items": [ { "info": { "name": "getTasks", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/task", "params": [ { "name": "date_range", "value": "", "type": "query", "description": "Specifies the range of task creation dates used to filter the results. The results are filtered to include only tasks with a creation date that is equal to this date or is within specified range. Only tasks that are less than 90 days can be retrieved.

Note: Maximum date range window size is 90 days.


Valid Format (UTC):yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

For example: Tasks created on September 8, 2019
2019-09-08T00:00:00.000Z..2019-09-09T00:00:00.000Z" }, { "name": "feed_type", "value": "", "type": "query", "description": "The feed type associated with the tasks to be returned. Only use a feedType that is available for your API: Do not use with the schedule_id parameter. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of tasks that can be returned on each page of the paginated response. Use this parameter in conjunction with the offset parameter to control the pagination of the output.

Note: This feature employs a zero-based list, where the first item in the list has an offset of 0.

For example, if offset is set to 10 and limit is set to 10, the call retrieves tasks 11 thru 20 from the result set.

If this parameter is omitted, the default value is used.

Default: 10

Maximum: 500" }, { "name": "look_back_days", "value": "", "type": "query", "description": "The number of previous days in which to search for tasks. Do not use with the date_range parameter. If both date_range and look_back_days are omitted, this parameter's default value is used.

Default: 7

Range: 1-90 (inclusive)" }, { "name": "offset", "value": "", "type": "query", "description": "The number of tasks to skip in the result set before returning the first task in the paginated response.

Combine offset with the limit query parameter to control the items returned in the response. For example, if you supply an offset of 0 and a limit of 10, the first page of the response contains the first 10 items from the complete list of items retrieved by the call. If offset is 10 and limit is 20, the first page of the response contains items 11-30 from the complete result set. If this query parameter is not set, the default value is used and the first page of records is returned.

Default: 0" }, { "name": "schedule_id", "value": "", "type": "query", "description": "The unique identifier associated with the tasks being returned. A schedule periodically generates a report for the feed type specified by the schedule template.

Note: Schedules are currently only available for LMS_ORDER_REPORT.
Do not use with the feed_type parameter." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method returns the details and status for an array of tasks based on a specified feed_type or schedule_id. Specifying both feed_type and schedule_id results in an error. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.

If specifying the feed_type, limit which tasks are returned by specifying filt" }, { "info": { "name": "createTask", "type": "http" }, "http": { "method": "POST", "url": "https://api.ebay.com{basePath}/task", "headers": [ { "name": "X-EBAY-C-MARKETPLACE-ID", "value": "" }, { "name": "Content-Type", "value": "" } ], "body": { "type": "json", "data": "{}" }, "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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 a download or an upload task.

For details about the upload and download flows, see Working with Order Feeds in the Selling Integration Guide.

Note:
Use the getTasks method to retrieve task IDs." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "This method downloads the file previously uploaded using uploadFile. Specify the task_id from the uploadFile call.

Note: With respect to LMS, this method applies to all feed types except LMS_ORDER_REPORT and LMS_ACTIVE_INVENTORY_REPORT. See LMS API Feeds in the Selling Integration Guide.

" }, { "info": { "name": "getResultFile", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/task/:task_id/download_result_file", "params": [ { "name": "task_id", "value": "", "type": "path", "description": "This path parameter is the unique identifier of the task associated with the file to be downloaded.

Use the getTasks method to retrieve task IDs." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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 extension (for example: csv.gz).

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

Note: The status of the tas" }, { "info": { "name": "getTask", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/task/:task_id", "params": [ { "name": "task_id", "value": "", "type": "path", "description": "This path parameter is the unique identifier of the task being retrieved.

Use the getTasks method to retrieve task IDs." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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. " }, { "info": { "name": "uploadFile", "type": "http" }, "http": { "method": "POST", "url": "https://api.ebay.com{basePath}/task/:task_id/upload_file", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "task_id", "value": "", "type": "path", "description": "This path parameter is the unique identifier of the task associated with the file that will be uploaded.

Use the getTasks method to retrieve task IDs." } ], "auth": { "type": "oauth2", "flow": "authorization_code", "authorizationUrl": "https://auth.ebay.com/oauth2/authorize", "accessTokenUrl": "https://api.ebay.com/identity/v1/oauth2/token", "credentials": { "clientId": "{{clientId}}", "clientSecret": "{{clientSecret}}" } } }, "docs": "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 generate and it's common for this method to return an HTTP status of 202, which indicates the report is being generated. Use the getTask with the task ID or getTasks to determine the status of a report.

The status flow is QUEUED > IN_PROCESS >" } ] } ], "bundled": true }