Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

eBay Program API

The Program API from eBay — 3 operation(s) for program.

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

This API exposes 3 operations across 3 paths, and defines 2 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}.

3 operations 3 paths 2 schemas 1 GET2 POST

Metadata

The identity and technical contract details declared by the specification.

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

Authentication & Security 1

eBay Program 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 3

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

Program 3
GET
/program/get_opted_in_programs
This method gets a list of the seller programs that the seller has opted-in to.
getOptedInPrograms → 200400404500
POST
/program/opt_in
This method opts the seller in to an eBay seller program. Refer to the Account API overview for information about available eBay seller programs. Note: It can take up to 24-hours for eBay to process…
optInToProgram 1 param body → 200400404409500
POST
/program/opt_out
This method opts the seller out of a seller program to which you have previously opted-in to. Get a list of the seller programs you have opted-in to using the getOptedInPrograms call.
optOutOfProgram 1 param body → 200400404409500

Schemas 2

The contract defines 2 schemas that model the data the API accepts and returns. The most detailed are Programs (1 property), Program (1 property). Each schema is shown below with its type and property counts.

Program
object
A seller program in to which a seller can opt-in.
1 property
Programs
object
The base response type of the getOptedInPrograms method.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-program-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