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

The Item_summary API from eBay — 2 operation(s) for item_summary.

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

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

2 operations 2 paths 22 schemas 1 GET1 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 Item_summary 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 2

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

Item_summary 2
GET
/item_summary/search
This method searches for eBay items by various query parameters and retrieves summaries of the items. You can search by keyword, category, eBay product ID (ePID), or GTIN, charity ID, or a combinatio…
search 16 params → 200400409500
POST
/item_summary/search_by_image
Note: This is an experimental method that is available to select developers approved by business units. For information about how to obtain access to this API in production, refer to the Buy APIs Req…
searchByImage 12 params body → 200400409500

Schemas 22

The contract defines 22 schemas that model the data the API accepts and returns. The most detailed are ItemSummary (43 properties), SearchPagedCollection (10 properties), Error (9 properties), ItemLocationImpl (7 properties). Each schema is shown below with its type and property counts.

AutoCorrections
object
1 property
ItemLocationImpl
object
The type that defines the fields for the location of an item, such as information typically used for an address, including postal code, county, state/province,…
7 properties
Refinement
object
This type defines the fields for the various refinements of an item. You can use the information in this container to create histograms, which help shoppers ch…
5 properties
ConditionDistribution
object
The container that defines the fields for the conditions refinements. This container is returned when fieldgroups is set to CONDITIONREFINEMENTS or FULL in the…
4 properties
TargetLocation
object
The type that defines the fields for the distance between the item location and the buyer's location.
2 properties
MarketingPrice
object
The type that defines the fields that describe a seller discount.
4 properties
AspectDistribution
object
The type that define the fields for the aspect information. Aspects are the variations of an item, such as color, size, etc.
2 properties
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
CategoryDistribution
object
The container that defines the fields for the category refinements. This container is returned when fieldgroups is set to CATEGORYREFINEMENTS or FULL in the re…
4 properties
ItemSummary
object
The type that defines the fields for the details of a specific item.
43 properties
SearchPagedCollection
object
The type that defines the fields for a paginated result set. The response consists of 0 or more sequenced pages where each page has 0 or more items.
10 properties
ShippingOptionSummary
object
The type that defines the fields for the shipping information.
5 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
Error
object
The type that defines the fields that can be returned in an error.
9 properties
PickupOptionSummary
object
The type that defines the fields for the local pickup options that are available for the item. It is used by the pickupOptions container.
1 property
Category
object
This type is used by the categories container in the response of the search method, and contains the name and ID of the item category.
2 properties
Seller
object
The type that defines the fields for basic information about the seller of the item returned by the itemsummary resource.
4 properties
CompatibilityProperty
object
This container returns the product attribute name/value pairs that are compatible with the keyword. These attributes are submitted in the compatibilityfilter r…
3 properties
BuyingOptionDistribution
object
The container that defines the fields for the buying options refinements. This container is returned when fieldgroups is set to BUYINGOPTIONREFINEMENTS or FULL…
3 properties
ErrorParameter
object
An array of name/value pairs that provide details regarding the error.
2 properties
AspectValueDistribution
object
The container that defines the fields for the conditions refinements. This container is returned when fieldgroups is set to ASPECTREFINEMENTS or FULL in the re…
3 properties
SearchByImageRequest
object
The type that defines the fields for the image information.
1 property

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

ebay-item-summary-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