GET
/item/get_item_by_legacy_id
This method is a bridge between the eBay legacy APIs, such as Shopping, and Finding and the eBay Buy APIs. There are differences between how legacy APIs and RESTful APIs return the identifier of an "item" and what the item ID represents. This method lets you use the legacy item ids retrieve the details of a specific item, such as description, price, and other information the buyer needs to make a purchasing decision. It also returns the RESTful item ID, which you can use with all the Buy API methods.
For more information about how to use legacy ids with the Buy APIs, see Legacy API compatibility in the Buying Integration guide.
This method returns the item details and requires you to pass in either the item ID of a non-variation item or the item ids of both the parent and child 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.
The fieldgroups URI parameter lets you control what is returned in the response. Setting fieldgroups to PRODUCT, adds additional fields to the default response that return information about the product of the item. For more information, see fieldgroups.
URLs for this method
- Production URL:
https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id? - Sandbox URL:
https://api.sandbox.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?
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 theitemAffiliateWebUrl field to forward your buyer to the ebay.com site. Input
Resource URI (production)
GET https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?
URI parameters
| Parameter | Type | Description |
|---|---|---|
| legacy_item_id | string | Specifies either:
The following is an example of using the value of the ItemID field for a specific item from Finding to get the RESTful itemId value. browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9 Maximum: 1 Occurrence: Required |
| legacy_variation_id | string | Specifies the legacy item ID of a specific item in an item group, such as the red shirt size L. Legacy ids are returned by APIs, such as the Finding API. Maximum: 1 Requirement: You must always pass in the legacy_item_id with the legacy_variation_id Occurrence: Optional |
| legacy_variation_sku | string | Specifics the legacy SKU of the item. SKU are item ids created by the seller. Legacy SKUs are returned by eBay the Shopping API. The following is an example of using the value of the ItemID and SKU fields to get the RESTful itemId value. browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********9&legacy_variation_sku=V**********MMaximum: 1 Requirement: You must always pass in the legacy_item_id with the legacy_variation_sku Occurrence: Optional |
| fieldgroups | array of string | This field 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. Note: In this method, the only value supported is PRODUCT. Valid Values: 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
{ /* Item */
"marketingPrice" :
{ /* MarketingPrice */ },
"paymentMethods" : [],
"priceDisplayCondition" : "PriceDisplayConditionEnum : [ONLY_SHOW_WHEN_ADDED_IN_CART,ONLY_SHOW_ON_REQUEST,ALWAYS_SHOW]",
"product" :
{ /* Product */ },
"seller" :
{ /* SellerDetail */
"sellerLegalInfo" :
},"shippingOptions" : [
{ /* ShippingOption */ }
],"shipToLocations" :
{ /* ShipToLocations */ },
"taxes" : [],
}| Output container/field | Type | Description | |||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| additionalImages | array of Image | An array of containers with the URLs for the images that are in addition to the primary image. The primary image is returned in the image.imageUrl field. Occurrence: Conditional | |||||||||||||||
| additionalImages.height | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| additionalImages.imageUrl | string | The URL of the image. Occurrence: Always | |||||||||||||||
| additionalImages.width | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| adultOnly | boolean | This indicates if the item is for adults only. For more information about adult-only items on eBay, see Adult items policy for sellers and Adult-Only items on eBay for buyers. Occurrence: Always | |||||||||||||||
| ageGroup | string | (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 | |||||||||||||||
| authenticityGuarantee | AuthenticityGuaranteeProgram | A container for information about whether an item is qualified for the Authenticity Guarantee program. Under the Authenticity Guarantee program, the seller ships a purchased item to a a third-party authenticator who inspects the item and provides an authentication card for it before the item is shipped to the buyer. If the buyer returns the item, the authenticator first verifies that it is the same item in the same condition before returning it to the seller. Note: Refer to the Authenticity Guarantee page for more information. Occurrence: Conditional | |||||||||||||||
| authenticityGuarantee.description | string | An indication that the item is qualified for the Authenticity Guarantee program. Occurrence: Conditional | |||||||||||||||
| authenticityGuarantee.termsWebUrl | string | The URL to the Authenticity Guarantee program terms of use. Occurrence: Conditional | |||||||||||||||
| authenticityVerification | AuthenticityVerificationProgram | A container for information about whether an item is from a verified seller. Occurrence: Conditional | |||||||||||||||
| authenticityVerification.description | string | An indication that the item is from a verified seller. Occurrence: Conditional | |||||||||||||||
| authenticityVerification.termsWebUrl | string | The URL to the Authenticity Verification program terms of use. Occurrence: Conditional | |||||||||||||||
| availableCoupons | array of AvailableCoupon | A list of available coupons for the item. Occurrence: Conditional | |||||||||||||||
| availableCoupons.constraint | CouponConstraint | The limitations or restrictions of the coupon. Occurrence: Conditional | |||||||||||||||
| availableCoupons.constraint.expirationDate | string | This timestamp provides the expiration date of the coded coupon. Occurrence: Conditional | |||||||||||||||
| availableCoupons.discountAmount | Amount | The discount amount after the coupon is applied. Occurrence: Conditional | |||||||||||||||
| availableCoupons.discountAmount.currency | CurrencyCodeEnum | The list of valid currencies. Each ISO 4217 currency code includes the currency name followed by the numeric value. For example, the Canadian Dollar code (CAD) would take the following form: Canadian Dollar, 124. Occurrence: Conditional | |||||||||||||||
| availableCoupons.discountAmount.value | string | The value of the discounted amount. Occurrence: Conditional | |||||||||||||||
| availableCoupons.discountType | CouponDiscountType | The type of discount that the coupon applies. Occurrence: Conditional | |||||||||||||||
| availableCoupons.message | string | A description of the coupon. Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included, if returned in the API response. Occurrence: Conditional | |||||||||||||||
| availableCoupons.redemptionCode | string | The coupon code. Occurrence: Conditional | |||||||||||||||
| availableCoupons.termsWebUrl | string | The URL to the coupon terms of use. Note: The value returned in the termsWebUrl field should appear for all experiences when displaying coupons. The value in the availableCoupons.message field must also be included, if returned in the API response. Occurrence: Conditional | |||||||||||||||
| bidCount | integer | This integer value indicates the total number of bids that have been placed against an auction item. This field is returned only for auction items. Occurrence: Conditional | |||||||||||||||
| brand | string | (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 | |||||||||||||||
| buyingOptions | array of string | A comma separated list of all the purchase options available for the item. The values returned are:
Occurrence: Conditional | |||||||||||||||
| categoryId | string | The ID of the leaf category for this item. A leaf category is the lowest level in that category and has no children. Occurrence: Always | |||||||||||||||
| categoryPath | string | Text that shows the category hierarchy of the item. For example: Computers/Tablets & Networking, Laptops & Netbooks, PC Laptops & Netbooks Occurrence: Always | |||||||||||||||
| color | string | (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 | |||||||||||||||
| condition | string | A short text description for 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. Note: As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the Cell Phones & Smartphones category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030). Occurrence: Conditional | |||||||||||||||
| conditionDescription | string | A full text description for the condition of the item. This field elaborates on the value specified in the condition field and provides full details for the condition of the item. Note: As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the Cell Phones & Smartphones category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030). Occurrence: Conditional | |||||||||||||||
| conditionId | string | The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list. Note: As of September 1, 2021, condition ID 2500 ('Seller Refurbished') is no longer a valid item condition in the Cell Phones & Smartphones category (category ID 9355) for the following marketplaces: US, Canada, UK, Germany, and Australia. This refurbished item condition has been replaced by three new refurbished values, which include 'Excellent - Refurbished' (condition ID 2010), 'Very Good - Refurbished' (condition ID 2020), and 'Good - Refurbished' (condition ID 2030). Occurrence: Conditional | |||||||||||||||
| currentBidPrice | ConvertedAmount | The container that returns the current highest bid for an auction item. The value (string) field shows the dollar value of the current highest bid, and the currency (3-digit ISO code) field denotes the currency associated with that bid value. This container will only be returned for auction items. Occurrence: Conditional | |||||||||||||||
| currentBidPrice.convertedFromCurrency | CurrencyCodeEnum | The 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.convertedFromValue | string | The 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.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| currentBidPrice.value | string | The 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: Conditional | |||||||||||||||
| description | string | The 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 | |||||||||||||||
| ecoParticipationFee | ConvertedAmount | The Eco Participation fee, a fee paid by the buyer that is applied to the cost of the eventual disposal of the purchased item. The fee is remitted in full to the eco organization. Currently, this value is required for electronic devices and furniture. Occurrence: Conditional | |||||||||||||||
| ecoParticipationFee.convertedFromCurrency | CurrencyCodeEnum | The 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 | |||||||||||||||
| ecoParticipationFee.convertedFromValue | string | The 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 | |||||||||||||||
| ecoParticipationFee.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| ecoParticipationFee.value | string | The 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: Conditional | |||||||||||||||
| eligibleForInlineCheckout | boolean | This field indicates if the item can be purchased using the Buy Order API.
Occurrence: Always | |||||||||||||||
| enabledForGuestCheckout | boolean | This 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 | |||||||||||||||
| energyEfficiencyClass | string | This 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 | |||||||||||||||
| epid | string | An 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 | |||||||||||||||
| estimatedAvailabilities | array of EstimatedAvailability | The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. Occurrence: Conditional | |||||||||||||||
| estimatedAvailabilities.availabilityThreshold | integer | 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 "10", which is the threshold value. Code so that your app gracefully handles any future changes to this value. Occurrence: Conditional | |||||||||||||||
| estimatedAvailabilities.availabilityThresholdType | AvailabilityThresholdEnum | 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.
Code so that your app gracefully handles any future changes to these preferences. Occurrence: Conditional | |||||||||||||||
| estimatedAvailabilities.deliveryOptions | array of DeliveryOptionsEnum | An 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: Conditional | |||||||||||||||
| estimatedAvailabilities.estimatedAvailabilityStatus | AvailabilityStatusEnum | An enumeration value representing the inventory status of this item. Note: Be sure to review the itemEndDate field to determine whether the item is available for purchase. 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 | |||||||||||||||
| estimatedAvailabilities.estimatedAvailableQuantity | integer | The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned. Occurrence: Conditional | |||||||||||||||
| estimatedAvailabilities.estimatedSoldQuantity | integer | The estimated number of this item that have been sold. Occurrence: Conditional | |||||||||||||||
| gender | string | (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 | |||||||||||||||
| gtin | string | The 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 | |||||||||||||||
| image | Image | The URL of the primary image of the item. The other images of the item are returned in the additionalImages container. Occurrence: Always | |||||||||||||||
| image.height | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| image.imageUrl | string | The URL of the image. Occurrence: Always | |||||||||||||||
| image.width | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| inferredEpid | string | The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data. If the seller provided an ePID for the item, the seller's value is returned in the epid field. Note: This field is returned only for authorized Partners. Occurrence: Conditional | |||||||||||||||
| itemAffiliateWebUrl | string | The URL of the View Item page of the item, which includes the affiliate tracking ID. This field is only returned if the eBay partner enables affiliate tracking for the item by including the X-EBAY-C-ENDUSERCTX request header in the method. 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 | |||||||||||||||
| itemEndDate | string | This timestamp indicates the date and time up to which the item 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. Note: This field is only returned for auction listings. Occurrence: Conditional | |||||||||||||||
| itemId | string | The unique RESTful identifier of the item. Occurrence: Always | |||||||||||||||
| itemLocation | Address | The physical location of the item. Occurrence: Conditional | |||||||||||||||
| itemLocation.addressLine1 | string | The first line of the street address. Note: This is conditionally returned in the itemLocation field. Occurrence: Conditional | |||||||||||||||
| itemLocation.addressLine2 | string | The 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.city | string | The city of the address. Occurrence: Always | |||||||||||||||
| itemLocation.country | CountryCodeEnum | The two-letter ISO 3166 standard of the country of the address. Occurrence: Always | |||||||||||||||
| itemLocation.county | string | The county of the address. Occurrence: Conditional | |||||||||||||||
| itemLocation.postalCode | string | The 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 | |||||||||||||||
| itemLocation.stateOrProvince | string | The state or province of the address. Note: This is conditionally returned in the itemLocation field. Occurrence: Conditional | |||||||||||||||
| itemWebUrl | string | The URL of the View Item page of the item. This enables you to include a "Report Item on eBay" link that takes the buyer to the View Item page on eBay. From there they can report any issues regarding this item to eBay. Occurrence: Always | |||||||||||||||
| legacyItemId | string | The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page. Occurrence: Always | |||||||||||||||
| localizedAspects | array of TypedNameValue | An array of containers that show the complete list of the aspect name/value pairs that describe the variation of the item. Occurrence: Conditional | |||||||||||||||
| localizedAspects.name | string | The text representing the name of the aspect for the name/value pair, such as Color. Occurrence: Conditional | |||||||||||||||
| localizedAspects.type | ValueTypeEnum | This indicates if the value being returned is a string or an array of values. Valid Values:
Occurrence: Conditional | |||||||||||||||
| localizedAspects.value | string | The value of the aspect for the name/value pair, such as Red. Occurrence: Conditional | |||||||||||||||
| lotSize | integer | The number of items in a lot. In other words, a lot size is the number of items that are being sold together. A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.
Note: Lots are not supported in all categories. Occurrence: Conditional | |||||||||||||||
| marketingPrice | MarketingPrice | The original price and the discount amount and percentage. Occurrence: Conditional | |||||||||||||||
| marketingPrice.discountAmount | ConvertedAmount | This container returns the monetary amount of the seller discount. Occurrence: Conditional | |||||||||||||||
| marketingPrice.discountAmount.convertedFromCurrency | CurrencyCodeEnum | The 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.convertedFromValue | string | The 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.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| marketingPrice.discountAmount.value | string | The 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: Conditional | |||||||||||||||
| marketingPrice.discountPercentage | string | This field expresses the percentage of the seller discount based on the value in the originalPrice container. Occurrence: Conditional | |||||||||||||||
| marketingPrice.originalPrice | ConvertedAmount | This container returns the monetary amount of the item without the discount. Occurrence: Conditional | |||||||||||||||
| marketingPrice.originalPrice.convertedFromCurrency | CurrencyCodeEnum | The 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.convertedFromValue | string | The 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.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| marketingPrice.originalPrice.value | string | The 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: Conditional | |||||||||||||||
| marketingPrice.priceTreatment | PriceTreatmentEnum | Indicates 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 | |||||||||||||||
| material | string | (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 | |||||||||||||||
| minimumPriceToBid | ConvertedAmount | The minimum price of the next bid, which means to place a bid it must be 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.convertedFromCurrency | CurrencyCodeEnum | The 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.convertedFromValue | string | The 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.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| minimumPriceToBid.value | string | The 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: Conditional | |||||||||||||||
| mpn | string | The manufacturer's part number, which is a unique number that identifies a specific product. To identify the product, this is always used along with brand. Occurrence: Conditional | |||||||||||||||
| pattern | string | (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 | |||||||||||||||
| paymentMethods | array of PaymentMethod | The payment methods for the item, including the payment method types, brands, and instructions for the buyer. Occurrence: Conditional | |||||||||||||||
| paymentMethods.paymentMethodType | PaymentMethodTypeEnum | The payment method type, such as credit card or cash. Occurrence: Conditional | |||||||||||||||
| paymentMethods.paymentMethodBrands | array of PaymentMethodBrand | The payment method brands, including the payment method brand type and logo image. Occurrence: Conditional | |||||||||||||||
| paymentMethods.paymentMethodBrands.paymentMethodBrandType | PaymentMethodBrandEnum | The payment method brand, such as Visa or PayPal. Occurrence: Conditional | |||||||||||||||
| paymentMethods.paymentMethodBrands.logoImage | Image | The details of the logo image, such as the size and URL. Note: Currently, only the imageUrl is populated. Occurrence: Conditional | |||||||||||||||
| paymentMethods.paymentMethodBrands.logoImage.height | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| paymentMethods.paymentMethodBrands.logoImage.imageUrl | string | The URL of the image. Occurrence: Always | |||||||||||||||
| paymentMethods.paymentMethodBrands.logoImage.width | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| paymentMethods.paymentInstructions | array of PaymentInstructionEnum | The payment instructions for the buyer, such as cash in person or contact seller. Occurrence: Conditional | |||||||||||||||
| paymentMethods.sellerInstructions | array of SellerInstructionEnum | The seller instructions to the buyer, such as accepts credit cards or see description. Occurrence: Conditional | |||||||||||||||
| price | ConvertedAmount | The cost of just the item. This amount does not include any adjustments such as discounts or shipping costs. Note: The price does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU. Occurrence: Always | |||||||||||||||
| price.convertedFromCurrency | CurrencyCodeEnum | The 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.convertedFromValue | string | The 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.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| price.value | string | The 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: Conditional | |||||||||||||||
| priceDisplayCondition | PriceDisplayConditionEnum | 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. Occurrence: Conditional | |||||||||||||||
| primaryItemGroup | ItemGroupSummary | The container that returns details of a primary item group (parent ID of an item group). An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc. Note: This container is returned only if the item_id in the request is for an item group (items with variations, such as color and size). Occurrence: Conditional | |||||||||||||||
| primaryItemGroup.itemGroupAdditionalImages | array of Image | An 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.height | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| primaryItemGroup.itemGroupAdditionalImages.imageUrl | string | The URL of the image. Occurrence: Always | |||||||||||||||
| primaryItemGroup.itemGroupAdditionalImages.width | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| primaryItemGroup.itemGroupHref | string | The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. Occurrence: Conditional | |||||||||||||||
| primaryItemGroup.itemGroupId | string | The 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.itemGroupImage | Image | The 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.height | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| primaryItemGroup.itemGroupImage.imageUrl | string | The URL of the image. Occurrence: Always | |||||||||||||||
| primaryItemGroup.itemGroupImage.width | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| primaryItemGroup.itemGroupTitle | string | The 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.itemGroupType | ItemGroupTypeEnum | An 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 | |||||||||||||||
| primaryProductReviewRating | ReviewRating | The container that returns the product rating details, such as review count, rating histogram, and average rating. Occurrence: Conditional | |||||||||||||||
| primaryProductReviewRating.averageRating | string | The average rating given to a product based on customer reviews. Occurrence: Conditional | |||||||||||||||
| primaryProductReviewRating.ratingHistograms | array of RatingHistogram | An array of containers for the product rating histograms that shows the review counts and the product rating. Occurrence: Conditional | |||||||||||||||
| primaryProductReviewRating.ratingHistograms.count | integer | The total number of user ratings that the product has received. Occurrence: Conditional | |||||||||||||||
| primaryProductReviewRating.ratingHistograms.rating | string | This 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.reviewCount | integer | The total number of reviews for the item. Occurrence: Conditional | |||||||||||||||
| priorityListing | boolean | This field is returned as true if the listing is part of a Promoted Listing campaign. Promoted Listings are available to Above Standard and Top Rated sellers with recent sales activity.For more information, see Promoted Listings. Occurrence: Always | |||||||||||||||
| product | Product | The container that returns the product information of the item. Occurrence: Conditional | |||||||||||||||
| product.additionalImages | array of Image | An array of containers with the URLs for the product images that are in addition to the primary image. Occurrence: Conditional | |||||||||||||||
| product.additionalImages.height | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| product.additionalImages.imageUrl | string | The URL of the image. Occurrence: Always | |||||||||||||||
| product.additionalImages.width | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| product.additionalProductIdentities | array of AdditionalProductIdentity | An 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.productIdentity | array of ProductIdentity | An 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.
Occurrence: Conditional | |||||||||||||||
| product.additionalProductIdentities.productIdentity.identifierType | string | The type of product identifier, such as UPC and EAN. Occurrence: Conditional | |||||||||||||||
| product.additionalProductIdentities.productIdentity.identifierValue | string | The product identifier value. Occurrence: Conditional | |||||||||||||||
| product.aspectGroups | array of AspectGroup | An array of containers for the product aspects. Each group contains the aspect group name and the aspect name/value pairs. Occurrence: Conditional | |||||||||||||||
| product.aspectGroups.aspects | array of Aspect | An array of the name/value pairs for the aspects of the product. For example: BRAND/Apple Occurrence: Conditional | |||||||||||||||
| product.aspectGroups.aspects.localizedName | string | The text representing the name of the aspect for the name/value pair, such as Brand. Occurrence: Conditional | |||||||||||||||
| product.aspectGroups.aspects.localizedValues | array of string | The text representing the value of the aspect for the name/value pair, such as Apple. Occurrence: Conditional | |||||||||||||||
| product.aspectGroups.localizedGroupName | string | The 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 Processor Occurrence: Conditional | |||||||||||||||
| product.brand | string | The brand associated with product. To identify the product, this is always used along with MPN (manufacturer part number). Occurrence: Conditional | |||||||||||||||
| product.description | string | The rich description of an eBay product, which might contain HTML. Occurrence: Conditional | |||||||||||||||
| product.gtins | array of string | An 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 | |||||||||||||||
| product.image | Image | The primary image of the product. This is often a stock photo. Occurrence: Conditional | |||||||||||||||
| product.image.height | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| product.image.imageUrl | string | The URL of the image. Occurrence: Always | |||||||||||||||
| product.image.width | integer | Reserved for future use. Occurrence: Conditional | |||||||||||||||
| product.mpns | array of string | An 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.title | string | The title of the product. Occurrence: Conditional | |||||||||||||||
| productFicheWebUrl | string | The URL of a page containing the manufacturer's specification of this item, which helps buyers make a purchasing decision. This information is available only for items that include the European energy efficiency rating (EEK) but is not available for all items with an EEK rating and is returned only if this information is available. The EEK rating of the item is returned in the energyEfficiencyClass field. Occurrence: Conditional | |||||||||||||||
| qualifiedPrograms | array of string | An array of the qualified programs available for the item, such as EBAY_PLUS, AUTHENTICITY_GUARANTEE, and AUTHENTICITY_VERIFICATION. eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items. Note: eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces. The eBay Authenticity Guarantee program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers. Occurrence: Conditional | |||||||||||||||
| quantityLimitPerBuyer | integer | The maximum number for a specific item that one buyer can purchase. Occurrence: Conditional | |||||||||||||||
| reservePriceMet | boolean | This indicates if the reserve price of the item has been met. A reserve price is set by the seller and is the minimum amount the seller is willing to sell the item for. If the highest bid is not equal to or higher than the reserve price when the auction ends, the listing ends and the item is not sold. Note: This is returned only for auctions that have a reserve price. Occurrence: Conditional | |||||||||||||||
| returnTerms | ItemReturnTerms | The container that returns an overview of the seller's return policy. Occurrence: Conditional | |||||||||||||||
| returnTerms.extendedHolidayReturnsOffered | boolean | This 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 | |||||||||||||||
| returnTerms.refundMethod | RefundMethodEnum | An 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 | |||||||||||||||
| returnTerms.restockingFeePercentage | string | This 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.returnInstructions | string | Text written by the seller describing what the buyer needs to do in order to return the item. Occurrence: Conditional | |||||||||||||||
| returnTerms.returnMethod | ReturnMethodEnum | An 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:
Occurrence: Conditional | |||||||||||||||
| returnTerms.returnPeriod | TimeDuration | The amount of time the buyer has to return the item after the purchase date. Occurrence: Conditional | |||||||||||||||
| returnTerms.returnPeriod.unit | TimeDurationUnitEnum | An 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 | |||||||||||||||
| returnTerms.returnPeriod.value | integer | Retrieves 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.returnsAccepted | boolean | Indicates whether the seller accepts returns for the item. Occurrence: Conditional | |||||||||||||||
| returnTerms.returnShippingCostPayer | ReturnShippingCostPayerEnum | This enumeration value indicates whether the buyer or seller is responsible for return shipping costs when an item is returned. Valid Values:
Occurrence: Conditional | |||||||||||||||
| seller | SellerDetail | The container that returns basic and detailed about the seller of the item, such as name, feedback score, and contact information. Occurrence: Always | |||||||||||||||
| seller.feedbackPercentage | string | The percentage of the total positive feedback. Occurrence: Always | |||||||||||||||
| seller.feedbackScore | integer | The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. Occurrence: Always | |||||||||||||||
| seller.sellerAccountType | string | This 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 | |||||||||||||||
| seller.sellerLegalInfo | SellerLegalInfo | The container with the seller's contact info and fields that are required by law. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.email | string | The seller's business email address. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.fax | string | The seller' business fax number. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.imprint | string | This 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.legalContactFirstName | string | The seller's first name. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.legalContactLastName | string | The seller's last name. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.name | string | The name of the seller's business. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.phone | string | The seller's business phone number. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.registrationNumber | string | The seller's registration number. This is information used by some countries. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.sellerProvidedLegalAddress | LegalAddress | The container that returns the seller's address to be used to contact them. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.sellerProvidedLegalAddress.addressLine1 | string | The first line of the street address. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.sellerProvidedLegalAddress.addressLine2 | string | The 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.city | string | The city of the address. Occurrence: Always | |||||||||||||||
| seller.sellerLegalInfo.sellerProvidedLegalAddress.country | CountryCodeEnum | The two-letter ISO 3166 standard of the country of the address. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.sellerProvidedLegalAddress.countryName | string | The name of the country of the address. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.sellerProvidedLegalAddress.county | string | The name of the county of the address. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.sellerProvidedLegalAddress.postalCode | string | The postal code of the address. Occurrence: Conditional | |||||||||||||||
| seller.sellerLegalInfo.sellerProvidedLegalAddress.stateOrProvince | string | The state or province of the address. Occurrence: Always | |||||||||||||||
| seller.sellerLegalInfo.termsOfService | string | This 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.vatDetails | array of VatDetail | An 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.issuingCountry | CountryCodeEnum | The 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.vatId | string | The seller's VAT (value added tax) ID. VAT is a tax added by some European countries. Occurrence: Conditional | |||||||||||||||
| seller.username | string | The user name created by the seller for use on eBay. Occurrence: Always | |||||||||||||||
| sellerCustomPolicies | array of SellerCustomPolicy | A list of the custom policies that are applied to a listing. Occurrence: Conditional | |||||||||||||||
| sellerCustomPolicies.description | string | The seller-defined description of the policy. Occurrence: Conditional | |||||||||||||||
| sellerCustomPolicies.label | string | The seller-defined label for an individual custom policy. Occurrence: Conditional | |||||||||||||||
| sellerCustomPolicies.type | SellerCustomPolicyTypeEnum | The type of custom policy, such as PRODUCT_COMPLIANCE or TAKE_BACK. Occurrence: Conditional | |||||||||||||||
| sellerItemRevision | string | An identifier generated/incremented when a seller revises the item. There are two types of item revisions:
Occurrence: Conditional | |||||||||||||||
| shippingOptions | array of ShippingOption | An array of shipping options containers that have the details about cost, carrier, etc. of one shipping option. Occurrence: Always | |||||||||||||||
| shippingOptions.additionalShippingCostPerUnit | ConvertedAmount | Any 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.convertedFromCurrency | CurrencyCodeEnum | The 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.convertedFromValue | string | The 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.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| shippingOptions.additionalShippingCostPerUnit.value | string | The 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: Conditional | |||||||||||||||
| shippingOptions.cutOffDateUsedForEstimate | string | The 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.fulfilledThrough | FulfilledThroughEnum | If the item is being shipped by eBay's Global Shipping Program, this field returns GLOBAL_SHIPPING. Otherwise this field is null. Occurrence: Conditional | |||||||||||||||
| shippingOptions.guaranteedDelivery | boolean | Indicates if the seller has committed to shipping the item with eBay Guaranteed Delivery. With eBay Guaranteed Delivery, the seller is committed to getting the line item to the buyer within 4 business days or less. See the Buying items with eBay Guaranteed Delivery help topic for more details about eBay Guaranteed Delivery. Occurrence: Conditional | |||||||||||||||
| shippingOptions.importCharges | ConvertedAmount | The Global Shipping Program import charges for this item. Occurrence: Conditional | |||||||||||||||
| shippingOptions.importCharges.convertedFromCurrency | CurrencyCodeEnum | The 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.importCharges.convertedFromValue | string | The 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.importCharges.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| shippingOptions.importCharges.value | string | The 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: Conditional | |||||||||||||||
| shippingOptions.maxEstimatedDeliveryDate | string | The 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.minEstimatedDeliveryDate | string | The 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.quantityUsedForEstimate | integer | The number of items used when calculating the estimation information. Occurrence: Conditional | |||||||||||||||
| shippingOptions.shippingCarrierCode | string | The name of the shipping provider, such as FedEx, or USPS. Occurrence: Always | |||||||||||||||
| shippingOptions.shippingCost | ConvertedAmount | The final shipping cost for all the items after all discounts are applied. Note: The cost does include the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive cost. For more information on VAT, refer to VAT Obligations in the EU. Occurrence: Always | |||||||||||||||
| shippingOptions.shippingCost.convertedFromCurrency | CurrencyCodeEnum | The 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.convertedFromValue | string | The 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.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| shippingOptions.shippingCost.value | string | The 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: Conditional | |||||||||||||||
| shippingOptions.shippingCostType | string | Indicates 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.shippingServiceCode | string | The type of shipping service. For example, USPS First Class. Occurrence: Always | |||||||||||||||
| shippingOptions.shipToLocationUsedForEstimate | ShipToLocation | The 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.country | CountryCodeEnum | The two-letter ISO 3166 standard of the country for where the item is to be shipped. Occurrence: Conditional | |||||||||||||||
| shippingOptions.shipToLocationUsedForEstimate.postalCode | string | The zip code (postal code) for where the item is to be shipped. Occurrence: Conditional | |||||||||||||||
| shippingOptions.trademarkSymbol | string | Any trademark symbol, such as ™ or ®, that needs to be shown in superscript next to the shipping service name. Occurrence: Conditional | |||||||||||||||
| shippingOptions.type | string | The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc. Occurrence: Always | |||||||||||||||
| shipToLocations | ShipToLocations | The container that returns the geographic regions to be included and excluded that define where the item can be shipped. Occurrence: Conditional | |||||||||||||||
| shipToLocations.regionExcluded | array of ShipToRegion | An array of containers that express the large geographical regions, countries, state/provinces, or special locations within a country where the seller is not willing to ship to. Occurrence: Conditional | |||||||||||||||
| shipToLocations.regionExcluded.regionId | string | The unique identifier of the shipping region. The value returned here is dependent on the corresponding regionType value. The regionId value for a region does not vary based on the eBay marketplace. However, the corresponding regionName value for a region is a localized, text-based description of the shipping region. If the regionType value is WORLDWIDE, the regionId value will also be WORLDWIDE.If the regionType value is WORLD_REGION, the regionId value will be one of the following: AFRICA, AMERICAS, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EUROPEAN_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, SOUTH_AMERICA, SOUTHEAST_ASIA or CHANNEL_ISLANDS.If the regionType value is COUNTRY, the regionId value will be the two-letter code for the country, as defined in the ISO 3166 standard.If the regionType value is STATE_OR_PROVINCE, the regionId value will either be the two-letter code for US states and DC (as defined on this Social Security Administration page), or the two-letter code for Canadian provinces (as defined by this Canada Post page).If the regionType value is COUNTRY_REGION, the regionId value may be one of following: _AH (if a seller is not willing to ship to Alaska/Hawaii), _PR (if the seller is not willing to ship to US Protectorates), _AP (if seller is not willing to ship to a US Army or Fleet Post Office), and PO_BOX (if the seller is not willing to ship to a Post Office Box). Occurrence: Conditional | |||||||||||||||
| shipToLocations.regionExcluded.regionName | string | A localized text string that indicates the name of the shipping region. The value returned here is dependent on the corresponding regionType value. If the regionType value is WORLDWIDE, the regionName value will show Worldwide.If the regionType value is WORLD_REGION, the regionName value will be a localized text string for one of the following large geographical regions: Africa, Americas, Asia, Australia, Central America and Caribbean, Europe, European Union, Greater China, Middle East, North America, Oceania, South America, Southeast Asia, or Channel Islands.If the regionType value is COUNTRY, the regionName value will be a localized text string for any country in the world.If the regionType value is STATE_OR_PROVINCE, the regionName value will be a localized text string for any US state or Canadian province. If the regionType value is COUNTRY_REGION, the regionName value may be a localized version of one of the following: Alaska/Hawaii, US Protectorates, APO/FPO (Army or Fleet Post Office), or PO BOX. Occurrence: Conditional | |||||||||||||||
| shipToLocations.regionExcluded.regionType | RegionTypeEnum | An enumeration value that indicates the level or type of shipping region. Valid Values:
Code so that your app gracefully handles any future changes to this list. Occurrence: Conditional | |||||||||||||||
| shipToLocations.regionIncluded | array of ShipToRegion | An array of containers that express the large geographical regions, countries, or state/provinces within a country where the seller is willing to ship to. Prospective buyers must look at the shipping regions under this container, as well as the shipping regions that are under the regionExcluded to see where the seller is willing to ship items. Sellers can specify that they ship 'Worldwide', but then add several large geographical regions (e.g. Asia, Oceania, Middle East) to the exclusion list, or sellers can specify that they ship to Europe and Africa, but then add several individual countries to the exclusion list. Occurrence: Conditional | |||||||||||||||
| shipToLocations.regionIncluded.regionId | string | The unique identifier of the shipping region. The value returned here is dependent on the corresponding regionType value. The regionId value for a region does not vary based on the eBay marketplace. However, the corresponding regionName value for a region is a localized, text-based description of the shipping region. If the regionType value is WORLDWIDE, the regionId value will also be WORLDWIDE.If the regionType value is WORLD_REGION, the regionId value will be one of the following: AFRICA, AMERICAS, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EUROPEAN_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, SOUTH_AMERICA, SOUTHEAST_ASIA or CHANNEL_ISLANDS.If the regionType value is COUNTRY, the regionId value will be the two-letter code for the country, as defined in the ISO 3166 standard.If the regionType value is STATE_OR_PROVINCE, the regionId value will either be the two-letter code for US states and DC (as defined on this Social Security Administration page), or the two-letter code for Canadian provinces (as defined by this Canada Post page).If the regionType value is COUNTRY_REGION, the regionId value may be one of following: _AH (if a seller is not willing to ship to Alaska/Hawaii), _PR (if the seller is not willing to ship to US Protectorates), _AP (if seller is not willing to ship to a US Army or Fleet Post Office), and PO_BOX (if the seller is not willing to ship to a Post Office Box). Occurrence: Conditional | |||||||||||||||
| shipToLocations.regionIncluded.regionName | string | A localized text string that indicates the name of the shipping region. The value returned here is dependent on the corresponding regionType value. If the regionType value is WORLDWIDE, the regionName value will show Worldwide.If the regionType value is WORLD_REGION, the regionName value will be a localized text string for one of the following large geographical regions: Africa, Americas, Asia, Australia, Central America and Caribbean, Europe, European Union, Greater China, Middle East, North America, Oceania, South America, Southeast Asia, or Channel Islands.If the regionType value is COUNTRY, the regionName value will be a localized text string for any country in the world.If the regionType value is STATE_OR_PROVINCE, the regionName value will be a localized text string for any US state or Canadian province. If the regionType value is COUNTRY_REGION, the regionName value may be a localized version of one of the following: Alaska/Hawaii, US Protectorates, APO/FPO (Army or Fleet Post Office), or PO BOX. Occurrence: Conditional | |||||||||||||||
| shipToLocations.regionIncluded.regionType | RegionTypeEnum | An enumeration value that indicates the level or type of shipping region. Valid Values:
Code so that your app gracefully handles any future changes to this list. Occurrence: Conditional | |||||||||||||||
| shortDescription | string | This text string is derived from the item condition and the item aspects (such as size, color, capacity, model, brand, etc.). Occurrence: Conditional | |||||||||||||||
| size | string | (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 | |||||||||||||||
| sizeSystem | string | (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 | |||||||||||||||
| sizeType | string | (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 | |||||||||||||||
| subtitle | string | A 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 | |||||||||||||||
| taxes | array of Taxes | The container for the tax information for the item. Occurrence: Conditional | |||||||||||||||
| taxes.ebayCollectAndRemitTax | boolean | This 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.includedInPrice | boolean | This indicates if tax was applied for the cost of the item. Occurrence: Conditional | |||||||||||||||
| taxes.shippingAndHandlingTaxed | boolean | This indicates if tax is applied for the shipping cost. Occurrence: Conditional | |||||||||||||||
| taxes.taxJurisdiction | TaxJurisdiction | The container that returns the tax jurisdiction. Occurrence: Conditional | |||||||||||||||
| taxes.taxJurisdiction.region | Region | The region of the tax jurisdiction. Occurrence: Conditional | |||||||||||||||
| taxes.taxJurisdiction.region.regionName | string | A localized text string that indicates the name of the region. Taxes are generally charged at the state/province level or at the country level in the case of VAT tax. Occurrence: Conditional | |||||||||||||||
| taxes.taxJurisdiction.region.regionType | RegionTypeEnum | An enumeration value that indicates the type of region for the tax jurisdiction. Valid Values:
Occurrence: Conditional | |||||||||||||||
| taxes.taxJurisdiction.taxJurisdictionId | string | The identifier of the tax jurisdiction. Occurrence: Conditional | |||||||||||||||
| taxes.taxPercentage | string | The percentage of tax. Occurrence: Conditional | |||||||||||||||
| taxes.taxType | TaxType | This field indicates the type of tax that may be collected for the item. Occurrence: Conditional | |||||||||||||||
| title | string | The seller-created title of the item. Maximum Length: 80 characters Occurrence: Always | |||||||||||||||
| topRatedBuyingExperience | boolean | This 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 | |||||||||||||||
| tyreLabelImageUrl | string | The URL to the image that shows the information on the tyre label. Occurrence: Conditional | |||||||||||||||
| uniqueBidderCount | integer | This integer value indicates the number of different eBay users who have placed one or more bids on an auction item. This field is only applicable to auction items. Occurrence: Conditional | |||||||||||||||
| unitPrice | ConvertedAmount | This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices. For example: "unitPricingMeasure": "100g", Occurrence: Conditional | |||||||||||||||
| unitPrice.convertedFromCurrency | CurrencyCodeEnum | The 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.convertedFromValue | string | The 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.currency | CurrencyCodeEnum | The 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: Conditional | |||||||||||||||
| unitPrice.value | string | The 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: Conditional | |||||||||||||||
| unitPricingMeasure | string | The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices. For example, the following tells the buyer that the item is 7.99 per 100 grams. "unitPricingMeasure": "100g", Occurrence: Conditional | |||||||||||||||
| warnings | array of ErrorDetailV3 | An array of warning messages. These types of errors do not prevent the method from executing but should be checked. Occurrence: Conditional | |||||||||||||||
| warnings.category | string | This string value indicates the error category. There are three categories of errors: request errors, application errors, and system errors. Occurrence: Always | |||||||||||||||
| warnings.domain | string | The name of the primary system where the error occurred. This is relevant for application errors. Occurrence: Always | |||||||||||||||
| warnings.errorId | integer | A 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.inputRefIds | array of string | An array of reference IDs that identify the specific request elements most closely associated to the error or warning, if any. Occurrence: Conditional | |||||||||||||||
| warnings.longMessage | string | A detailed description of the condition that caused the error or warning, and information on what to do to correct the problem. Occurrence: Conditional | |||||||||||||||
| warnings.message | string | A description of the condition that caused the error or warning. Occurrence: Always | |||||||||||||||
| warnings.outputRefIds | array of string | An array of reference IDs that identify the specific response elements most closely associated to the error or warning, if any. Occurrence: Conditional | |||||||||||||||
| warnings.parameters | array of ErrorParameterV3 | An 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.name | string | This is the name of input field that caused an issue with the call request. Occurrence: Conditional | |||||||||||||||
| warnings.parameters.value | string | This is the actual value that was passed in for the element specified in the name field. Occurrence: Conditional | |||||||||||||||
| warnings.subdomain | string | The name of the subdomain in which the error or warning occurred. Occurrence: NA | |||||||||||||||
| watchCount | integer | The number of users that have added the item to their watch list. Note: This field is restricted to applications that have been granted permission to access this feature. You must submit an App Check ticket to request this access. In the App Check form, add a note to the Application Title/Summary and/or Application Details fields that you want access to Watch Count data in the Browse API. Occurrence: Conditional |
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.
| Status | Meaning |
|---|---|
| 200 | OK |
| 404 | Not Found |
| 409 | Conflict |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 11000 | API_BROWSE | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 11003 | API_BROWSE | REQUEST | The specified legacy item ID was not found. |
| 11004 | API_BROWSE | REQUEST | The 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. |
| 11006 | API_BROWSE | REQUEST | The legacy ID is invalid. Use {itemGroupHref} to get the item group details. |
| 11009 | API_BROWSE | REQUEST | The legacy variation sku is invalid. |
| 11010 | API_BROWSE | REQUEST | You cannot submit legacy_variation_sku and legacy_variation_id in the same request. For help, see the documentation. |
| 11011 | API_BROWSE | REQUEST | The marketplace value {marketplaceId} is not supported. The supported values are: {allowedMarketplaces} |
Warnings
For more on warnings, plus the codes of other common warnings, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 11502 | API_BROWSE | APPLICATION | There was a problem extracting product information for this Item. Please try again. |
| 11508 | API_BROWSE | APPLICATION | This seller is currently away. If you make a purchase, please allow additional time for your order to be processed. |
| 11509 | API_BROWSE | APPLICATION | This seller is currently away until {sellerReturnDate}. If you make a purchase, please allow additional time for your order to be processed. |
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 Using a Legacy ID
Sample 1: Get Item Details Using a Legacy ID
This sample returns the details of a specific item, which is not part of a multi-variation listing, using the legacy ItemID value.
The call returns the REST itemId for the item. This ID can be used with all
Browse and Order API calls.
Input
The input is a legacy_item_id URI parameter. There is no payload with this request.
GET
https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?legacy_item_id=2**********2
Output
The output is the details of the item and the REST itemId
(
v1|2**********2|0).
Sample 2: Get Item Details Using a Legacy ID and SKU
This sample returns the details of specific item, which is part of a multi-variation listing, using the legacy
ItemID value and associated SKU value of an item. These values
are returned by the legacy Trading and Shopping APIs.
It also returns the REST itemId for the item. This ID can be used with all
Browse and Order API calls.
Input
The input is legacy_item_id and legacy_variation_SKU URI parameter. There is no payload with this request.
GET
https://api.ebay.com/buy/browse/v1/item/get_item_by_legacy_id?legacy_item_id=1**********8&legacy_variation_sku=V**********M
Output
The output is the details of the item and the REST itemId (
v1|2**********4|0).