eBay BestMatchItemDetails API
Call Reference Version 1.3.0

If true, the seller requests immediate payment for the item. If false (or not specified), immediate payment is not requested. If true, it does not indicate that the item is still a candidate for purchase via immediate payment, however it does indicate the original status of the item listing.

Only applicable to items listed on PayPal-enabled sites and in categories that support immediate payment (see AutoPayEnabled in GetCategories). In addition, the seller must have a Premier or Business PayPal account (see PayPalAccountType in GetUser) and they must accept PayPal as a payment method (see item.paymentMethod).

See the eBay Web Services guide section on Requiring Immediate Payment for additional requirements and dependencies. Also see the section on working with the eBay Motors site for additional rules. Not applicable to Half.com.

Container for the best match data for the item. This data is returned only for items that belong to the authorized caller; the service does not return Best Match data for items that were not listed by the caller of the function.

A unique identification number assigned by eBay to registered nonprofit charity organizations. Not returned if the item is not listed as a charity item.

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.

Two-letter ISO 3166 country code to indicate the country where the item is located. For English names that correspond to each code (e.g., KY="Cayman Islands"), see the ISO site:
http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/list-en1.html.

URL for the Gallery Plus image. The size of Gallery Plus images (up to 400 x 400 pixels) 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. The image uses one of the following graphics formats: JPEG, BMP, TIFF, or GIF. This field is only returned when the seller has opted for the Gallery Plus option for the given item.

URL for the picture used for the Gallery thumbnail, if any. The image uses one of the following graphics formats: JPEG, BMP, TIF, or GIF. Only returned if the seller chose to show a gallery image.

A token that represents the eBay site on which the item was originally listed. For example, if the item was listed on the eBay US site, the value is US. If item was listed on the eBay Germany site, the value is DE. For a list of possible enumeration values and how they map to eBay sites, see Global ID Values.

Where the item was listed can affect the values of converted (localized) prices. This occurs when the site from which your request is sent is different from the site on which the item was listed.

An identification number that uniquely identifies a listed item. eBay generates this ID when an item is listed and the ID is unique across all eBay sites.

Absolute rank of the item, across the groups, in relation to all returned items.

Rank of the item in relation to the other returned items in the same group. Item groups are Featured and Best Match. For media items, groups can be Brand New, Like New, Very Good, Good, and Acceptable.

Container for listing information related to the item. The information includes the item's listing format (online auction, fixed price, and so on), if Buy It Now is enabled, and more.

Physical location of the item, as specified by the seller. (This gives a general indication of from where the item will be shipped or delivered.)

Identifies the payment method(s) the seller will accept from the buyer. An example is PayPal.

Note: If the seller accepts only PayPal, the buyer can still pay with a credit card. PayPal supports major credit cards.

Payment methods are not applicable to eBay Real Estate advertisement listings or other Classified Ad format listings.

The postal code of where the item is located. Not returned if seller did not specify their postal code.

Container for the numeric ID and name of the first (or only) category in which the item is listed. Note that listings can appear in more than a single category.

Product ID type and product ID code if the item is a catalogue item. Not returned if the item is not listed as a product.

Quantity of available items in the listing.

Number of listing items sold.

Container for the numeric ID and name of the second category in which the item is listed, if the seller listed in a secondary category.

Container for information about the listing's seller. Returned if outputSelector is set to SellerInfo.

Signifies the listing's selling status in eBay's processing workflow.

Container for information about the listing's shipping details.

Container for information about the eBay store in which the item was listed. Not returned if the item is not listed in an eBay store.

Subtitle of the item. Only returned if the seller included a subtitle with the listing.

Name of the item listing as it appears in search and browse results.

The URL to view this listing on eBay. This URL is optimized to support natural search. That is, this URL is designed to make items on eBay easier to find via popular Internet search engines.

Specifically, the URL specifies the item title and it is optimized for natural search: " _W0QQ" is like "?" (question mark), "QQ" is like "&" (ampersand), and "Z" is like "=" (equals sign). Do not modify the returned URL syntax in your application. For example, eBay won't recognize the URL if you change QQ to ?. In the Sandbox environment and on the Hong Kong site (site ID 201), the data returned in this field is a standard ViewItem URL, rather than the ViewItem URL for Natural Search that is normally returned in the Production environment.