eBay Merchandising APIVersion 1.5.0
 

GetSimilarItemsRequest ( BaseMerchandisingServiceRequest )

Retrieves recommended similar items for a specified item. Items are considered similar if they can serve as a replacement for the specified item. Similar items from a catalog are associated with the same product. For items not associated with a product, similarity with other items is determined from keywords in the title and attribute value matches. This call can be used to recommend items to buyers who have lost items they were bidding on, or to recommend items as alternatives for watched items that have ended.

The recommended similar items returned can be restricted by category, maximum price, or end time for the listing.

The request must include itemId.

Note: Due to an eBay platform change in January 2015, the country code IN (India) is no longer supported for this call.

Call that uses GetSimilarItemsRequest:

Fields



categoryId ( string ) [0..*]
Results are limited to items from the specified category only. Up to three category IDs can be specified. You cannot specify both categoryId and categoryIdExclude in the same request.
See the Field Index to learn which calls use categoryId.

categoryIdExclude ( string ) [0..*]
Items from the specified category are excluded from the results. Up to three category IDs can be specified. You cannot specify both categoryId and categoryIdExclude in the same request.
See the Field Index to learn which calls use categoryIdExclude.

endTimeFrom ( dateTime ) [0..1]
Limits the results to items ending after the specified time. Specify a time in the future. If you specify a time in the past, the current time is used. Specify the time in GMT.
See the Field Index to learn which calls use endTimeFrom.

endTimeTo ( dateTime ) [0..1]
Limits the results to items ending before the specified time. within a time range. If you are specifying a time range with EndTimeFrom, EndTimeFrom must be specified (with a value equal to or earlier than EndTimeTo). Specify the time in GMT.
See the Field Index to learn which calls use endTimeTo.

itemFilter ( ItemFilter ) [0..*]
Not used by any call.

Due to an eBay platform change in January 2015, this field is no longer supported.
See the Field Index to learn which calls use itemFilter.

itemId ( string ) [1]
The ID of an active item listing or a listing that has ended less than two weeks ago.
See the Field Index to learn which calls use itemId.

listingType ( token ) [0..1]
Filters items based on the format of the listing. If listingType is not specified, all listing types can be returned unless another relevant filter is specified.

Applicable values:
AdType
Advertisement to solicit inquiries on listings such as real estate. Permits no bidding on that item, service, or property. To express interest, a buyer fills out a contact form that eBay forwards to the seller as a lead. This format does not enable buyers and sellers to transact online through eBay, and eBay Feedback is not available for ad format listings.
Chinese
Single-quantity online auction format. A Chinese auction has a Quantity of 1. Buyers engage in competitive bidding, although Buy It Now may be offered as long as no bids have been placed. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.
Dutch
Multiple-quantity online auction format. A Dutch auction has a Quantity greater than 1. Buyers engage in competitive bidding. Some sites also offer Buy It Now for Dutch auctions. Online auctions are listed on eBay.com, and they are also listed in the seller's eBay Store if the seller is a Store owner.
FixedPriceItem
A basic fixed-price item format. Bids do not occur. The quantity of items is one or more. Also known as Buy It Now Only on some sites (not to be confused with the BuyItNow option that is available for Chinese auctions). Fixed-price listings are listed on eBay.com, and they are listed in the seller's eBay Store if the seller is a Store owner.
LeadGeneration
Lead Generation format (advertisement-style listing to solicit inquiries or offers, no bidding or fixed price, listed on eBay).
StoresFixedPrice
A fixed-price format for eBay Store sellers. Store Inventory listings appear after other listings in regular browse and search item lists on eBay. They have a lower Insertion Fee and longer listing durations. Only available to sellers who have an eBay Store. Store Inventory listings are listed on eBay.com, and they are also listed in the seller's eBay Store.
See the Field Index to learn which calls use listingType.

maxPrice ( Amount (double) ) [0..1]
Specifies the maximum current price an item can have to be included in the response. The currencyId you specify must match the currency corresponding to the global ID value passed in the request. If no global ID is specified, you must specify USD.
See the Field Index to learn which calls use maxPrice.