browse APIv1_beta.21.0

getItem

GET
/item/{item_id}

This method retrieves the details of a specific item, such as description, price, category, all item aspects, condition, return policies, seller feedback and score, shipping options, shipping costs, estimated delivery, and other information the buyer needs to make a purchasing decision.

Note: This method will return FIXED_PRICE (Buy It Now) items and AUCTION items where no bids have been placed. But after a bid has been placed, that item becomes an active auction item and is no longer returned.



The Buy APIs are designed to let you create an eBay shopping experience in your app or website. This means you will need to know when something, such as the availability, quantity, etc., has changed in any eBay item you are offering. You can do this easily by setting the fieldgroups URI parameter. This parameter lets you control what is returned in the response.

Setting fieldgroups to COMPACT reduces the response to only the five fields that you need in order to check if any item detail has changed. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. You can use either COMPACT or PRODUCT but not both. For more information, see fieldgroups.

URLs for this method

  • Production URL: https://api.ebay.com/buy/browse/v1/item/
  • Sandbox URL: https://api.sandbox.ebay.com/buy/browse/v1/item/

Request headers

You will want to use the X-EBAY-C-ENDUSERCTX request header with this method. This header enables eBay Network Partners to pass in their identification in order to be paid for selling eBay items and it is strongly recommended you use contextualLocation to improve the estimated delivery window information. For details see, Request headers in the Buying Integration Guide.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

Input

Resource URI (production)

GET https://api.ebay.com/buy/browse/v1/item/{item_id}?

URI parameters

ParameterTypeDescription
item_idstringThe eBay RESTful identifier of an item. This ID is returned by the Browse and Feed API methods.

RESTful Item ID Format: v1|#|#
For example: v1|272394640372|0 or v1|162846450672|461882996982

For more information about item ID for RESTful APIs, see the Legacy API compatibility section of the Buy APIs Overview.

Occurrence: Required

fieldgroupsarray of stringThis parameter lets you control what is returned in the response. If you do not set this field, the method returns all the details of the item.

Valid values:
  • PRODUCT - This adds the additionalImages, additionalProductIdentities, aspectGroups, description, gtins, image, and title product fields to the response, which describe the product associated with the item. See Product for more information about these fields.
  • COMPACT - This returns only the following fields, which let you quickly check if the availability or price of the item has changed, if the item has been revised by the seller, or if an item's top-rated plus status has changed for items you have stored.
    • itemId - The identifier of the item.
    • 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.
    • topRatedBuyingExperience - A boolean value indicating if this item is a top-rated plus item. A change in the item's top rated plus standing is not tracked by the revision ID. See topRatedBuyingExperience for more information.
    • price - This is tracked by the revision ID but is returned here to enable you to quickly verify the price of the item.
    • estimatedAvailabilities - Returns the item availability information, which is based on the item's quantity. Changes in quantity are not tracked by the revision ID.
    For Example

    To check if a stored item's information is current, do following.
    1. Pass in the item ID and set fieldgroups to COMPACT.

      item/v1|46566502948|0?fieldgroups=COMPACT
    2. Do one of the following:
      • If the sellerItemRevision field is returned and you haven't stored a revision number for this item, record the number and pass in the item ID in the getItem method to get the latest information.
      • If the revision number is different from the value you have stored, update the value and pass in the item ID in the getItem method to get the latest information.
      • If the sellerItemRevision field is not returned or has not changed, where needed, update the item information with the information returned in the response.

Maximum value: 1
If more than one values is specified, the first value will be used.

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):

https://api.ebay.com/oauth/api_scope

See OAuth access tokens for more information.

Output

HTTP response headers

{ /* Item */
"additionalImages" : [
{ /* Image */ }
],
"brand" : "string",
"color" : "string",
"epid" : "string",
"gender" : "string",
"gtin" : "string",
"image" :
{ /* Image */ },
"itemId" : "string",
"mpn" : "string",
"size" : "string",
"title" : "string",
}
Output container/fieldTypeDescription
additionalImagesarray of ImageAn 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.

Occurrence: Conditional

additionalImages.heightintegerReserved for future use.

Occurrence: Conditional

additionalImages.imageUrlstringThe URL of the image.

Occurrence: Conditional

additionalImages.widthintegerReserved for future use.

Occurrence: Conditional

adultOnlybooleanThis 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.

Occurrence: Always

