eBay Item API
The Item API from eBay — 5 operation(s) for item.
eBay Item 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 Item. 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 5 paths, and defines 52 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
5 paths
52 schemas
4 GET1 POST
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
eBay Item 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 5 paths, the API surfaces 5 operations — 4 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.
Item 5
GET
/item/{item_id}
This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs,…
GET
/item/get_item_by_legacy_id
This method is a bridge between the eBay legacy APIs, such as Shopping and Finding , and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an…
GET
/item/
This method retrieves the details about specific items that buyers need to make a purchasing decision. Note: This is a (Limited Release) available only to select Partners. For this method, only the f…
GET
/item/get_items_by_item_group
This method retrieves details about individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. You pass in the itemgr…
POST
/item/{item_id}/check_compatibility
This method checks if a product is compatible with the specified item. You can use this method to check the compatibility of cars, trucks, and motorcycles with a specific part listed on eBay. For exa…
Schemas 52
The contract defines 52 schemas that model the data the API accepts and returns. The most detailed are Item (78 properties), CoreItem (68 properties), ShippingOption (15 properties), SellerLegalInfo (13 properties). Each schema is shown below with its type and property counts.
ReviewRating
object
The type that defines the fields for the rating of a product review.
3 properties
TypedNameValue
object
The type that defines the fields for the name/value pairs for item aspects.
3 properties
AuthenticityVerificationProgram
object
A type that identifies whether the item is from a verified seller.
2 properties
Address
object
The type that defines the fields for an address.
7 properties
AuthenticityGuaranteeProgram
object
A type that identifies whether the item is qualified for the Authenticity Guarantee program.
2 properties
Items
object
Container for a list of items.
3 properties
SellerDetail
object
The type that defines the fields for basic and detailed information about the seller of the item returned by the item resource.
6 properties
VatDetail
object
The type the defines the fields for the VAT (value add tax) information.
2 properties
MarketingPrice
object
The type that defines the fields that describe a seller discount.
4 properties
AdditionalProductIdentity
object
The type that defines the array of product identifiers associated with the item. This container is returned if the seller has associated the eBay Product Ident…
1 property
Image
object
Type that defines the details of an image, such as size and image URL. Currently, only imageUrl is populated. The height and width are reserved for future use.
3 properties
AddonService
object
This container describes an add-on service that may be selected for an item or that may apply automatically. A charge may be associated with the add-on service.
4 properties
ShippingOption
object
The type that defines the fields for the details of a shipping provider.
15 properties
AttributeNameValue
object
The type the defines attribute name/value pair fields that specify a product. The type of data depends on the context. For example, if you were using this to s…
2 properties
Amount
object
2 properties
Aspect
object
The type that defines the fields for the name/value pairs for the aspects of the product. For example: BRAND/Apple
2 properties
ItemReturnTerms
object
The type that defines the fields for the seller's return policy.
8 properties
ItemGroupSummary
object
The type that defines the fields for the details of each item in an item group. An item group is an item that has various aspect differences, such as color, si…
6 properties
Item
object
The details of an item that can be purchased.
78 properties
ConditionDescriptor
object
This type displays additional information about the condition of an item in a structured format.
2 properties
CommonDescriptions
object
The type that defines the fields for the itemid values that all use a common description. Often the item variations within an item group all have the same desc…
2 properties
ProductIdentity
object
The type that defines the fields for the product identifier type/value pairs of product associated with an item.
2 properties
AspectGroup
object
2 properties
HazardStatement
object
A type that defines the hazard statement for a hazardous material.
2 properties
CoreItem
object
An array of containers with the details for all of the items returned.
68 properties
ConvertedAmount
object
This type defines the monetary value of an amount. It can provide the amount in both the currency used on the eBay site where an item is being offered and the…
4 properties
ShipToRegion
object
This type is used provide details about included and excluded shipping regions.
3 properties
AvailableCoupon
object
6 properties
Error
object
The type that defines the fields that can be returned in an error.
9 properties
Product
object
The type that defines the fields for the product information of the item.
9 properties
ItemGroup
object
The type that defines the fields for the item details.
3 properties
PaymentMethodBrand
object
2 properties
TaxJurisdiction
object
The type that defines the fields for the tax jurisdiction details.
2 properties
SellerLegalInfo
object
The type that defines the fields for the contact information for a seller.
13 properties
ShipToLocation
object
The type that defines the fields for the country and postal code of where an item is to be shipped.
2 properties
PaymentMethod
object
4 properties
LegalAddress
object
Type that defines the fields for the seller's address.
8 properties
ConditionDescriptorValue
object
This type displays the value(s) associated with the specified condition descriptor name, as well as any additional information about a condition descriptor.
2 properties
EstimatedAvailability
object
The type that defines the fields for the estimated item availability information.
6 properties
TimeDuration
object
The type that defines the fields for a period of time in the time-measurement units supplied.
2 properties
CouponConstraint
object
This type is used to provide the expiration date of a coded coupon.
1 property
Taxes
object
The type that defines the tax fields.
6 properties
ErrorParameter
object
An array of name/value pairs that provide details regarding the error.
2 properties
Region
object
This type is used to provide region details for a tax jurisdiction.
2 properties
SellerCustomPolicy
object
The container for custom policies that apply to a listed item.
3 properties
ShipToLocations
object
The type that defines the fields that include and exclude geographic regions affecting where the item can be shipped. The seller defines these regions when lis…
2 properties
RatingHistogram
object
The type that defines the fields for product ratings. Only products that are in the eBay product catalog can be reviewed and rated.
2 properties
EconomicOperator
object
The type that provides required Economic Operator information about the manufacturer and/or supplier of the item.
9 properties
CompatibilityPayload
object
An array of attribute name/value pairs used to define a specific product. For example: If you wanted to specify a specific car, one of the name/value pairs wou…
1 property
CompatibilityResponse
object
The type that defines the response fields for checkCompatibility .
2 properties
HazardPictogram
object
A type that defines the pictogram for the type of hazard that a hazardous material represents.
3 properties
HazardousMaterialsLabels
object
A type that defines the hazardous materials labels for an item.
5 properties
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from eBay 12
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
#Item