eBay Shopping API
Call Reference Version 577

If true, the seller requests immediate payment for the item. If false or not specified, immediate payment is not requested. (In responses, does not indicate whether the item is actually still a candidate for purchase via immediate payment.)

Only applicable to items listed on PayPal-enabled sites in categories that support immediate payment (see AutoPayEnabled in GetCategories), when seller has a Premier or Business PayPal account (see PayPalAccountType in Getuser). If true, the seller must also accept PayPal as a payment method for the item (see Item.PaymentMethods).

Required for digitally delivered goods (see Item.DigitalDeliveryDetails).

Not supported if ThirdPartyCheckout is true.

See the eBay Web Services guide section on 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.

Whether the seller will accept a best offer for this item. This feature enables a buyer to make a lower-priced binding offer on a fixed price item. Buyers can't see how many offers have been made (only the seller can see this information). To make a best offer on a listing, use the eBay Web site.

The number of bids that have been placed on the item.

On most sites, once a Chinese auction has bids, the listing is no longer eligible for Buy It Now. (This is not necessarily true for Dutch auctions. See Item.BuyItNowAvailable for Dutch auctions.)

Returns the seller's information (in a business card format) for the GetSingleItem call, if the seller's SellerBusinessCodeType is set to 'Commercial'. This is only applicable for sites where Business Seller options are supported.

For Dutch auctions (not Chinese auctions) this indicates whether there is a Buy It Now option. (On some sites, the Buy It Now option remains available for Dutch auctions even after there are bids.) Applicable to the Germany site (site ID 77) only.

The Buy It Now Price of the item (if any), in the currency of the site on which the item was listed.

For Chinese auctions (Quantity=1, competitive bidding online auctions), Buy It Now lets a user purchase the item at a fixed price and end the auction immediately. On most sites, after a Chinese auction has bids, the listing is no longer eligible for Buy It Now. However, calls can still return the Buy It Now Price that the seller set for the listing. Use the Item.BidCount field to determine whether an auction with Buy It Now has bids or not.

Some eBay sites also support Buy It Now for Dutch auctions (multi-quantity, competitive bidding), where you can buy multiple items from the same listing at a fixed price, instead of bidding. On some sites, the Buy It Now option remains available for Dutch auctions even after there are bids. See Item.BuyItNowAvailable.

For fixed-price (FixedPriceItem) and Store Inventory listings (StoresFixedPrice), see CurrentPrice or ConvertedCurrentPrice instead.

Only returned if an item was listed with Buy It Now.

Identifier for a Giving Works listing and the benefiting nonprofit charity organization.

The listing's Buy It Now Price (if any), converted into the currency of the site to which you sent this request.

Price fields are returned as doubles, not necessarily in the traditional monetary format of the site's country. For example, a US Dollar value might be returned as 3.880001 instead of 3.88.

For Chinese auctions (Quantity=1, competitive bidding online auctions), Buy It Now lets a user purchase the item at a fixed price and end the auction immediately. On most sites, after a Chinese auction has bids, the listing is no longer eligible for Buy It Now. However, calls like FindItems still return the Buy It Now Price that the seller set for the listing. Use the Item.BidCount field to determine whether an auction with Buy It Now has bids or not (and therefore whether it is still eligible to be purchased with Buy It Now).

Some eBay sites also support Buy It Now for Dutch auctions (multi-quantity, competitive bidding), where you can buy multiple items from the same listing at a fixed price, instead of bidding. On some sites, the Buy It Now option remains available for Dutch auctions even after there are bids. See Item.BuyItNowAvailable.

For fixed-price (FixedPriceItem) and Store Inventory listings (StoresFixedPrice), see CurrentPrice or ConvertedCurrentPrice instead.

Only returned if an item was listed with Buy It Now.

For active items, refresh this value every 24 hours to pick up the current conversion rates (if this value has been converted).

The listing's current price, converted to the currency of the site specified in the request. If the item is a multi-quantity listing, this is the price of one item.

Price fields are returned as doubles, not necessarily in the usual monetary amount format of the site. For example, a US Dollar value might be returned as 3.879938 instead of 3.88.

For competitive-bidding listings (Chinese and Dutch auctions), this is the current minimum bid price (if the listing has no bids) or the current high bid (if the listing has bids). (Compare to BuyItNowPrice).

For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), and Ad format (AdType) listings, this is the current fixed price.

For active items, refresh this value every 24 hours to pick up the current conversion rates (if this value has been converted).

Two-letter ISO 3166 country code to indicate the country where the item is located.

The current price of the item, in the currency of the site on which the item was listed. That is, CurrentPrice is in the original listing currency. If the item is a multi-quantity listing, this is the price of one item.

