SearchItem
Container for the data of a single item that matches the search criteria.
Type that uses SearchItem:
Calls that use SearchItem:
findCompletedItems, findItemsAdvanced, findItemsByCategory, findItemsByKeywords, findItemsByProduct, findItemsIneBayStores
Fields
compatibility ( string )
galleryURL ( anyURI )
paymentMethod ( token )
postalCode ( string )
sellerInfo ( SellerInfo )
storeInfo ( Storefront )
viewItemURL ( anyURI )
attribute ( ItemAttribute ) [0..*]
item attribute
See the Field Index to learn which calls use attribute.
If true, the seller requires immediate payment for the item. If false (or not specified), immediate payment is not requested.
Immediate payment does not apply to classified listings nor to auction listings that end with a winning bidder.
Note: The value of the autoPay flag indicates the seller's stated preference only. It does not indicate whether the listing is still a candidate for purchase via immediate payment. For example, if a listing receives bids and no longer qualifies for immediate payment, the value of the autoPay flag does not change.
Immediate payment does not apply to classified listings nor to auction listings that end with a winning bidder.
Note: The value of the autoPay flag indicates the seller's stated preference only. It does not indicate whether the listing is still a candidate for purchase via immediate payment. For example, if a listing receives bids and no longer qualifies for immediate payment, the value of the autoPay flag does not change.
See the Field Index to learn which calls use autoPay.
A unique identification number assigned by eBay to a registered non-profit charity organization.
See the Field Index to learn which calls use charityId.
Starting in March 2010, parts compatibility will be supported in limited Parts & Accessories categories for eBay Motors in the Production environment. For these categories, a compatible application will always be a vehicle, which is specified by a combination of make, model, and year. Optionally, trim and engine data may also be specifed for a vehicle.
This field returns terms from the keywords in the request that match values in one of the item's compatible applications (vehicles). If the keywords match more than one compatible application for an item, the field returns "Two or more of your vehicles" to indicate multiple matches.
For example, keyword queries that contain vehicle details, such as make and model (e.g., Honda Accord), in addition to keywords for the part or accessory, will search through structured parts compatibility information for matching listings. If an item has a 2007 Honda Accord (any trim or engine) specified as a compatible application, and the item matches the part or accessory terms in the query, this field will return the matching terms from the query (i.e., Honda Accord).
Parts compatibility is an eBay feature that uses structured data to associate compatible assemblies with parts and accessories listed on eBay. For example, parts compatibility enables sellers to specify accurately and comprehensively the vehicles on which a side mirror or a rim fit. Parts compatibility improves search relevancy and frees up item titles and descriptions for more useful descriptions of the part.
This field returns terms from the keywords in the request that match values in one of the item's compatible applications (vehicles). If the keywords match more than one compatible application for an item, the field returns "Two or more of your vehicles" to indicate multiple matches.
For example, keyword queries that contain vehicle details, such as make and model (e.g., Honda Accord), in addition to keywords for the part or accessory, will search through structured parts compatibility information for matching listings. If an item has a 2007 Honda Accord (any trim or engine) specified as a compatible application, and the item matches the part or accessory terms in the query, this field will return the matching terms from the query (i.e., Honda Accord).
Parts compatibility is an eBay feature that uses structured data to associate compatible assemblies with parts and accessories listed on eBay. For example, parts compatibility enables sellers to specify accurately and comprehensively the vehicles on which a side mirror or a rim fit. Parts compatibility improves search relevancy and frees up item titles and descriptions for more useful descriptions of the part.
See the Field Index to learn which calls use compatibility.
This container shows the name and unique ID of the item's condition. This container will generally get returned unless the item is in an eBay category that does not require an item condition. Supported item conditions vary by category.
See the Field Index to learn which calls use condition.
Two-letter ISO 3166 country code to indicate the country where the item is located (e.g., "US" for the United States or "GB" for the United Kingdom).
See the Field Index to learn which calls use country.
discountPriceInfo ( DiscountPriceInfo ) [0..1]
The format type of the listing, such as online auction, fixed price, or advertisement.
See the Field Index to learn which calls use discountPriceInfo.
The distance that the item is from the buyer, calculated using buyerPostalCode. The unit for distance varies by site, and is either miles or kilometers. If the country whose site you are searching uses kilometers to measure distance (for example, India/EBAY-IN), the unit is kilometers. If the site is either the US or UK, the distance unit is miles.
This value is only returned for distance-based searches. You must specify a buyerPostalCode and either sort by Distance, or use a combination of the MaxDistance LocalSearch itemFilters.
This value is only returned for distance-based searches. You must specify a buyerPostalCode and either sort by Distance, or use a combination of the MaxDistance LocalSearch itemFilters.
See the Field Index to learn which calls use distance.
Indicates whether the item is ebayPlus item. A eBayPlus item:
- Cassini returns the ebayPlus flag;/li> This field is returned for the following sites only: DE (EBAY-DE)
See the Field Index to learn which calls use eBayPlusEnabled.
eek status of the item
See the Field Index to learn which calls use eekStatus.
galleryInfoContainer ( GalleryInfoContainer ) [0..1]
Contains three URLs for item thumbnail images in standard sizes. Not returned if the item has no images. That is, if the item was not listed using a product identifier and the seller has not uploaded images, the container will not be returned, even when the outputSelector is set to GalleryInfo.
See the Field Index to learn which calls use galleryInfoContainer.
URL for the Gallery Plus image. The size of Gallery Plus images (up to 500 pixels on the longest side) is bigger than the size of standard gallery images. In site search results, you can view the Gallery Plus image by hovering over or clicking the Enlarge link or magifying glass icon. This field is only returned when the seller has opted for the Gallery Plus option for the given item.
See the Field Index to learn which calls use galleryPlusPictureURL.
URL for the Gallery thumbnail image. Returned only if the seller uploaded images for the item or the item was listed using a product identifier.
See the Field Index to learn which calls use galleryURL.
The identifier for the site on which the item is listed. Returns a Global ID, which is a unique identifier that specifies the combination of the site, language, and territory. In other eBay APIs (such as the Shopping API), this value is know as the site ID.
See the Field Index to learn which calls use globalId.
Not used by any call.
return true if the item is a multi-variation listing
return true if the item is a multi-variation listing
See the Field Index to learn which calls use isMultiVariationListing.
The ID that uniquely identifies the item listing. eBay generates this ID when an item is listed. ID values are unique across all eBay sites.
See the Field Index to learn which calls use itemId.
listingInfo ( ListingInfo ) [0..1]
The format type of the listing, such as online auction, fixed price, or advertisement.
See the Field Index to learn which calls use listingInfo.
Physical location of the item, as specified by the seller. This gives a general indication from where the item will be shipped (or delivered).
See the Field Index to learn which calls use location.
Identifies the payment method (or methods) available to the buyer to purchase the item.
See the Field Index to learn which calls use paymentMethod.
URL for item's picture url with size 400x400
See the Field Index to learn which calls use pictureURLLarge.
URL for item's picture url with size 800x800
See the Field Index to learn which calls use pictureURLSuperSize.
The postal code where the listed item is located. This field is returned only if a postal code has been specified by the seller. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned via the API.
eBay proximity and local search behavior can use the combination of buyerPostalCode and postalCode values.
eBay proximity and local search behavior can use the combination of buyerPostalCode and postalCode values.
See the Field Index to learn which calls use postalCode.
Details about the first (or only) category in which the item is listed. Note that items can be listed in more than a single category.
See the Field Index to learn which calls use primaryCategory.
Unique identifier for the eBay catalog product with which the item was listed. An eBay catalog product consists of pre-filled Item Specifics, additional descriptive information, plus a stock photo (if available). These product details are used to pre-fill item information, which is used to describe the item and can also help surface the item in searches.
eBay supports the following types of product ID types: ISBN, UPC, EAN, and ReferenceID (ePID, also known as an eBay Product Reference ID). ReferenceID values are returned when available. A UPC, ISBN, or EAN product identifier will be returned only when a ReferenceID is not available.
This productId value can be used as input with findItemsByProduct to retrieve items that were listed with the specified eBay catalog product.
This field is only returned when a product was used to list the item.
eBay supports the following types of product ID types: ISBN, UPC, EAN, and ReferenceID (ePID, also known as an eBay Product Reference ID). ReferenceID values are returned when available. A UPC, ISBN, or EAN product identifier will be returned only when a ReferenceID is not available.
This productId value can be used as input with findItemsByProduct to retrieve items that were listed with the specified eBay catalog product.
This field is only returned when a product was used to list the item.
See the Field Index to learn which calls use productId.
This is set to true if the seller accepts return of the item.
See the Field Index to learn which calls use returnsAccepted.
Details about the second category in which the item is listed. This element is not returned if the seller did not specify a secondary category.
See the Field Index to learn which calls use secondaryCategory.
sellerInfo ( SellerInfo ) [0..1]
Information about the item's seller. Only returned if SellerInfo is specified in the outputSelector field in the request.
See the Field Index to learn which calls use sellerInfo.
sellingStatus ( SellingStatus ) [0..1]
Specifies the item's selling status with regards to eBay's processing workflow.
See the Field Index to learn which calls use sellingStatus.
shippingInfo ( ShippingInfo ) [0..1]
Container for data about a listing's shipping details.
See the Field Index to learn which calls use shippingInfo.
storeInfo ( Storefront ) [0..1]
Information about the eBay store in which the item is listed. Only returned if the item is listed in a store and StoreInfo is specified in the outputSelector field in the request.
See the Field Index to learn which calls use storeInfo.
Subtitle of the item. Only returned if the seller included a subtitle for the listing.
See the Field Index to learn which calls use subtitle.
Name of the item as it appears in the listing title, or in search and browse results.
See the Field Index to learn which calls use title.
Indicates whether the item is Top Rated Plus item. A top rated plus item:
- is listed by experienced sellers with highest buyer ratings;/li>
- Sellers commit to shipping your items in a business day with tracking provided and offer at least a 14-day, money-back return policy;/li> This field is returned for the following sites only: US (EBAY-US)
See the Field Index to learn which calls use topRatedListing.
unitPrice ( UnitPriceInfo ) [0..1]
Unit price information of the item
See the Field Index to learn which calls use unitPrice.
The URL to view this specific listing on eBay.
The returned URL is optimized to support natural search. That is, the URL is designed to make items on eBay easier to find via popular internet search engines. The URL includes the item title along with other optimizations.
If you enabled affiliate tracking in the call, viewItemURL contains a string that includes affiliate tracking information.
Note: eBay URLs returned in fields, such as viewItemURL, are subject to syntax and other changes without notice. To avoid problems in your application when eBay alters the URL format, we advise you to avoid parsing eBay URLs programmatically. We strive to ensure that other fields in the response contain all the information that is encoded in the URL, and more.
The returned URL is optimized to support natural search. That is, the URL is designed to make items on eBay easier to find via popular internet search engines. The URL includes the item title along with other optimizations.
If you enabled affiliate tracking in the call, viewItemURL contains a string that includes affiliate tracking information.
Note: eBay URLs returned in fields, such as viewItemURL, are subject to syntax and other changes without notice. To avoid problems in your application when eBay alters the URL format, we advise you to avoid parsing eBay URLs programmatically. We strive to ensure that other fields in the response contain all the information that is encoded in the URL, and more.
See the Field Index to learn which calls use viewItemURL.