eBay Merchandising APIVersion 1.5.0

Item

Contains details for an active item listing.

Type that uses Item:

Calls that use Item:

Fields



bidCount ( int ) [0..1]
The number of bids that have been placed on the item.
See the Field Index to learn which calls use bidCount.

buyItNowPrice ( Amount (double) ) [0..1]
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.

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

Only returned if an item was listed with Buy It Now.
See the Field Index to learn which calls use buyItNowPrice.

country ( string ) [0..1]
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.
See the Field Index to learn which calls use country.

currentPrice ( Amount (double) ) [0..1]
For competitive-bidding listings (Chinese and Dutch auctions), current minimum asking price (start price) or the current highest bid for the item if bids have been placed. Shows minimum bid if no bids have been placed on the item. For Basic Fixed-Price, Store Inventory, or Ad type listings, this returns the original price specified when the item was listed/re-listed or the revised price if the item was revised.
See the Field Index to learn which calls use currentPrice.

discountPriceInfo ( DiscountPriceInfo ) [0..1]
This container provides information for an item that has a Strikethrough Price (STP) or a Minimum Advertised Price (MAP) discount pricing treatment. STP and MAP apply only to fixed-price listings and auction listings with the Buy It Now option. STP is available on the US, UK, and German (DE) sites, while MAP is available only on the US site.

Discount pricing is available to qualified sellers (and their associated developers) who participate in the Discount Pricing Program. Once qualified, sellers receive a "special account flag" (SAF) that allows them to apply Discount Pricing to both single-variation and multi-variation items. Sellers should contact their account manager or Customer Service to see if they qualify for the Strikethrough Pricing program.

As a seller listing Discount Price items, you are required to maintain records of your discount pricing in the event you are called upon to substantiate your item pricing. The following link details your legal obligations when you utilize Discount Pricing to sell items: Strikethrough Pricing Requirements

For AddFixedPriceItem, RelistFixedPriceItem, ReviseFixedPriceItem, and VerifyAddFixedPriceItem: If you are listing variations (MSKU items), use Variation.DiscountPriceInfo for each variation.
See the Field Index to learn which calls use discountPriceInfo.

globalId ( string ) [0..1]
The site upon which the item is listed. Returns a Global ID, which is a unique identifier for combinations of site, language, and territory.

For a list of possible enumeration values and how they map to eBay sites, see Global ID Values.
See the Field Index to learn which calls use globalId.

imageURL ( anyURI ) [0..1]
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.
See the Field Index to learn which calls use imageURL.

itemId ( string ) [1]
The ID that uniquely identifies the item listing. The ID is generated by eBay after an item is listed. You cannot choose or revise this value.
See the Field Index to learn which calls use itemId.

originalPrice ( Amount (double) ) [0..1]
Original price of an item whose price a seller has reduced with the Promotional Price Display feature. Only returned if the price has been revised.
See the Field Index to learn which calls use originalPrice.

primaryCategoryId ( string ) [0..1]
Numeric ID of the first (or only) category in which the item is listed. (Listings can appear in more than one category.)
Note: Currently, the Merchandising API calls do not return a listing's secondary category, if any.
See the Field Index to learn which calls use primaryCategoryId.

primaryCategoryName ( string ) [0..1]
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).
See the Field Index to learn which calls use primaryCategoryName.

shippingCost ( Amount (double) ) [0..1]
The shipping cost associated with the first shipping service. Only returned when shipping type is flat.
See the Field Index to learn which calls use shippingCost.

shippingType ( string ) [0..1]
The shipping cost model offered by the seller.

Applicable values:
Calculated
Calculated shipping model: the cost of shipping is determined in large part by the seller-offered and buyer-selected shipping service. The seller might assess an additional fee via PackagingHandlingCosts.
CalculatedDomesticFlatInternational
The seller specified one or more calculated domestic shipping services and one or more flat international shipping services.
Flat
Flat shipping model: the seller establishes the cost of shipping and cost of shipping insurance, regardless of what any buyer-selected shipping service might charge the seller.
FlatDomesticCalculatedInternational
The seller specified one or more flat domestic shipping services and one or more calculated international shipping services.
Free
Free shipping: Seller has specified free shipping for the item. The cost of shipping is zero for the first domestic shipping service (for flat or calculated shipping).
Freight
Freight shipping model: The cost of shipping is determined by a third party, FreightQuote.com, based on the item location (zip code).
NotSpecified
The seller did not specify the shipping type.
See the Field Index to learn which calls use shippingType.

subtitle ( string ) [0..1]
Subtitle of the item. Only returned if the seller included a subtitle for the listing.

Note: Due to an eBay platform change in January 2015, this field is no longer supported for the getSimilarItems and getMostWatchedItems calls. It is returned in the response but will always be blank.
See the Field Index to learn which calls use subtitle.

timeLeft ( duration ) [0..1]
Time left before the item listing ends. The duration is represented in the ISO 8601 duration format (PnDTnHnMnS). For ended listings, the time left is P0DT0H0M0S (zero days, zero hours, zero minutes, and zero seconds).
See the Field Index to learn which calls use timeLeft.

title ( string ) [1]
Name of the item as it appears in the listing or search results.
See the Field Index to learn which calls use title.

viewItemURL ( anyURI ) [1]
The URL of the web page where a user can view the listing. On the US site, this is called the "View Item" page. If you enabled affiliate tracking in the call, viewItemURL contains a string that includes affiliate tracking information (see the eBay Partner Network).
See the Field Index to learn which calls use viewItemURL.

watchCount ( int ) [0..1]
The number of watches placed on this item from buyers' My eBay accounts.
See the Field Index to learn which calls use watchCount.