For competitive-bidding listings (Chinese and Dutch auctions), this is the current minimum bid price (if the listing has no bids) or the current high bid (if the listing has bids). (Compare to BuyItNowPrice).

For Basic Fixed-Price (FixedPriceItem), Store Inventory (StoresFixedPrice), and Ad format (AdType) listings, this is the current fixed price.

The seller's description of the item, if any. This can include HTML markup and JavaScript. See string in Simple Schema Types.

Some sellers don't specify their own listing description. Instead, they use a stock description from a catalog available through eBay. (GetSingleItem doesn't return this stock information.)

The distance of the item from the buyer.

Time stamp (in GMT) of when the listing is scheduled to end, or time stamp of the actual end time (if the item ended). In FindItemsAdvanced and FindItems, for StoresFixedPrice items which are "Good Till Canceled," this value is 5 minutes later than the actual end time of the item. The discrepancy is intended to facilitate renewal every 30 days of such items' end times.

URL for a picture used as 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.

The item is featured in eBay search results on the mobile.de partner site. Applicable to eBay Germany.

A Get It Fast listing.

If true, a generic gift icon displays next the listing's title in search and browse pages.

Half condition codes like brand new etc

For single-item (Quantity = 1) auction listings (Chinese type) that have ended and have a winning bidder, indicates the user who is the current high bidder.

For single-item basic fixed price (FixedPriceItem) or Store Inventory (StoresFixedPrice) listings that have ended, indicates the user who purchased the item.

Not returned for auctions that have received no bids; fixed price and Store Inventory listings that are still active; or any multi-item (Quantity > 1) listings (Dutch, FixedPriceItem, StoresFixedPrice).

The number of times the listing's View Item page has been viewed (as determined by eBay). Only returned if the seller has chosen to include a hit counter in the listing, and if the seller has also chosen to make the listing's hit count publicly visible. This field is retrieved asynchronously. If you believe the item has a publicly visible hit count, but this field is not returned, retry the call.

The ID that uniquely identifies the item listing. eBay generates this ID when an item is listed. This ID is unique across all eBay sites.

Category-specific fields that the seller added to describe the listing. The names of these fields are different for items in different categories, so they're returned in a generic name/value structure. The field names are usually very well known within the category.

For example, a book's item specifics might include a field like Publication Year=2007 (where Publication Year is returned in Name, and 2007 is returned in Value), and a field like Format=Hardcover. But a car's item specifics would be different from a book's, with fields like Make=Toyota and Model=Prius. And a ticket's item specifics would be different from those of books and cars, with fields like EventType=Concerts and Venue=The Fillmore.

Some of the most common uses for item specifics are the item condition and return policy. The return policy can include multiple name/value fields (to explain how soon the item must be returned, how soon the refund will be given, and so forth).

Only contains data if the listing includes Item Specifics.

Specifies a listing's status in eBay's processing workflow. If an item's EndTime is in the past, but no details about the buyer or high bidder are shown (and the user is not anonymous), use this listing status information to determine whether eBay has finished processing the listing.

The format of the listing, such as online auction, fixed price, or advertisement format.

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

Smallest amount the next bid on the item can be. Returns same value as Item.StartPrice (if no bids have yet been placed) or CurrentPrice plus BidIncrement (if at least one bid has been placed). Only applicable to Chinese and Dutch auction listings. Returns null for basic Fixed Price (FixedPriceItem),Store Inventory (StoresFixedPrice), and Ad type listings.

Identifies the payment method (such as PayPal) the seller will accept when the buyer pays for the item.

Note: If the seller only accepts 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.

Whether the item has a picture.

