browse APIv1_beta.26.0

ItemSummary

The type that defines the fields for the details of a specific item.

Type that uses ItemSummary

Calls that use ItemSummary

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.
bidCount
This integer value indicates the total number of bids that have been placed for an auction item. This field is only returned for auction items.
buyingOptions
array of string
A comma separated list of all the purchase options available for the item.

Values Returned:
  • 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 - Items where 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 details about Best Offer, see Best Offer.
Code so that your app gracefully handles any future changes to this list.
categories
array of Category
This container returns the primary category ID of the item (as well as the secondary category if the item was listed in two categories).
compatibilityMatch
This indicates how well the item matches the compatibility_filter product attributes.

Valid Values: EXACT or POSSIBLE

Code so that your app gracefully handles any future changes to this list.
compatibilityProperties
This container returns only the product attributes that are compatible with the item. These attributes were specified in the compatibility_filter in the request. This means that if you passed in 5 attributes and only 4 are compatible, only those 4 are returned. If none of the attributes are compatible, this container is not returned.
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
This container returns the current highest bid for an auction item. The value field shows the dollar value of the current highest bid, and the currency field (3-digit ISO code) denotes the currency associated with that bid value. This field is only returned for auction items.
distanceFromPickupLocation
This container returns the distance away that the item is from the pickupPostalCode value that was supplied in the method request. This container is only returned if the 'local pickup' filter fields are used in the request.
energyEfficiencyClass
This indicates the European energy efficiency rating (EEK) of the item. Energy efficiency ratings apply to products listed by commercial vendors in electronics categories only.

Currently, this field is only applicable for the Germany site, and is only returned if the seller specified the energy efficiency rating through item specifics at listing time. Rating values include A+++, A++, A+, A, B, C, D, E, F, and G.
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.
image
The URL to the primary image of the item.
itemAffiliateWebUrl
The URL to the View Item page of the item, which includes the affiliate tracking ID. This field is only returned if the seller enables affiliate tracking for the item by including the X-EBAY-C-ENDUSERCTX request header in the method.

Note: eBay Partner Network, in order to be commissioned for your sales, you must use this URL to forward your buyer to the ebay.com site.
itemGroupHref
The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Note: This field is returned only for item groups.
itemGroupType
The indicates the item group type. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Currently only the SELLER_DEFINED_VARIATIONS is supported and indicates this is an item group created by the seller.

Note: This field is returned only for item groups.

Code so that your app gracefully handles any future changes to this list.
itemHref
The URI for the Browse API getItem method, which can be used to retrieve more details about items in the search results.
itemId
The unique RESTful identifier of the item.
itemLocation
This container returns the location of the item. This container consists of fields you typically see for an address, including postal code, county, state/province, street address, city, and country (2-digit ISO code).
itemWebUrl
The URL to the View Item page of the item. This enables you to include a "Report Item on eBay" hyperlink that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay.
marketingPrice
This container is returned if the item is eligible for a seller discount and contains the item's original price, and the seller discount amount and percentage.
pickupOptions
This container returns the local pickup options available to the buyer. This container is only returned if the user is searching for local pickup items and set the local pickup filters in the method request.
price
The price of the item after it has been converted into another currency.
priceDisplayCondition
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.
seller
This container returns basic information about the seller of the item, such as name, feedback score, etc.
shippingOptions
This container returns the shipping options available to ship the item.
shortDescription
This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.). Sometimes the title doesn't give enough information but the description is too big. Surfacing the shortDescription can often provide buyers with the additional information that could help them make a buying decision.

For example:

" title": "Petrel U42W FPV Drone RC Quadcopter w/HD Camera Live Video One Key Off / Landing",
"shortDescription": "1 U42W Quadcopter. Syma X5SW-V3 Wifi FPV RC Drone Quadcopter 2.4Ghz 6-Axis Gyro with Headless Mode. Syma X20 Pocket Drone 2.4Ghz Mini RC Quadcopter Headless Mode Altitude Hold. One Key Take Off / Landing function: allow beginner to easy to fly the drone without any skill.",


Restriction: This field is returned by the search method only when fieldgroups = EXTENDED.
thumbnailImages
array of Image
An array of thumbnail images for the item.
title
The seller-created title of the item.

Maximum Length: 80 characters
unitPrice
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"