browse APIv1_beta.21.0

Item

Type that defines the fields for the item details for a specific item.

Type that uses Item

Calls that use Item

Fields

Field
Type
Description
additionalImages
array of Image
An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field.
adultOnly
This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers.
ageGroup
(Primary Item Aspect) The age group for which the product is recommended. For example, newborn, infant, toddler, kids, adult, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.
bidCount
This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.
brand
(Primary Item Aspect) The name brand of the item, such as Nike, Apple, etc. All the item aspects, including this aspect, are returned in the localizedAspects container.
buyingOptions
array of string
A comma separated list of all the purchase options available for the item. The values returned are:
  • FIXED_PRICE - Indicates the buyer can purchase the item for a set price using the Buy It Now button.
  • AUCTION - Indicates the buyer can place a bid for the item. After the first bid is placed, this becomes a live auction item and is the only buying option for this item.
  • BEST_OFFER - Indicates the buyer can send the seller a price they're willing to pay for the item. The seller can accept, reject, or send a counter offer. For more information on how this works, see Making a Best Offer.
Code so that your app gracefully handles any future changes to this list.
categoryId
The ID of the leaf category for this item. A left category is the lowest level in the category tree. This category has no children.
categoryPath
Text that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks
color
(Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container.
condition
The text describing the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names.

Code so that your app gracefully handles any future changes to this list.
conditionId
The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names.

Code so that your app gracefully handles any future changes to this list.
currentBidPrice
The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items.
description
The full description of the item that was created by the seller. This can be plain text or rich content.
enabledForGuestCheckout
Indicates if the item can be purchased using Guest Checkout in the Order API. You can use this flag to exclude items from your inventory that are not eligible for Guest Checkout, such as gift cards.
energyEfficiencyClass
Indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models.

When the manufacturer's specifications for this item are available, the link to this information is returned in the productFicheWebUrl field.
epid
An EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs.
estimatedAvailabilities
The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.
gender
(Primary Item Aspect) The gender for the item. This is used for items that could vary by gender, such as clothing. For example: male, female, or unisex. All the item aspects, including this aspect, are returned in the localizedAspects container.
gtin
The unique Global Trade Item number of the item as defined by http://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.
image
The URL of the primary image of the item. The other images of the item are returned in the additionalImages container.
inferredEpid
The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data.

If the seller provided an ePID for the item, the seller's value is returned in the epid field. Note: This field is returned only for authorized Partners.
itemAffiliateWebUrl
The URL of the View Item page of the item, which includes the affiliate tracking ID. This field is only returned if the eBay partner enables affiliate tracking for the item by including the X-EBAY-C-ENDUSERCTX request header in the method.
itemEndDate
The date and time up to which the items can be purchased. This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.
itemId
The unique RESTful identifier of the item.
itemLocation
The physical location of the item.
itemWebUrl
The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.
localizedAspects
An array of containers for the complete list of the name/value pairs that describe the variation of the item.
marketingPrice
The original price and the discount amount and percentage.
material
(Primary Item Aspect) Text describing what the item is made of. For example, silk. All the item aspects, including this aspect, are returned in the localizedAspects container.
minimumPriceToBid
The minimum price of the next bid, which means to place a bid it must to equal to or greater than this amount. If the auction hasn't received any bids, the minimum bid price is the same as the starting bid. Otherwise, the minimum bid price is equal to the current bid plus the bid increment. For details about bid increments, see Automatic bidding.
mpn
The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand.
pattern
(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley. All the item aspects, including this aspect, are returned in the localizedAspects container.
price
The cost of just the item. This amount does not include any adjustments such as discounts, shipping costs, etc.
priceDisplayCondition
An enumeration value that indicates when in the buying flow the item's price can appear for minimum advertised price (MAP) items, which is the lowest price a retailer can advertise/show for this item.

These enumeration values indicate when the MAP can appear in the buying flow; any time, after the item has been added to the cart, or on the checkout page.
primaryItemGroup
The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.

Note: This container is returned only if the item_id in the request is for an item group (items with variations, such as color and size).
primaryProductReviewRating
The container that returns the product rating details, such as review count, rating histogram, and average rating.
product
The container that returns the product information of the item.
productFicheWebUrl
The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating. This field is returned only if this information is available. The EEK rating of the item is returned in the energyEfficiencyClass field.
quantityLimitPerBuyer
The maximum number for a specific item that one buyer can purchase.
reservePriceMet
This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for.

If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold.

Note: This is returned only for auctions that have a reserve price.

returnTerms
The container that returns an overview of the seller's return policy.
seller
The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information.
sellerItemRevision
An identifier generated/incremented when a seller revises the item. There are two types of item revisions; seller changes, such as changing the title, and eBay system changes, such as changing the quantity when an item is purchased. This ID is changed only when the seller makes a change to the item. This means you cannot use this value to determine if the quantity has changed.
shippingOptions
An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option.
shipToLocations
The container that returns the geographic regions to be included and excluded that define where the item can be shipped.
shortDescription
This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.).
size
(Primary Item Aspect) The size of the item. For example, '7' for a size 7 shoe. All the item aspects, including this aspect, are returned in the localizedAspects container.
sizeSystem
(Primary Item Aspect) The sizing system of the country. All the item aspects, including this aspect, are returned in the localizedAspects container.

Valid Values:
  US
  UK
  EU
  DE
  FR
  JP
  CN (China)
  IT
  BR
  MEX
  AU
Code so that your app gracefully handles any future changes to this list.
sizeType
(Primary Item Aspect) Text describing a size group in which the item would be included, such as regular, petite, plus, big-and-tall or maternity. All the item aspects, including this aspect, are returned in the localizedAspects container.
subtitle
A subtitle is an optional listing feature that allows the seller to provide more information about the product, possibly including keywords that may assist with search results.
taxes
array of Taxes
The container for the tax information for the item.
title
The seller-created title of the item.

Maximum Length: 80 characters
topRatedBuyingExperience
Indicates if the item a top-rated plus item. There are three benefits of a top-rated plus item; a minimum 30-day money-back return policy, shipping the items in 1 business day with tracking provided, and the added comfort of knowing this item is from experienced sellers with the highest buyer ratings. See the Top Rated Plus Items and Becoming a Top Rated Seller and qualifying for Top Rated Plus help topics for more information.
uniqueBidderCount
This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items.
unitPrice
This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices.

For example:

"unitPricingMeasure": "100g",
"unitPrice": {
  "value": "7.99",
  "currency": "GBP"
unitPricingMeasure
The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices.

For example, the following tells the buyer that the item is 7.99 per 100 grams.

"unitPricingMeasure": "100g",
"unitPrice": {
  "value": "7.99",
  "currency": "GBP"
warnings
array of ErrorDetailV3
An array of warning messages. These type of errors do not prevent the method from executing but should be checked.