eBay Product_compatibility 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 Product_compatibility. 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 1 path,
and defines 8 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 operations1 paths8 schemas1 DELETE1 GET1 PUT
Metadata
The identity and technical contract details declared by the specification.
eBay Product_compatibility 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 1 path, the API surfaces 3 operations — 1 DELETE, 1 GET, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
Product_compatibility 3
GET
/inventory_item/{sku}/product_compatibility
This call is used by the seller to retrieve the list of products that are compatible with the inventory item. The SKU value for the inventory item is passed into the call URI, and a successful call w…
getProductCompatibility1 param→ 200400404500
PUT
/inventory_item/{sku}/product_compatibility
This call is used by the seller to create or replace a list of products that are compatible with the inventory item. The inventory item is identified with a SKU value in the URI. Product compatibilit…
This call is used by the seller to delete the list of products that are compatible with the inventory item that is associated with the compatible product list. The inventory item is identified with a…
deleteProductCompatibility1 param→ 204400404500
Schemas 8
The contract defines 8 schemas that model the data the API accepts and returns. The most detailed are Error (9 properties), ProductFamilyProperties (5 properties), CompatibleProduct (4 properties), ProductIdentifier (3 properties). Each schema is shown below with its type and property counts.
Compatibility
object
This type is used by the createOrReplaceProductCompatibility call to associate compatible vehicles to an inventory item. This type is also the base response of…
2 properties
ErrorParameter
object
This type is used to indicate the parameter field/value that caused an issue with the call request.
2 properties
NameValueList
object
This type is used by the compatibilityProperties container to identify a motor vehicle using name/value pairs.
2 properties
CompatibleProduct
object
This type is used to specify/indicate the motor vehicles that are compatible with the corresponding inventory item.
4 properties
ProductIdentifier
object
This type is used to identify a motor vehicle that is compatible with the corresponding inventory item (the SKU that is passed in as part of the call URI). The…
3 properties
ProductFamilyProperties
object
This type is used to specify the details of a motor vehicle that is compatible with the inventory item specified through the SKU value in the call URI.
5 properties
Error
object
This type is used to express detailed information on errors and warnings that may occur with a call request.
9 properties
BaseResponse
object
This is the base response of the createOrReplaceInventoryItem , createOrReplaceInventoryItemGroup , and createOrReplaceProductCompatibility calls. A response p…
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
