eBay Finding APIVersion 1.13.0

FindItemsByImageRequest ( BestMatchFindingServiceRequest )

Find items based on the image similarity to the specified item.

Call that uses FindItemsByImageRequest:

Fields



aspectFilter ( AspectFilter ) [0..*]
Aspect filters refine (limit) the number of items returned by a find request. Obtain input values for the aspectFilter fields from an aspectHistogramContainer returned in the response of a previous query.

By issuing a series of find queries, you can continually refine the items returned in your responses. Do this by repeating a query using the aspect values returned in one response as the input values to your next query.

For example, the aspectHistogramContainer in a response on Men's Shoes could contain an aspect of Size, along with "aspect values" for the different sizes currently available in Men's Shoes. By populating aspectFilter fields with the values returned in an aspectHistogramContainer, you can refine the item results returned by your new query.
See the Field Index to learn which calls use aspectFilter.

categoryId ( string ) [0..*]
Specifies the leaf category from which you want to retrieve item listings with similar images. If no category is specified, search results can come from any Clothing, Shoes & Accessories leaf category. This field can be repeated (up to 3 times) to include multiple categories.

Image similarity searches are only supported in Clothing, Shoes & Accessories leaf categories on the eBay US, UK, and Germany sites.

If a specified category ID doesn't match an existing category for the site, eBay returns an invalid-category error message. To determine valid leaf categories, use the Trading API GetCategories call.
See the Field Index to learn which calls use categoryId.

domainFilter ( DomainFilter ) [0..*]
Restricts results to items listed within the specified domain. Domains are a buy-side grouping of items. such as shoes or digital cameras. A domain can span multiple eBay categories.
See the Field Index to learn which calls use domainFilter.

itemFilter ( ItemFilter ) [0..*]
Reduce the number of items returned by a find request using item filters. Use itemFilter to specify name/value pairs. You can include multiple item filters in a single request.
See the Field Index to learn which calls use itemFilter.

itemId ( string ) [1]
Specifies the item that the customer wants to use for retrieving more listings with similar images. The item must active and it must be listed in a Clothing, Shoes & Accessories category (parent category ID 11450 on the eBay US site).
See the Field Index to learn which calls use itemId.

outputSelector ( OutputSelectorType ) [0..*]
Defines what data to return, in addition to the default set of data, in a response.

If you don't specify this field, eBay returns a default set of item fields. Use the outputSelector to include more information in the response. The additional data is grouped into discrete nodes. You can specify multiple nodes by including this field multiple times, as needed, in the request.

If you specify this field, the additional fields returned can affect the call's response time (performance), including in the case with feedback data.
See the Field Index to learn which calls use outputSelector.