ageGroupstring(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.

Occurrence: Conditional

bidCountintegerThis integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items.

Occurrence: Conditional

brandstring(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.

Occurrence: Conditional

buyingOptionsarray of stringA 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.

Occurrence: Conditional

categoryIdstringThe ID of the leaf category for this item. A left category is the lowest level in the category tree. This category has no children.

Occurrence: Always

categoryPathstringText that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks

Occurrence: Always

colorstring(Primary Item Aspect) Text describing the color of the item. All the item aspects, including this aspect, are returned in the localizedAspects container.

Occurrence: Conditional

conditionstringThe 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.

Occurrence: Always

conditionIdstringThe 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.

Occurrence: Always

currentBidPriceConvertedAmountThe 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.

Occurrence: Conditional

currentBidPrice.convertedFromCurrencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Occurrence: Conditional

currentBidPrice.convertedFromValuestringThe monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.

Occurrence: Conditional

currentBidPrice.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Occurrence: Always

currentBidPrice.valuestringThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Occurrence: Always

descriptionstringThe full description of the item that was created by the seller. This can be plain text or rich content.

Occurrence: Always

enabledForGuestCheckoutbooleanIndicates 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.

Occurrence: Always

energyEfficiencyClassstringIndicates 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.

Occurrence: Conditional

epidstringAn EPID is the eBay product identifier of a product from the eBay product catalog. This indicates the product in which the item belongs.

Occurrence: Conditional

estimatedAvailabilitiesarray of EstimatedAvailabilityThe 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.

Occurrence: Conditional

estimatedAvailabilities.availabilityThresholdintegerThis field is return only when the seller sets their 'display item quantity' preference to Display "More than 10 available" in your listing (if applicable). The value of this field will be "10", which is the threshold value.

Code so that your app gracefully handles any future changes to this value.

Occurrence: Conditional

estimatedAvailabilities.availabilityThresholdTypeAvailabilityThresholdEnum This field is return only when the seller sets their Display Item Quantity preference to Display "More than 10 available" in your listing (if applicable). The value of this field will be MORE_THAN. This indicates that the seller has more than the 'quantity display preference', which is 10, in stock for this item.

The following are the display item quantity preferences the seller can set.
  • Display "More than 10 available" in your listing (if applicable)
    If the seller enables this preference, this field is returned as long as there are more than 10 of this item in inventory. If the quantity is equal to 10 or drops below 10, this field is not returned and the estimated quantity of the item is returned in the estimatedAvailableQuantity field.
  • Display the exact quantity in your items
    If the seller enables this preference, the availabilityThresholdType and availabilityThreshold fields are not returned and the estimated quantity of the item is returned in the estimatedAvailableQuantity field.

    Note: Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity.

Code so that your app gracefully handles any future changes to these preferences.

Occurrence: Conditional

estimatedAvailabilities.deliveryOptionsarray of DeliveryOptionsEnumAn array of available delivery options.

Code so that your app gracefully handles any future changes to this list.

Occurrence: Always

estimatedAvailabilities.estimatedAvailabilityStatusAvailabilityStatusEnumAn enumeration value representing the inventory status of this item.

Values:
  • IN_STOCK
  • LIMITED_STOCK
  • OUT_OF_STOCK
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

estimatedAvailabilities.estimatedAvailableQuantityintegerThe 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.

Occurrence: Conditional

estimatedAvailabilities.estimatedSoldQuantityintegerThe estimated number of this item that have been sold.

Occurrence: Conditional

genderstring(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.

Occurrence: Conditional

gtinstringThe 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.

Occurrence: Conditional

imageImageThe URL of the primary image of the item. The other images of the item are returned in the additionalImages container.

Occurrence: Always

image.heightintegerReserved for future use.

Occurrence: Conditional

image.imageUrlstringThe URL of the image.

Occurrence: Conditional

image.widthintegerReserved for future use.

Occurrence: Conditional

inferredEpidstringThe 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.

Occurrence: Conditional

itemAffiliateWebUrlstringThe 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.

Occurrence: Conditional

itemEndDatestringThe 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.

Occurrence: Conditional

itemIdstringThe unique RESTful identifier of the item.

Occurrence: Always

itemLocationAddressThe physical location of the item.

Occurrence: Conditional

itemLocation.addressLine1stringThe first line of the street address.

Occurrence: Always

itemLocation.addressLine2stringThe second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'.

Occurrence: Conditional

itemLocation.citystringThe city of the address.

Occurrence: Always

itemLocation.countryCountryCodeEnumThe two-letter ISO 3166 standard of the country of the address.

Occurrence: Always

itemLocation.countystringThe county of the address.

Occurrence: Conditional

itemLocation.postalCodestringThe postal code of the address.

Occurrence: Conditional

itemLocation.stateOrProvincestringThe state or province of the address.

Occurrence: Always

itemWebUrlstringThe 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.

Occurrence: Always

localizedAspectsarray of TypedNameValueAn array of containers for the complete list of the name/value pairs that describe the variation of the item.

Occurrence: Conditional

localizedAspects.namestringThe text representing the name of the aspect for the name/value pair, such as Color.

Occurrence: Conditional

localizedAspects.typeValueTypeEnumIndicates if the value being returned is a string or an array of values.

Occurrence: Conditional

localizedAspects.valuestringThe value of the aspect for the name/value pair, such as Red.

Occurrence: Conditional

marketingPriceMarketingPriceThe original price and the discount amount and percentage.

Occurrence: Conditional

marketingPrice.discountAmountConvertedAmountThis container returns the monetary amount of the seller discount.

Occurrence: Conditional

marketingPrice.discountAmount.convertedFromCurrencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Occurrence: Conditional

marketingPrice.discountAmount.convertedFromValuestringThe monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.

Occurrence: Conditional

marketingPrice.discountAmount.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Occurrence: Always

marketingPrice.discountAmount.valuestringThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Occurrence: Always

marketingPrice.discountPercentagestringThis field expresses the percentage of the seller discount based on the value in the originalPrice container.

Occurrence: Conditional

marketingPrice.originalPriceConvertedAmountThis container returns the monetary amount of the item without the discount.

Occurrence: Conditional

marketingPrice.originalPrice.convertedFromCurrencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Occurrence: Conditional

marketingPrice.originalPrice.convertedFromValuestringThe monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.

Occurrence: Conditional

marketingPrice.originalPrice.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Occurrence: Always

marketingPrice.originalPrice.valuestringThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Occurrence: Always

materialstring(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.

Occurrence: Conditional

minimumPriceToBidConvertedAmountThe 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.

Occurrence: Conditional

minimumPriceToBid.convertedFromCurrencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Occurrence: Conditional

minimumPriceToBid.convertedFromValuestringThe monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.

Occurrence: Conditional

minimumPriceToBid.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Occurrence: Always

minimumPriceToBid.valuestringThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Occurrence: Always

mpnstringThe 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.

Occurrence: Conditional

patternstring(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.

Occurrence: Conditional

priceConvertedAmountThe cost of just the item. This amount does not include any adjustments such as discounts, shipping costs, etc.

Occurrence: Always

price.convertedFromCurrencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Occurrence: Conditional

price.convertedFromValuestringThe monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.

Occurrence: Conditional

price.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Occurrence: Always

price.valuestringThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Occurrence: Always

priceDisplayConditionPriceDisplayConditionEnumAn 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.

Occurrence: Conditional

primaryItemGroupItemGroupSummaryThe 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).

Occurrence: Conditional

primaryItemGroup.itemGroupAdditionalImagesarray of ImageAn array of containers with the URLs for images that are in addition to the primary image of the item group. The primary image is returned in the itemGroupImage field.

Occurrence: Conditional

primaryItemGroup.itemGroupAdditionalImages.heightintegerReserved for future use.

Occurrence: Conditional

primaryItemGroup.itemGroupAdditionalImages.imageUrlstringThe URL of the image.

Occurrence: Conditional

primaryItemGroup.itemGroupAdditionalImages.widthintegerReserved for future use.

Occurrence: Conditional

primaryItemGroup.itemGroupHrefstringThe 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.

Occurrence: Conditional

primaryItemGroup.itemGroupIdstringThe unique identifier for the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Occurrence: Conditional

primaryItemGroup.itemGroupImageImageThe URL of the primary image of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Occurrence: Conditional

primaryItemGroup.itemGroupImage.heightintegerReserved for future use.

Occurrence: Conditional

primaryItemGroup.itemGroupImage.imageUrlstringThe URL of the image.

Occurrence: Conditional

primaryItemGroup.itemGroupImage.widthintegerReserved for future use.

Occurrence: Conditional

primaryItemGroup.itemGroupTitlestringThe title of the item that appears on the item group page. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Occurrence: Conditional

primaryItemGroup.itemGroupTypeItemGroupTypeEnumAn enumeration value that indicates the type of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Occurrence: Conditional

primaryProductReviewRatingReviewRatingThe container that returns the product rating details, such as review count, rating histogram, and average rating.

Occurrence: Conditional

primaryProductReviewRating.averageRatingstringThe average rating given to a product based on customer reviews.

Occurrence: Conditional

primaryProductReviewRating.ratingHistogramsarray of RatingHistogramAn array of containers for the product rating histograms that shows the review counts and the product rating.

Occurrence: Conditional

primaryProductReviewRating.ratingHistograms.countintegerThe total number of user ratings that the product has received.

Occurrence: Conditional

primaryProductReviewRating.ratingHistograms.ratingstringThis is the average rating for the product. As part of a product review, users rate the product. Products are rated from one star (terrible) to five stars (excellent), with each star having a corresponding point value - one star gets 1 point, two stars get 2 points, and so on. If a product had one four-star rating and one five-star rating, its average rating would be 4.5, and this is the value that would appear in this field.

Occurrence: Conditional

primaryProductReviewRating.reviewCountintegerThe total number of reviews for the item.

Occurrence: Conditional

productProductThe container that returns the product information of the item.

Occurrence: Conditional

product.additionalImagesarray of ImageAn array of containers with the URLs for the product images that are in addition to the primary image.

Occurrence: Conditional

product.additionalImages.heightintegerReserved for future use.

Occurrence: Conditional

product.additionalImages.imageUrlstringThe URL of the image.

Occurrence: Conditional

product.additionalImages.widthintegerReserved for future use.

Occurrence: Conditional

product.additionalProductIdentitiesarray of AdditionalProductIdentityAn array of product identifiers associated with the item. This container is returned if the seller has associated the eBay Product Identifier (ePID) with the item and in the request fieldgroups is set to PRODUCT.

Occurrence: Conditional

product.additionalProductIdentities.productIdentityarray of ProductIdentityAn array of the product identifier/value pairs for the product associated with the item. This is returned if the seller has associated the eBay Product Identifier (ePID) with the item and the request has fieldgroups set to PRODUCT.

The following table shows what is returned, based on the item information provided by the seller, when the fieldgroups set to PRODUCT.

ePID Provided Product ID(s) Provided Response
No No The AdditionalProductIdentity container is not returned.
No Yes The AdditionalProductIdentity container is not returned but the product identifiers specified by the seller are returned in the localizedAspects container.
Yes No The AdditionalProductIdentity container is returned listing the product identifiers of the product.
Yes Yes The AdditionalProductIdentity container is returned listing all the product identifiers of the product and the product identifiers specified by the seller are returned in the localizedAspects container.

Occurrence: Conditional

product.additionalProductIdentities.productIdentity.identifierTypestringThe type of product identifier, such as UPC and EAN.

Occurrence: Conditional

product.additionalProductIdentities.productIdentity.identifierValuestringThe product identifier value.

Occurrence: Conditional

product.aspectGroupsarray of AspectGroupAn array of containers for the product aspects. Each group contains the aspect group name and the aspect name/value pairs.

Occurrence: Conditional

product.aspectGroups.aspectsarray of AspectAn array of the name/value pairs for the aspects of the product. For example: BRAND/Apple

Occurrence: Conditional

product.aspectGroups.aspects.localizedNamestringThe text representing the name of the aspect for the name/value pair, such as Brand.

Occurrence: Conditional

product.aspectGroups.aspects.localizedValuesarray of stringThe text representing the value of the aspect for the name/value pair, such as Apple.

Occurrence: Conditional

product.aspectGroups.localizedGroupNamestringThe name of a group of aspects.

In the following example, Product Identifiers and Process are product aspect group names. Under the group name are the product aspect name/value pairs.

Product Identifiers
   Brand/Apple
   Product Family/iMac

Processor
   Processor Type/Intel
   Processor Speed/3.10

Occurrence: Conditional

product.brandstringThe brand associated with product. To identify the product, this is always used along with MPN (manufacturer part number).

Occurrence: Conditional

product.descriptionstringThe rich description of an eBay product, which might contain HTML.

Occurrence: Conditional

product.gtinsarray of stringAn array of all the possible GTINs values associated with the product. A GTIN is a 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.

Occurrence: Conditional

product.imageImageThe primary image of the product. This is often a stock photo.

Occurrence: Conditional

product.image.heightintegerReserved for future use.

Occurrence: Conditional

product.image.imageUrlstringThe URL of the image.

Occurrence: Conditional

product.image.widthintegerReserved for future use.

Occurrence: Conditional

product.mpnsarray of stringAn array of all possible MPN values associated with the product. A MPNs is manufacturer part number of the product. To identify the product, this is always used along with brand.

Occurrence: Conditional

product.titlestringThe title of the product.

Occurrence: Conditional

productFicheWebUrlstringThe 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.

Occurrence: Conditional

quantityLimitPerBuyerintegerThe maximum number for a specific item that one buyer can purchase.

Occurrence: Conditional

reservePriceMetbooleanThis 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.

Occurrence: Conditional

returnTermsItemReturnTermsThe container that returns an overview of the seller's return policy.

Occurrence: Conditional

returnTerms.extendedHolidayReturnsOfferedbooleanIndicates if the seller has enabled the Extended Holiday Returns feature on the item. Extended Holiday Returns are only applicable during the US holiday season, and gives buyers extra time to return an item. This 'extra time' will typically extend beyond what is set through the returnPeriod value.

Occurrence: Conditional

returnTerms.refundMethodRefundMethodEnumAn enumeration value that indicates how a buyer is refunded when an item is returned.

Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

returnTerms.restockingFeePercentagestringThis string field indicates the restocking fee percentage that the seller has set on the item. Sellers have the option of setting no restocking fee for an item, or they can set the percentage to 10, 15, or 20 percent. So, if the cost of the item was $100, and the restocking percentage was 20 percent, the buyer would be charged $20 to return that item, so instead of receiving a $100 refund, they would receive $80 due to the restocking fee.

Occurrence: Conditional

returnTerms.returnInstructionsstringText written by the seller describing what the buyer needs to do in order to return the item.

Occurrence: Conditional

returnTerms.returnMethodReturnMethodEnumAn enumeration value that indicates the alternative methods for a full refund when an item is returned. This field is returned if the seller offers the buyer an item replacement or exchange instead of a monetary refund.

Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

returnTerms.returnPeriodTimeDurationThe amount of time the buyer has to return the item after the purchase date.

Occurrence: Conditional

returnTerms.returnPeriod.unitTimeDurationUnitEnumAn enumeration value that indicates the units (such as hours) of the time span. The enumeration value in this field defines the period of time being used to measure the duration, such as business days, months, or years. See the TimeDurationUnitEnum type for a list of possible time-measuring units.

Occurrence: Conditional

returnTerms.returnPeriod.valueintegerRetrieves the duration of the time span (no units).The value in this field indicates the number of years, months, days, hours, or minutes in the defined period.

Occurrence: Conditional

returnTerms.returnsAcceptedbooleanIndicates whether the seller accepts returns for the item.

Occurrence: Conditional

returnTerms.returnShippingCostPayerReturnShippingCostPayerEnumThis enumeration value indicates whether the buyer or seller is responsible for return shipping costs when an item is returned.

Occurrence: Conditional

sellerSellerDetailThe container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information.

Occurrence: Always

seller.feedbackPercentagestringThe percentage of the total positive feedback.

Occurrence: Always

seller.feedbackScoreintegerThe feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.

Occurrence: Always

seller.sellerAccountTypestringIndicates if the seller is a business or an individual. This is determined when the seller registers with eBay. If they register for a business account, this value will be BUSINESS. If they register for a private account, this value will be INDIVIDUAL. This designation is required by the tax laws in some countries.

This field is returned only on the following sites.

EBAY_AT   EBAY_BE   EBAY_CH   EBAY_DE   EBAY_ES   EBAY_FR   EBAY_GB   EBAY_IE   EBAY_IT   EBAY_PL

Valid values:
  • BUSINESS
  • INDIVIDUAL
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

seller.sellerLegalInfoSellerLegalInfoThe container with the seller's contact info and fields that are required by law.

Occurrence: Conditional

seller.sellerLegalInfo.emailstringThe seller's business email address.

Occurrence: Conditional

seller.sellerLegalInfo.faxstringThe seller' business fax number.

Occurrence: Conditional

seller.sellerLegalInfo.imprintstringThis is a free-form string created by the seller. This is information often found on business cards, such as address. This is information used by some countries.

Occurrence: Conditional

seller.sellerLegalInfo.legalContactFirstNamestringThe seller's first name.

Occurrence: Conditional

seller.sellerLegalInfo.legalContactLastNamestringThe seller's last name.

Occurrence: Conditional

seller.sellerLegalInfo.namestringThe name of the seller's business.

Occurrence: Conditional

seller.sellerLegalInfo.phonestringThe seller's business phone number.

Occurrence: Conditional

seller.sellerLegalInfo.registrationNumberstringThe seller's registration number. This is information used by some countries.

Occurrence: Conditional

seller.sellerLegalInfo.sellerProvidedLegalAddressLegalAddressThe container for the seller's address to be used to contact them.

Occurrence: Conditional

seller.sellerLegalInfo.sellerProvidedLegalAddress.addressLine1stringThe first line of the street address.

Occurrence: Always

seller.sellerLegalInfo.sellerProvidedLegalAddress.addressLine2stringThe second line of the street address. This field is not always used, but can be used for 'Suite Number' or 'Apt Number'.

Occurrence: Conditional

seller.sellerLegalInfo.sellerProvidedLegalAddress.citystringThe city of the address.

Occurrence: Always

seller.sellerLegalInfo.sellerProvidedLegalAddress.countryCountryCodeEnumThe two-letter ISO 3166 standard of the country of the address.

Occurrence: Always

seller.sellerLegalInfo.sellerProvidedLegalAddress.countryNamestringThe name of the country of the address.

Occurrence: Conditional

seller.sellerLegalInfo.sellerProvidedLegalAddress.countystringThe name of the county of the address.

Occurrence: Conditional

seller.sellerLegalInfo.sellerProvidedLegalAddress.postalCodestringThe postal code of the address.

Occurrence: Always

seller.sellerLegalInfo.sellerProvidedLegalAddress.stateOrProvincestringThe state or province of the address.

Occurrence: Always

seller.sellerLegalInfo.termsOfServicestringThis is a free-form string created by the seller. This is the seller's terms or condition, which is in addition to the seller's return policies.

Occurrence: Conditional

seller.sellerLegalInfo.vatDetailsarray of VatDetailAn array of the seller's VAT (value added tax) IDs and the issuing country. VAT is a tax added by some European countries.

Occurrence: Conditional

seller.sellerLegalInfo.vatDetails.issuingCountryCountryCodeEnumThe two-letter ISO 3166 standard of the country issuing the seller's VAT (value added tax) ID. VAT is a tax added by some European countries.

Occurrence: Conditional

seller.sellerLegalInfo.vatDetails.vatIdstringThe seller's VAT (value added tax) ID. VAT is a tax added by some European countries.

Occurrence: Conditional

seller.usernamestringThe user name created by the seller for use on eBay.

Occurrence: Conditional

sellerItemRevisionstringAn 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.

Occurrence: Conditional

shippingOptionsarray of ShippingOptionAn array of shipping options containers that have the details about cost, carrier, etc. of one shipping option.

Occurrence: Conditional

shippingOptions.additionalShippingCostPerUnitConvertedAmountAny per item additional shipping costs for a multi-item purchase. For example, let's say the shipping cost for a power cord is $3. But for an additional cord, the shipping cost is only $1. So if you bought 3 cords, the shippingCost would be $3 and this value would be $2 ($1 for each additional item).

Occurrence: Conditional

shippingOptions.additionalShippingCostPerUnit.convertedFromCurrencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Occurrence: Conditional

shippingOptions.additionalShippingCostPerUnit.convertedFromValuestringThe monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.

Occurrence: Conditional

shippingOptions.additionalShippingCostPerUnit.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Occurrence: Always

shippingOptions.additionalShippingCostPerUnit.valuestringThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Occurrence: Always

shippingOptions.cutOffDateUsedForEstimatestringThe deadline date that the item must be purchased by in order to be received by the buyer within the delivery window ( maxEstimatedDeliveryDate and minEstimatedDeliveryDate fields). This field is returned only for items that are eligible for 'Same Day Handling'. For these items, the value of this field is what is displayed in the Delivery line on the View Item page.

This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Occurrence: Conditional

shippingOptions.maxEstimatedDeliveryDatestringThe end date of the delivery window (latest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header.

Occurrence: Conditional

shippingOptions.minEstimatedDeliveryDatestringThe start date of the delivery window (earliest projected delivery date). This value is returned in UTC format (yyyy-MM-ddThh:mm:ss.sssZ), which you can convert into the local time of the buyer.

Note: For the best accuracy, always include the location of where the item is be shipped in the contextualLocation values of the X-EBAY-C-ENDUSERCTX request header.

Occurrence: Conditional

shippingOptions.quantityUsedForEstimateintegerThe number of items used when calculating the estimation information.

Occurrence: Conditional

shippingOptions.shippingCarrierCodestringA name of the shipping provider, such as FedEx, or USPS.

Occurrence: Always

shippingOptions.shippingCostConvertedAmountThe final shipping cost for all the items after all discounts are applied.

Occurrence: Always

shippingOptions.shippingCost.convertedFromCurrencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Occurrence: Conditional

shippingOptions.shippingCost.convertedFromValuestringThe monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.

Occurrence: Conditional

shippingOptions.shippingCost.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Occurrence: Always

shippingOptions.shippingCost.valuestringThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Occurrence: Always

shippingOptions.shippingCostTypestringIndicates the class of the shipping cost.

Valid Values: FIXED or CALCULATED.
Code so that your app gracefully handles any future changes to this list.

Occurrence: Always

shippingOptions.shippingServiceCodestringThe type of shipping service. For example, USPS First Class.

Occurrence: Always

shippingOptions.shipToLocationUsedForEstimateShipToLocationThe container that returns the country and postal code of where the item is to be shipped. These values come from the contextualLocation values in the X-EBAY-C-ENDUSERCTX request header. If the header is not submitted, marketplace is used.

Occurrence: Conditional

shippingOptions.shipToLocationUsedForEstimate.countryCountryCodeEnumThe two-letter ISO 3166 standard of the country for where the item is to be shipped.

Occurrence: Conditional

shippingOptions.shipToLocationUsedForEstimate.postalCodestringThe zip code (postal code) for where the item is to be shipped.

Occurrence: Conditional

shippingOptions.trademarkSymbolstringAny trademark symbol, such as ™ or ®, that needs to be shown in superscript next to the shipping service name.

Occurrence: Conditional

shippingOptions.typestringThe type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.

Occurrence: Always

shipToLocationsShipToLocationsThe container that returns the geographic regions to be included and excluded that define where the item can be shipped.

Occurrence: Conditional

shipToLocations.regionExcludedarray of RegionA array of containers for regions that are specifically excluded from a region set. You can use this to exclude a specific regionName from a regionType that you specifically include.

Occurrence: Conditional

shipToLocations.regionExcluded.regionNamestringA free-form text string that indicates the name of the region. This value can be the name of a world region (such as the "Middle East" or "Southeast Asia"), a country, or a domestic region within a country (such as "Alaska/Hawaii" or "US Protectorates") depending on the value of regionType. This value should be WORLDWIDE if the regionType value is WORLDWIDE.

Occurrence: Conditional

shipToLocations.regionExcluded.regionTypeRegionTypeEnumAn enumeration value that indicates the type of global region.

Occurrence: Conditional

shipToLocations.regionIncludedarray of RegionA array of containers for regions that are specifically included in a region set. You can use this to exclude a specific regionName from a regionType that you specifically include.

Occurrence: Conditional

shipToLocations.regionIncluded.regionNamestringA free-form text string that indicates the name of the region. This value can be the name of a world region (such as the "Middle East" or "Southeast Asia"), a country, or a domestic region within a country (such as "Alaska/Hawaii" or "US Protectorates") depending on the value of regionType. This value should be WORLDWIDE if the regionType value is WORLDWIDE.

Occurrence: Conditional

shipToLocations.regionIncluded.regionTypeRegionTypeEnumAn enumeration value that indicates the type of global region.

Occurrence: Conditional

shortDescriptionstringThis text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.).

Occurrence: Conditional

sizestring(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.

Occurrence: Conditional

sizeSystemstring(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.

Occurrence: Conditional

sizeTypestring(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.

Occurrence: Conditional

subtitlestringA 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.

Occurrence: Conditional

taxesarray of TaxesThe container for the tax information for the item.

Occurrence: Conditional

taxes.ebayCollectAndRemitTaxbooleanThis field is only returned if true, and indicates that eBay will collect tax (sales tax, Goods and Services tax, or VAT) for at least one line item in the order, and remit the tax to the taxing authority of the buyer's residence.

Occurrence: Conditional

taxes.includedInPricebooleanIndicates if tax was applied for the cost of the item.

Occurrence: Conditional

taxes.shippingAndHandlingTaxedbooleanIndicates if tax is applied for the shipping cost.

Occurrence: Conditional

taxes.taxJurisdictionTaxJurisdictionThe container that returns the tax jurisdiction.

Occurrence: Conditional

taxes.taxJurisdiction.regionRegionThe region of the tax jurisdiction.

Occurrence: Conditional

taxes.taxJurisdiction.region.regionNamestringA free-form text string that indicates the name of the region. This value can be the name of a world region (such as the "Middle East" or "Southeast Asia"), a country, or a domestic region within a country (such as "Alaska/Hawaii" or "US Protectorates") depending on the value of regionType. This value should be WORLDWIDE if the regionType value is WORLDWIDE.

Occurrence: Conditional

taxes.taxJurisdiction.region.regionTypeRegionTypeEnumAn enumeration value that indicates the type of global region.

Occurrence: Conditional

taxes.taxJurisdiction.taxJurisdictionIdstringThe identifier of the tax jurisdiction.

Occurrence: Conditional

taxes.taxPercentagestringThe percentage of tax.

Occurrence: Conditional

taxes.taxTypeTaxTypeThe container that returns the tax type.

Occurrence: Conditional

titlestringThe seller-created title of the item.

Maximum Length: 80 characters

Occurrence: Always

topRatedBuyingExperiencebooleanIndicates 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.

Occurrence: Conditional

uniqueBidderCountintegerThis 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.

Occurrence: Conditional

unitPriceConvertedAmountThis 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"

Occurrence: Conditional

unitPrice.convertedFromCurrencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the convertedFromValue field. This value is required or returned only if currency conversion/localization is required, and represents the pre-conversion currency.

Occurrence: Conditional

unitPrice.convertedFromValuestringThe monetary amount before any conversion is performed, in the currency specified by the convertedFromCurrency field. This value is required or returned only if currency conversion/localization is required. The value field contains the converted amount of this value, in the currency specified by the currency field.

Occurrence: Conditional

unitPrice.currencyCurrencyCodeEnumThe three-letter ISO 4217 code representing the currency of the amount in the value field. If currency conversion/localization is required, this is the post-conversion currency of the amount in the value field.

Default: The currency of the authenticated user's country.

Occurrence: Always

unitPrice.valuestringThe monetary amount, in the currency specified by the currency field. If currency conversion/localization is required, this value is the converted amount, and the convertedFromValue field contains the amount in the original currency.

Occurrence: Always

unitPricingMeasurestringThe 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"

Occurrence: Conditional

warningsarray of ErrorDetailV3An array of warning messages. These type of errors do not prevent the method from executing but should be checked.

Occurrence: Conditional

warnings.categorystringThis string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors.

Occurrence: Always

warnings.domainstringThe name of the primary system where the error occurred. This is relevant for application errors.

Occurrence: Always

warnings.errorIdintegerA unique code that identifies the particular error or warning that occurred. Your application can use error codes as identifiers in your customized error-handling algorithms.

Occurrence: Always

warnings.inputRefIdsarray of stringAn array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any.

Occurrence: Conditional

warnings.longMessagestringA detailed description of the condition that caused the error or warning, and information on what to do to correct the problem.

Occurrence: Conditional

warnings.messagestringA description of the condition that caused the error or warning.

Occurrence: Always

warnings.outputRefIdsarray of stringAn array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any.

Occurrence: Conditional

warnings.parametersarray of ErrorParameterV3An array of warning and error messages that return one or more variables contextual information about the error or warning. This is often the field or value that triggered the error or warning.

Occurrence: Conditional

warnings.parameters.namestringThis is the name of input field that caused an issue with the call request.

Occurrence: Conditional

warnings.parameters.valuestringThis is the actual value that was passed in for the element specified in the name field.

Occurrence: Conditional

warnings.subdomainstringThe name of the subdomain in which the error or warning occurred.

Occurrence: NA

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
404Not Found
409Conflict
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
11000API_BROWSEAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
11001API_BROWSEREQUESTThe specified item Id was not found.
11004API_BROWSEREQUESTThe item is not available for purchase. This can be for many reasons, such as when the listing is being updated by the seller. Wait a few minutes and try the call again.
11011API_BROWSEREQUESTThe marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces}
11501API_BROWSEREQUESTThe 'fieldgroups' value {fieldgroups} is invalid. The supported fieldgroups are: {supportedFieldgroups}

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Get Item Details

This sample returns the details of the specified item by passing in the ID of the item. The ID is returned by the search call in the itemId field. It is also returned, as a HATEOAS style reference, in itemHref field.

Input

The input is the item_id URI parameter, which specifies the ID of the item. There is no payload with this request.
GET
https://api.ebay.com/buy/browse/v1/item/v1|202117468662|0

Output

The details for a Macbook Air are returned. Since this item is discounted, the marketingPrice container is returned showing the details of the discount. It also has product reviews that are returned in the primaryProductReviewRating container and item aspects that are returned in the localizedAspects container.

Sample 2: Determine if an Item has Been Changed

This sample returns only the itemId, sellerItemRevision (generated when a seller revises any item detail, except quantity), topRatedBuyingExperience, price, and estimatedAvailabilities fields. This let you quickly check if the availability or price of the item has changed, if the item has been revised by the seller, or if an item's top-rated plus status has changed for items you have stored.

This sample uses the same item as the first sample; the Macbook Air.

Input

The input is the item_id URI parameter, which specifies the ID of the item and fieldgroups set to COMPACT.
GET
https://api.ebay.com/buy/browse/v1/item/v1|202117468662|0?fieldgroups=COMPACT

Output

The fields for the compact response are returned. You can see that the item revision number is 6. So if you have stored this item and it's revision number is less than 6, you need to update the price of the item. Since availability is not tracked by the revision number, you should also check and if needed update the estimatedAvalibilities container field values.

Sample 3: Get Item Details AND the Item Product Information

This sample returns the details of a specific item and the details of the item's product. It uses the same item as the first and second samples; the Macbook Air.

Input

The input is the item_id and fieldgroups set to PRODUCT. There is no payload with this request.
GET
https://api.ebay.com/buy/browse/v1/item/v1|202117468662|0?fieldgroups=PRODUCT

Output

The output is the details of the item and the details of the product for this item, which is returned in the product container.