How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eBay Schedule API

The Schedule API from eBay — 5 operation(s) for schedule.

eBay Schedule 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 Schedule. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, release notes, and an AsyncAPI specification.

This API exposes 8 operations across 5 paths, and defines 8 schemas. It is described by OpenAPI 3.2.0, at version v1.3.1.

Requests are made against a single base URL, https://api.ebay.com{basePath}.

8 operations 5 paths 8 schemas 1 DELETE5 GET1 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.2.0
API Version
v1.3.1
Base URL
https://api.ebay.com
Authentication
OAuth 2.0
Contact
eBay Inc,
Resource Areas
1

Authentication & Security 1

eBay Schedule API declares 1 security scheme for authenticating requests. It supports OAuth 2.0 (api_auth) using the authorizationCode flow, exposing 5 scopes.

  • api_auth — The security definitions for this API. Please check individual operations for applicable scopes.

Paths & Operations 8

Across 5 paths, the API surfaces 8 operations — 1 DELETE, 5 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Schedule 8
GET
/schedule
This method retrieves an array containing the details and status of all schedules based on the specified feedtype . Use this method to find a schedule if you do not know the scheduleid .
getSchedules 3 params → 200400403500
POST
/schedule
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 fee…
createSchedule 1 param body → 201400403409500
GET
/schedule/{schedule_id}
This method retrieves schedule details and status of the specified schedule. Specify the schedule to retrieve using the scheduleid . Use the getSchedules method to find a schedule if you do not know…
getSchedule 1 param → 200400403404500
PUT
/schedule/{schedule_id}
This method updates an existing schedule. Specify the schedule to update using the scheduleid path parameter. If the schedule template has changed after the schedule was created or updated, the input…
updateSchedule 2 params body → 204400403404409500
DELETE
/schedule/{schedule_id}
This method deletes an existing schedule. Specify the schedule to delete using the scheduleid path parameter.
deleteSchedule 1 param → 204400404500
GET
/schedule/{schedule_id}/download_result_file
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 exam…
getLatestResultFile 1 param → 200400403404500
GET
/schedule_template/{schedule_template_id}
This method retrieves the details of the specified template. Specify the template to retrieve using the scheduletemplateid path parameter. Use the getScheduleTemplates method to find a schedule templ…
getScheduleTemplate 1 param → 200400404500
GET
/schedule_template
This method retrieves an array containing the details and status of all schedule templates based on the specified feedtype . Use this method to find a schedule template if you do not know the schedul…
getScheduleTemplates 3 params → 200400500

Schemas 8

The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are UserScheduleResponse (14 properties), CreateUserScheduleRequest (9 properties), UpdateUserScheduleRequest (7 properties), ScheduleTemplateCollection (7 properties). Each schema is shown below with its type and property counts.

CreateUserScheduleRequest
object
The type that defines the fields for the createSchedule method.
9 properties
ScheduleTemplateCollection
object
The type that defines the fields for a paginated result set of schedule templates. The response consists of 0 or more sequenced pages where each page has 0 or…
7 properties
SupportedConfiguration
object
An array that defines the configuration supported by this template. This includes specified properties and usage (whether the property is REQUIRED or OPTIONAL)…
3 properties
UpdateUserScheduleRequest
object
The type that defines the fields for a schedule update to a schedule generated with the Feed API.
7 properties
UserScheduleCollection
object
The type that defines the fields for a paginated result set of user schedules. The response consists of 0 or more sequenced pages where each page has 0 or more…
7 properties
UserScheduleResponse
object
The type that defines the fields for a paginated result set of available schedules. The response consists of 0 or more sequenced pages where each page has 0 or…
14 properties
ScheduleTemplateResponse
object
The type that defines the fields for a paginated result set of available schedule templates. The response consists of 0 or more sequenced pages where each page…
6 properties
StreamingOutput
object
File stream

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-schedule-api-openapi.yml Raw ↑

Other APIs eBay publishes across the network.

eBay Advertising_eligibility API
eBay Bidding API
eBay Category_tree API
eBay Charity_org API
eBay Config API
eBay Country API
eBay Custom_policy API
eBay Customer_service_metric API
eBay Customer_service_metric_task API
eBay Deal_item API
eBay Destination API
eBay Event API
Where this information came from

This is an independent, third-party profile of eBay Schedule API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.