{ "opencollection": "1.0.0", "info": { "name": "eBay Account Advertising_eligibility Schedule API", "version": "v1.9.2" }, "items": [ { "info": { "name": "Schedule", "type": "folder" }, "items": [ { "info": { "name": "getSchedules", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/schedule", "params": [ { "name": "feed_type", "value": "", "type": "query", "description": "The feed type associated with the schedules being retrieved.

Note: Schedules are currently only available for LMS_ORDER_REPORT." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of schedules 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 schedules 11 thru 20 from the result set.

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

Default: 10

Maximum: 500" }, { "name": "offset", "value": "", "type": "query", "description": "The number of schedules to skip in the result set before returning the first schedule 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" } ], "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 an array containing the details and status of all schedules based on the specified feed_type. Use this method to find a schedule if you do not know the schedule_id." }, { "info": { "name": "createSchedule", "type": "http" }, "http": { "method": "POST", "url": "https://api.ebay.com{basePath}/schedule", "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 a schedule, which is a subscription to the specified schedule template. A schedule periodically generates a report for the feedType specified by the template. Specify the same feedType as the feedType of the associated schedule template. When creating the schedule, if available from the template, you can specify a preferred trigger hour, day of the week, or day of the month. These and other fields are conditionally available " }, { "info": { "name": "getSchedule", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/schedule/:schedule_id", "params": [ { "name": "schedule_id", "value": "", "type": "path", "description": "This path parameter is the unique identifier of the schedule for which to retrieve details.

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 retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve using the schedule_id. Use the getSchedules method to find a schedule if you do not know the schedule_id." }, { "info": { "name": "updateSchedule", "type": "http" }, "http": { "method": "PUT", "url": "https://api.ebay.com{basePath}/schedule/:schedule_id", "headers": [ { "name": "Content-Type", "value": "" } ], "params": [ { "name": "schedule_id", "value": "", "type": "path", "description": "This path parameter is the unique identifier of the schedule being updated.

Use the getSchedules method to retrieve schedule IDs." } ], "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 updates an existing schedule. Specify the schedule to update using the schedule_id path parameter. If the schedule template has changed after the schedule was created or updated, the input will be validated using the changed template.

Note: Make sure to include all fields required by the schedule template (scheduleTemplateId). Call the getScheduleTemplate method (or the getScheduleT" }, { "info": { "name": "deleteSchedule", "type": "http" }, "http": { "method": "DELETE", "url": "https://api.ebay.com{basePath}/schedule/:schedule_id", "params": [ { "name": "schedule_id", "value": "", "type": "path", "description": "This path parameter is the unique identifier of the schedule being deleted.

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 deletes an existing schedule. Specify the schedule to delete using the schedule_id path parameter." }, { "info": { "name": "getLatestResultFile", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/schedule/:schedule_id/download_result_file", "params": [ { "name": "schedule_id", "value": "", "type": "path", "description": "This path parameter is the unique identifier of the schedule for which to retrieve the latest Order Report.

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 downloads the latest Order Report generated by the schedule. The response of this call is a compressed or uncompressed CSV, XML, or JSON file, with the applicable file extension (for example: csv.gz). Specify the schedule_id path parameter to download its last generated file." }, { "info": { "name": "getScheduleTemplate", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/schedule_template/:schedule_template_id", "params": [ { "name": "schedule_template_id", "value": "", "type": "path", "description": "This path parameter is the unique identifier of the schedule template being retrieved.

Use the getScheduleTemplates method to retrieve schedule template IDs.

Note: Template schedules are currently only available for LMS_ORDER_REPORT." } ], "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 of the specified template. Specify the template to retrieve using the schedule_template_id path parameter. Use the getScheduleTemplates method to find a schedule template if you do not know the schedule_template_id." }, { "info": { "name": "getScheduleTemplates", "type": "http" }, "http": { "method": "GET", "url": "https://api.ebay.com{basePath}/schedule_template", "params": [ { "name": "feed_type", "value": "", "type": "query", "description": "The feed type of the schedule templates to retrieve.

Note: Schedules are currently only available for LMS_ORDER_REPORT." }, { "name": "limit", "value": "", "type": "query", "description": "The maximum number of schedule templates 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 schedule templates 11 thru 20 from the result set.

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

Default: 10

Maximum: 500" }, { "name": "offset", "value": "", "type": "query", "description": "The number of schedule templates to skip in the result set before returning the first template 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" } ], "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 an array containing the details and status of all schedule templates based on the specified feed_type. Use this method to find a schedule template if you do not know the schedule_template_id." } ] } ], "bundled": true }