{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Order_task API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Order_task", "type": "folder" }, "items": [ { "info": { "name": "getOrderTasks", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/order_task", "params": [ { "name": "date_range", "value": "", "type": "query", "description": "The order tasks creation date range. This range is used to filter the results. The filtered results are filtered to include only tasks with a creation date that is equal to this date or is within specified range. Only orders less than 90 days old can be retrieved. Do not use with the look_back_days parameter.

Format: UTC

For example:

Tasks within a range
yyyy-MM-ddThh:mm:ss.SSSZ..yyyy-MM-ddThh:mm:ss.SSSZ

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 order tasks being retrieved. The only presently supported value is LMS_ORDER_REPORT

See Report download feed types for more information.

Note: 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 order 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 order 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 order tasks to skip in the result set before returning the first order 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 schedule ID associated with the order tasks being retrieved. A schedule periodically generates a report, and these schedules can be created with the createSchedule method.

Note: Do not use with the feed_type parameter. Since schedules are based on feed types, you can specify a schedule (schedule_id) that returns the needed feed_type.
Use the getSchedules method to retrieve schedule 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 returns the details and status for an array of order 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 order tasks are returned by spe" }, { "info": { "name": "createOrderTask", "type": "http" }, "http": { "method": "POST", "url": "https://api.ebay.com{basePath}/order_task", "headers": [ { "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 order download task with filter criteria for the order report. When using this method, specify the feedType, schemaVersion, and filterCriteria for the report. The method returns the location response header containing the getOrderTask call URI to retrieve the order task you just created. The URL includes the eBay-assigned task ID, which you can use to reference the order task.

To retrieve the status of the task, use the getOrd" }, { "info": { "name": "getOrderTask", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/order_task/:task_id", "params": [ { "name": "task_id", "value": "", "type": "path", "description": "This path parameter is the unique identifier of the order task being retrieved.

Use the getOrderTasks method to retrieve order 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 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.

" } ] } ], "bundled": true }