browse APIv1_beta.26.0

getItemsByItemGroup

GET
/item/get_items_by_item_group

This method retrieves the details of the individual items in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

You pass in the item group ID as a URI parameter. You use this method to show the item details of items with multiple aspects, such as color, size, storage capacity, etc.

This method returns two main containers; items and commonDescriptions. The items container has an array of containers with the details of each item in the group. The commonDescriptions container has an array of containers for a description and the item IDs of all the items that have this exact description. Because items within an item group often have the same description, this decreases the size of the response.

URLs for this method

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

Request headers

This method uses the X-EBAY-C-ENDUSERCTX request header to support revenue sharing for eBay Partner Networks and to improve the accuracy of shipping and delivery time estimations. For details see, Request headers in the Buying Integration Guide.

Restrictions

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

eBay Partner Network: In order to be commissioned for your sales, you must use the URL returned in the itemAffiliateWebUrl field to forward your buyer to the ebay.com site.

Input

Resource URI (production)

GET https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?

URI parameters

ParameterTypeDescription
item_group_idstringIdentifier of the item group to return. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

This ID is returned in the itemGroupHref field of the search and getItem methods.

For Example: https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?item_group_id=351825690866

Occurrence: Required

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

{ /* Items */
"items" : [
{ /* 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
commonDescriptionsarray of CommonDescriptionsAn array of containers for a description and the item IDs of all the items that have this exact description. Often the item variations within an item group all have the same description. Instead of repeating this description in the item details of each item, an description that is shared by at one other item is returned in this container. If the description is unique, it is returned in the items.description field.

Occurrence: Conditional

commonDescriptions.descriptionstringThe item description that is used by more than one of the item variations.

Occurrence: Conditional

commonDescriptions.itemIdsarray of stringA list of item IDs that have this description.

Occurrence: Conditional

itemsarray of ItemAn array of containers for all the item variations details, excluding the description.

Occurrence: Conditional

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

items.additionalImages.heightintegerReserved for future use.

Occurrence: Conditional

items.additionalImages.imageUrlstringThe URL of the image.

Occurrence: Conditional

items.additionalImages.widthintegerReserved for future use.

Occurrence: Conditional

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

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

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

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

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

items.categoryIdstringThe ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children.

Occurrence: Always

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

Occurrence: Always

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

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

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

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

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

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

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

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

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

Occurrence: Always

items.enabledForGuestCheckoutbooleanThis 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.

Occurrence: Always

items.energyEfficiencyClassstringThis 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.

Occurrence: Conditional

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

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

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

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

items.estimatedAvailabilities.deliveryOptionsarray of DeliveryOptionsEnumAn array of available delivery options.

Valid Values: SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, PICKUP_DROP_OFF, or DIGITAL_DELIVERY

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

Occurrence: Always

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

Valid Values: IN_STOCK, LIMITED_STOCK, or OUT_OF_STOCK

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

items.gtinstringThe unique Global Trade Item number of the item as defined by https://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

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

Occurrence: Always

items.image.heightintegerReserved for future use.

Occurrence: Conditional

items.image.imageUrlstringThe URL of the image.

Occurrence: Conditional

items.image.widthintegerReserved for future use.

Occurrence: Conditional

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

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

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.

Occurrence: Conditional

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

items.itemIdstringThe unique RESTful identifier of the item.

Occurrence: Always

items.itemLocationAddressThe physical location of the item.

Occurrence: Conditional

items.itemLocation.addressLine1stringThe first line of the street address.

Occurrence: Always

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

items.itemLocation.citystringThe city of the address.

Occurrence: Always

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

Occurrence: Always

items.itemLocation.countystringThe county of the address.

Occurrence: Conditional

items.itemLocation.postalCodestringThe postal code (or zip code in US) code of the address. Sellers set a postal code (or zip code in US) for items when they are listed. The postal code is used for calculating proximity searches. It is anonymized when returned in itemLocation.postalCode via the API.

Occurrence: Conditional

items.itemLocation.stateOrProvincestringThe state or province of the address.

Occurrence: Always

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

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

Occurrence: Conditional

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

Occurrence: Conditional

items.localizedAspects.typeValueTypeEnumThis indicates if the value being returned is a string or an array of values.

Valid Values:
  • STRING - Indicates the value returned is a string.
  • STRING_ARRAY - Indicates the value returned is an array of strings.
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

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

Occurrence: Conditional

items.marketingPriceMarketingPriceThe original price and the discount amount and percentage.

Occurrence: Conditional

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

Occurrence: Conditional

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

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

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

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

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

Occurrence: Conditional

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

Occurrence: Conditional

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

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

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

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

items.marketingPrice.priceTreatmentPriceTreatmentEnumIndicates the pricing treatment (discount) that was applied to the price of the item.

Note: The pricing treatment affects the way and where the discounted price can be displayed.

Occurrence: Conditional

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

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

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

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

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

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

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

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

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

Occurrence: Always

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

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

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

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

items.priceDisplayConditionPriceDisplayConditionEnumIndicates 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.

Occurrence: Conditional

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

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

items.primaryItemGroup.itemGroupAdditionalImages.heightintegerReserved for future use.

Occurrence: Conditional

items.primaryItemGroup.itemGroupAdditionalImages.imageUrlstringThe URL of the image.

Occurrence: Conditional

items.primaryItemGroup.itemGroupAdditionalImages.widthintegerReserved for future use.

Occurrence: Conditional

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

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

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

items.primaryItemGroup.itemGroupImage.heightintegerReserved for future use.

Occurrence: Conditional

items.primaryItemGroup.itemGroupImage.imageUrlstringThe URL of the image.

Occurrence: Conditional

items.primaryItemGroup.itemGroupImage.widthintegerReserved for future use.

Occurrence: Conditional

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

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

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

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

items.primaryProductReviewRating.reviewCountintegerThe total number of reviews for the item.

Occurrence: Conditional

items.productProductThe container that returns the product information of the item.

Occurrence: Conditional

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

Occurrence: Conditional

items.product.additionalImages.heightintegerReserved for future use.

Occurrence: Conditional

items.product.additionalImages.imageUrlstringThe URL of the image.

Occurrence: Conditional

items.product.additionalImages.widthintegerReserved for future use.

Occurrence: Conditional

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

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

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

Occurrence: Conditional

items.product.additionalProductIdentities.productIdentity.identifierValuestringThe product identifier value.

Occurrence: Conditional

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

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

Occurrence: Conditional

items.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 https://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

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

Occurrence: Conditional

items.product.image.heightintegerReserved for future use.

Occurrence: Conditional

items.product.image.imageUrlstringThe URL of the image.

Occurrence: Conditional

items.product.image.widthintegerReserved for future use.

Occurrence: Conditional

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

items.product.titlestringThe title of the product.

Occurrence: Conditional

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

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

Occurrence: Conditional

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

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

Occurrence: Conditional

items.returnTerms.extendedHolidayReturnsOfferedbooleanThis indicates 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

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

Valid Values: MONEY_BACK or MERCHANDISE_CREDIT

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

Valid Values:
  • REPLACEMENT - Indicates that the buyer has the option of receiving money back for the returned item, or they can choose to have the seller replace the item with an identical item.
  • EXCHANGE - Indicates that the buyer has the option of receiving money back for the returned item, or they can exchange the item for another similar item.
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

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

Occurrence: Conditional

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

Valid Values: YEAR, MONTH, DAY, HOUR, CALENDAR_DAY, BUSINESS_DAY, MINUTE, SECOND, or MILLISECOND

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

Occurrence: Conditional

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

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

Occurrence: Conditional

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

Valid Values:
  • SELLER - Indicates the seller will pay for the shipping costs to return the item.
  • BUYER - Indicates the buyer will pay for the shipping costs to return the item.
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

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

Occurrence: Always

items.seller.feedbackPercentagestringThe percentage of the total positive feedback.

Occurrence: Always

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

items.seller.sellerAccountTypestringThis indicates 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 the following 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 or INDIVIDUAL

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

items.seller.sellerLegalInfo.faxstringThe seller' business fax number.

Occurrence: Conditional

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

items.seller.sellerLegalInfo.legalContactFirstNamestringThe seller's first name.

Occurrence: Conditional

items.seller.sellerLegalInfo.legalContactLastNamestringThe seller's last name.

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

items.seller.sellerLegalInfo.sellerProvidedLegalAddressLegalAddressThe container that returns the seller's address to be used to contact them.

Occurrence: Conditional

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

Occurrence: Always

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

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

Occurrence: Always

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

Occurrence: Always

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Always

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

Occurrence: Always

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

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

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

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

Occurrence: Conditional

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

Occurrence: Conditional

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

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

Occurrence: Always

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

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

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

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

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

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

items.shippingOptions.fulfilledThroughFulfilledThroughEnumIf the item is being shipped by eBay's Global Shipping Program, this field returns GLOBAL_SHIPPING. Otherwise this field is null.

Occurrence: Conditional

items.shippingOptions.importChargesConvertedAmountThe Global Shipping Program import charges for this item.

Occurrence: Conditional

items.shippingOptions.importCharges.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

items.shippingOptions.importCharges.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

items.shippingOptions.importCharges.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

items.shippingOptions.importCharges.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

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

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

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

Occurrence: Conditional

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

Occurrence: Always

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

Occurrence: Always

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

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

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

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

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

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

Occurrence: Always

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

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Conditional

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

Occurrence: Always

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

Occurrence: Conditional

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

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

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

Valid Values:
  • COUNTRY_REGION - Indicates the region is a country, or a domestic region within a country.
  • STATE_OR_PROVINCE - Indicates the region is a state or province, such as Alaska or Hawaii, or the US Protectorates.
  • COUNTRY - Indicates the region is a single country.
  • WORLD_REGION - Indicates the region is a world region, such as the Middle East or Southeast Asia.
  • WORLDWIDE - Indicates the region is the entire world.
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

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

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

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

Valid Values:
  • COUNTRY_REGION - Indicates the region is a country, or a domestic region within a country.
  • STATE_OR_PROVINCE - Indicates the region is a state or province, such as Alaska or Hawaii, or the US Protectorates.
  • COUNTRY - Indicates the region is a single country.
  • WORLD_REGION - Indicates the region is a world region, such as the Middle East or Southeast Asia.
  • WORLDWIDE - Indicates the region is the entire world.
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

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

Occurrence: Conditional

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

items.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:
AU (Australia),
BR (Brazil),
CN (China),
DE (Germany),
EU (European Union),
FR (France),
IT (Italy),
JP (Japan),
MX (Mexico),
US (USA),
UK (United Kingdom)

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

Occurrence: Conditional

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

items.subtitlestringA subtitle is optional and allows the seller to provide more information about the product, possibly including keywords that may assist with search results.

Occurrence: Conditional

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

Occurrence: Conditional

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

items.taxes.includedInPricebooleanThis indicates if tax was applied for the cost of the item.

Occurrence: Conditional

items.taxes.shippingAndHandlingTaxedbooleanThis indicates if tax is applied for the shipping cost.

Occurrence: Conditional

items.taxes.taxJurisdictionTaxJurisdictionThe container that returns the tax jurisdiction.

Occurrence: Conditional

items.taxes.taxJurisdiction.regionRegionThe region of the tax jurisdiction.

Occurrence: Conditional

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

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

Valid Values:
  • COUNTRY_REGION - Indicates the region is a country, or a domestic region within a country.
  • STATE_OR_PROVINCE - Indicates the region is a state or province, such as Alaska or Hawaii, or the US Protectorates.
  • COUNTRY - Indicates the region is a single country.
  • WORLD_REGION - Indicates the region is a world region, such as the Middle East or Southeast Asia.
  • WORLDWIDE - Indicates the region is the entire world.
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

items.taxes.taxJurisdiction.taxJurisdictionIdstringThe identifier of the tax jurisdiction.

Occurrence: Conditional

items.taxes.taxPercentagestringThe percentage of tax.

Occurrence: Conditional

items.taxes.taxTypeTaxTypeThe container that returns the tax type.

Valid Values:
  • STATE_SALES_TAX - Indicates this is a state sales tax.
  • VAT - Indicates this is a value add tax (VAT) tax.
  • PROVINCE_SALES_TAX - Indicates this is a province sales tax.
  • REGION - Indicates this is a region tax.
Code so that your app gracefully handles any future changes to this list.

Occurrence: Conditional

items.titlestringThe seller-created title of the item.

Maximum Length: 80 characters

Occurrence: Always

items.topRatedBuyingExperiencebooleanThis 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.

Occurrence: Conditional

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

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

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

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

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

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

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

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

Occurrence: Conditional

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

Occurrence: Always

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

Occurrence: Always

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

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

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

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

Occurrence: Always

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

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

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

Occurrence: Conditional

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

Occurrence: Conditional

items.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
200OK
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.
11002API_BROWSEREQUESTThe specified item group was not found.
11005API_BROWSEREQUESTItem Group Id is invalid. Use {itemHref} to get the item details.
11008API_BROWSEREQUESTThe item group is not available. 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}

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 for a Group of Items

This sample returns a specific group of items by passing in the ID of the group. The group ID is the item ID of the parent item of the group. This ID is returned in the itemGroup field.

Input

The input is item_group_id URI parameter, which specifies the ID of the group. There is no payload with this request.
GET
https://api.ebay.com/buy/browse/v1/item/get_items_by_item_group?item_group_id=151915076499

Output

In this example, the group is for a man's shirt with variations, such as color and size capacity. The items container lists each individual item with its unique aspects. The itemHref returns the code for the call to return the item details, which include shipping, discount, and return policy information.

All these items have the same description. So only the short description is included in each item. At the bottom of the response is the commonDescriptions container, which has the description and a list of the item IDs that use this description.