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 Destination API

The Destination API from eBay — 2 operation(s) for destination.

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

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

5 operations 2 paths 4 schemas 1 DELETE2 GET1 POST1 PUT

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 Destination 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 5

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

Destination 5
GET
/destination
This method allows applications to retrieve a paginated collection of destination resources and related details. The details include the destination names, statuses, and configurations, including the…
getDestinations 2 params → 200400500
POST
/destination
This method allows applications to create a destination. A destination is an endpoint that receives HTTP push notifications. A single destination for all topics is valid, as is individual destination…
createDestination 1 param body → 201400409500
GET
/destination/{destination_id}
This method allows applications to fetch the details for a destination. The details include the destination name, status, and configuration, including the endpoint and verification token.
getDestination 1 param → 200400404500
PUT
/destination/{destination_id}
This method allows applications to update a destination. Note: The destination should be created and ready to respond with the expected challengeResponse for the endpoint to be registered successfull…
updateDestination 2 params body → 204400404409500
DELETE
/destination/{destination_id}
This method provides applications a way to delete a destination. The same destination ID can be used by many destinations. Trying to delete an active destination results in an error. You can disable…
deleteDestination 1 param → 204400404409500

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are DestinationSearchResponse (5 properties), Destination (4 properties), DestinationRequest (3 properties), DeliveryConfig (2 properties). Each schema is shown below with its type and property counts.

DestinationRequest
object
A type that contains information about the destination request.
3 properties
DestinationSearchResponse
object
A type that contains information about the destination search response.
5 properties
DeliveryConfig
object
A type that contains information about the delivery configuration.
2 properties
Destination
object
A type that contains information about the destination.
4 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-destination-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 Event API
eBay Event_item API