Contains the URL for an image associated with the item, if any. Only returned if the seller chose to include at least one picture in the listing. (This doesn't return URLs of pictures that the seller specified via HTML IMG tags in Description.)

Items listed the main eBay site can have a maximum of 12 picture URLs hosted by eBay Picture Services or a maximum of 6 picture URLs hosted by a third party (such as the seller or a photo site). On the US eBay Motors site (for all vehicle listings), and on the eBay Canada Motors site, a listing can have up to 24 picture URLs.

eBay uses the seller's first picture at the top of the listing's View Item page.

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

Numeric ID of the first (or only) category in which the item is listed. (Listings can appear in more than one category.)

Note: Currently, GetSingleItem does not return a listing's secondary category, if any.

The fully qualified ID breadcrumb (path) of the first category. For example, if the primary category ID is 45678, and its parent category's ID is 123, the breadcrumb (path) would be 123:45678.

Display name of the first (or only) category in which the item is listed. This is a fully qualified category breadcrumb (e.g., Computers & Networking:Laptops, Notebooks).

A prototype description of a well-known type of item, such as a popular book.

When returned for GetSingleItem, is always of type Reference, and serves as a global reference ID for an eBay catalog product.

When used as input, retrieves product details for one specific product. Specify the ID as a string, and use the type attribute to indicate the nature of the ID you are specifying.

The request requires either QueryKeywords or ProductID, but these fields cannot be used together.

The number of items the seller is offering in the listing. (Subtract Item.QuantitySold from this value to calculate the number of items currently available for sale.)

If an online auction (with competitive bidding) has a Quantity of 1, it's a Chinese auction. If Quantity is greater than 1,it's a Dutch auction.

Basic fixed-price and Store Inventory listings can have a Quantity of 1 or more.

The listing's current or Buy It Now price is the price of 1 item in the listing.

Note: A seller can also offer multiple items for sale with a single price for all the items. For example, instead of listing 10 lightbulbs for US 2.00 each, they might list 10 lightbulbs for USD 20.00 (where you have to buy all 10). This is called a "lot". If the listing includes a lot (or multiple lots), Quantity does not specify the lot size; it only reflects how many lots are being sold. For example, if the listing includes 5 lots of 10 lightbulbs each, Quantity would be 5. (GetSingleItem does not return information about lot sizes.)

Number of items purchased so far from this listing. (Subtract this value from Item.Quantity to calculate the number of items currently available for sale.)

Whether the item is no more than one day old.

Indicates whether any bids on this item are greater than the seller's reserve price for the listing (if any).

A reserve is the lowest price at which the seller is willing to sell the item. The reserve price is higher than the listing's opening bid (minimum bid) and lower than the Buy It Now price, if any. (The reserve price is only known to the seller.) Some sellers don't set a reserve at all. If a listing does have a reserve price, the highest bidder will only win the item if their bid is also above that price.

Only returned for online auctions that have a reserve price. (Fixed price, Store Inventory, and classified ad listings don't have reserve prices.)

If a seller specified return policy details, then this container has fields with those details. The fields that can be returned in this container vary by site.

ID of the second category in which the item is listed.

The fully qualified ID breadcrumb (path) of the second category. For example, if the secondary category ID is 45678, and its parent category's ID is 123, the breadcrumb (path) would be 123:45678.

Name of the second category in which the item is listed.

Container for information about this listing's seller.

Seller notes while listing items.

Contains basic shipping-related costs for the item. If Item.Quantity is greater than 1, this is the shipping cost for one item. If the seller offers a choice of more than one shipping service (such as UPS Ground and USPS Media mail), this is the cost of the "first" shipping option (usually the lowest cost option).

If a listing has shipping costs, use GetShippingCosts if you want to get more details about the services and costs that the seller is offering.

An international location or region to which the seller is willing to ship this item. Returned only for items that have ShipToLocations specified.


Applicable values:

•   Americas

(North, South, or Latin America)

•   Asia

•   Caribbean

•   Europe

•   EuropeanUnion

•   LatinAmerica

•   MiddleEast

•   NorthAmerica

•   Oceania

(Pacific region other than Asia)

•   SouthAmerica

•   WillNotShip

(No shipping, buyer must pick up the item)

•   Worldwide

(Seller will ship worldwide)

•   2-letter country identifier

(See CountryCodeType for values)

The name of the eBay site on which the item was originally listed. For example, if the item is listed on the eBay US site, the value would be US. If it's listed on the eBay Germany site, the value would be Germany.

The listing's original site can affect the values of converted (localized) prices (when your request specifies a site that is different from the listing's site).

Time stamp (in GMT) that eBay recorded as the moment that the listing was made available. The start time returned by a search call may vary from the value returned by GetSingleItem.

Whether the item is a storefront listing.

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

For US eBay Motors passenger vehicle, motorcycle, and "other vehicle" categories or listings in CA eBay Motors passenger vehicle and motorcycle categories, see the ItemSpecifics node for the subtitle instead.

Time left before the listing ends. The duration is represented in the ISO 8601 duration format (PnYnMnDTnHnMnS). For ended listings, the time left is PT0S (zero seconds).

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

For US eBay Motors cars, trucks, and motorcycles, this value shows the vehicle Make and Model instead of the seller's own title. (For the seller's title, look for Subtitle in Item.ItemSpecifics.NameValueList.Name in GetSingleItem, and then use the corresponding value in Item.ItemSpecifics.NameValueList.Value.)

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. For example, this 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). You shouldn't modify the query 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 by FindItemsAdvanced is a standard ViewItem URL, rather than the ViewItem URL for natural search that generally is returned in the Production environment.

Watch count for the item.