Skip to main content

Response fields

{
"itemId" : "string",
"title" : "string",
"gtin" : "string",
"brand" : "string",
"mpn" : "string",
"epid" : "string",
"alerts" : [],
}

Response field descriptions

Output container/fieldTypeDescription
itemIdstring

The unique identifier of the listing in eBay RESTful format. For a single-variation listing, an example would be v1|1**********2|0. For a multiple-variation listing, an example would be v1|1**********2|4**********2, with the first set of numbers identifying the listing, and the second set of numbers identifying a specific variation within that listing.

Occurrence: Always

titlestring

The title of the listing. This title can be created by the seller, or it may be the title used by an eBay catalog product if the seller listed the product based off of an eBay catalog product.

Note that if a listing title has special characters in it, such as double quote marks, you may see a backslash character to escape these special characters.

Max length: 80 characters (not including escape characters).

Occurrence: Always

listingMarketplaceIdstring

The unique identifier of the eBay marketplace where an item is listed.

Occurrence: Always

listingMarketplaceLeafCategoryIdstring

The unique identifier of the eBay listing marketplace leaf category to which an item belongs.

Occurrence: Always

imageUrlstring

A list of URLs to all images that are defined for the listing.

Occurrence: Always

sellerUsernamestring

The eBay user ID of the seller.

Occurrence: Always

sellerFeedbackPercentagestring

The percentage of the total positive feedback for the the seller.

Occurrence: Always

sellerFeedbackScoreint

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

Occurrence: Always

gtinstring

The unique Global Trade Item Number of the item. This can be a UPC (Universal Product Code) value, an EAN (European Article Number) value, or an ISBN (International Standard Book Number) value.

Occurrence: Conditional

brandstring

The brand of the product. A value for this field will only be returned if 'Brand' is a defined item specific for the listing.

Occurrence: Conditional

mpnstring

This value is the Manufacturer Part Number (MPN). An MPN value must always be paired with a brand value to make it a valid identifier. So, if a product has an MPN value, the brand value should also be referenced.

Occurrence: Conditional

epidstring

This value is the eBay Product Identifier (ePID). Each eBay catalog product has a unique ePID value.

Occurrence: Always

conditionIdstring

The unique identifier of the condition of an item. For a list of condition name and IDs, see Item condition ID and name values

Occurrence: Conditional

conditionstring

Text describing the condition of the item. For a list of item condition values (and their numeric IDs), see the Item Condition IDs and Names page.

Occurrence: Always

conditionDescriptorsarray of ConditionDescriptor

This array is used by sellers to provide additional information about the condition of an item in a structured format. Condition descriptors are name-value attributes that indicate details about the particular condition of an item.

For more information about the child fields of this array, see the ConditionDescriptor type definition.

Occurrence: Conditional

priceValuestring

The price of the item.

Occurrence: Always

priceCurrencyCurrencyCodeEnum

The currency used for the price of the item. Generally, this is the currency used by the country of the eBay marketplace offering the item.

Occurrence: Always

primaryItemGroupIdstring

The unique identifier of the primary item group to which an item belongs. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

Occurrence: Conditional

sellerItemRevisionstring

The revision number of a seller's item. There are two types of item revisions:

  • Seller changes, such as changing the title
  • eBay system changes, such as changing the quantity when an item is purchased
This number is only updated when a seller makes a revision, meaning this value cannot be used to determine if the quantity has changed.

Occurrence: Conditional

itemLocationCountrystring

The country where the item is physically located.

Occurrence: Conditional

localizedAspectsarray of TypedNameValue

An array of item aspect name/value pairs that provide detailed information about an item or variation.

For more information about the child fields of this array, see the TypedNameValue type definition.

Occurrence: Conditional

sellerTrustLevelSellerTrustLevelEnum

This enumeration value indicates the trust level rating of the seller. An empty value in this field may indicate that the eBay marketplace does not use these seller trust levels, or that the seller has a different rating other than the ones defined in the SellerTrustLevelEnum type.

Occurrence: Conditional

availabilityAvailabilityEnum

This enumeration value will indicate whether quantity of the item is still available for purchase. See the AvailabilityEnum type description for more information on what each value indicates.

Occurrence: Always

imageAlteringProhibitedboolean

A boolean that indicates whether the image(s) can be altered on a listing. If the value is true, you cannot modify the image(s) on a listing.

Occurrence: Always

estimatedAvailableQuantityint

The estimated quantity of an item that is available for purchase.

Occurrence: Conditional

availabilityThresholdTypestring

This field only has a value when the seller sets their availability threshold preference. If applicable, the value of this field will return a value of MORE_THAN, which indicates that the seller has more than the available threshold preference in stock for an item.

Occurrence: Conditional

returnsAcceptedboolean

A value of true here indicates that returns are accepted for the item, and a value of false here indicates that the seller does not accept returns for the item. Please note that a seller must accept a return in the case of an item that a buyer marks as 'not as described' in the listing.

Occurrence: Always

returnPeriodValueinteger

The number of days that the buyer has to return the item after the purchase date. For example, if this value is 30, the buyer has 30 days to return the item for a refund. Return periods can vary by eBay marketplace and listing category, but typical return periods are 30 and 60 days.

A value should always be returned for this field if returns are accepted for the item, but will be returned empty if the seller does not accept (buyer remorse) returns.

Occurrence: Conditional

returnPeriodUnitstring

The unit of the time span (e.g., DAYS) for the return period for an item. See the returnPeriodValue field for the associated value of this unit.

Occurrence: Conditional

returnShippingCostPayerstring

This field indicates whether the buyer or seller is responsible for return shipping if an item is returned.

Occurrence: Conditional

inferredEpidstring

The inferred eBay Product ID (ePID) of an item, which has been programmatically determined by eBay using the item's title, aspects, and other data.

Occurrence: Conditional

inferredGtinstring

The inferred Global Trade Item Number (GTIN) of an item, which has been programmatically determined by eBay using the item's title, aspects, and other data.

Occurrence: Conditional

inferredBrandstring

The inferred brand of an item, which has been programmatically determined by eBay using the item's title, aspects, and other data.

Occurrence: Conditional

inferredMpnstring

The inferred Manufacturer Part Number (MPN) of an item, which has been programmatically determined by eBay using the item's title, aspects, and other data.

Occurrence: Conditional

inferredLocalizedAspectsarray of TypedNameValue

An array of the inferred item aspect name/value pairs that provide detailed information about an item or variation, programmatically determined by eBay. If a seller provided aspects for an item, the seller's values are returned in the localizedAspects array.

For more information about the child fields of this array, see the TypedNameValue type definition.

Occurrence: Conditional

originalPriceValuestring

This is the item's original price (a price that is displayed as struck-through in a View Item page). This field is only applicable to and returned when a seller uses the Strike Through Price (STP) feature for a listing. The actual price (aka 'discounted' price) can be seen in the priceValue field, and the currency used for this field and the priceValue field is shown in the priceCurrency field.

Occurrence: Conditional

originalPriceCurrencystring

The currency of the originalPriveValue of the item.

Occurrence: Conditional

discountAmountstring

The discount amount off an item's listing price after a coupon is applied.

Occurrence: Conditional

discountPercentagestring

The discount percentage off an item's listing price after a coupon is applied.

Occurrence: Conditional

energyEfficiencyClassstring

This field shows the European energy efficiency rating (EEK) of the item. Data is returned in this column only if the seller specified the energy efficiency rating for the item.

The class ratings range 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.

To retrieve the manufacturer's specifications for an item, when they are available, use the getItem method in the Browse API. The information is returned in the productFicheWebUrl field.

Occurrence: Conditional

shippingCoststring

The cost to ship the item using the cheapest shipping service option available for the item. Unless the seller uses flat-rate shipping and charges the same price to ship the item to all locations where he/she is willing to ship, the actual shipping cost will vary based on where the buyer is located.

Some sellers will offer a free shipping option, and if that is the case, the value returned here will be 0.0.

Occurrence: Conditional

unitPricestring

This field shows the price per weight, per volume, or per count of the item. For this value to mean something, the user must also look at the unitPricingMeasure field, which will show the weight/volume/count measurement unit such as 100 ml. So, if the unitPrice value is 6.8 EUR, the unitPricingMeasure value is 100 ml, the unit price will be 6.8 EUR per 100 ml. This field is only applicable for eBay marketplaces and categories that support unit pricing. This feature helps buyers compare prices across products/brands.

Occurrence: Conditional

unitPricingMeasurestring

This field shows the measurement used for unit pricing. In unit pricing, the unit price per weight, per volume, or per count is shown. An example would be 100 ml. And for this value to mean something, the user must also look at the unitPrice field, which will show the price per 100 ml. So, if the unitPrice value is 6.8 EUR, the unit price will be 6.8 EUR per 100 ml. This field is only applicable for eBay marketplaces and categories that support unit pricing. This feature helps buyers compare prices across products/brands.

Occurrence: Conditional

alertsarray of string

A list of alerts related to an item.

Occurrence: Conditional

sellerAccountTypestring

This field specifies whether the seller's account is registered as a business account or as an individual account.

Occurrence: Conditional

tyreLabelImageUrlstring

The URL of the tyre label image.

Occurrence: Conditional

itemCreationDatestring

A timestamp indicating when the listing was created. UTC timestamps are used and have the following format: yyyy-MM-ddThh:mm:ss.sssZ.

Occurrence: Always

itemWebUrlstring

The URL of the View Item page of the listing or item variation within the listing.

Occurrence: Always

totalUnitsstring

For an item that is priced by weight or length, this field shows the total number of units that are sale for one quantity of the item. For example, if the item is priced by weight, this field might show a value of 1.0 and the unitType field might show a value of POUND, meaning one quantity of the item has a weight of 1 pound. If the item is priced by length, this field might show a value of 1.0 and the unitType field might show FOOT, meaning one quantity of the item has a length of 1 foot.

Occurrence: Conditional

ecoParticipationFeeValuestring

The value of the eco-participation fee.

This value is a fee paid towards the eventual disposal of the purchased item.

Occurrence: Conditional

ecoParticipationFeeCurrencystring

The currency of the eco-participation fee.

Occurrence: Conditional

takeBackPolicyLabelstring

The seller-defined label of the take-back policy for an item.

This policy describes the seller's regulatory responsibility to take back a purchased item for disposal when the buyer purchases an item.

Occurrence: Conditional

takeBackPolicyDescriptionstring

The seller-defined description of the take-back policy for an item.

Occurrence: Conditional

hazardousMaterialsLabelsHazardousMaterialsLabels

The hazardous materials label information for an item.

For more information about this complex type and its child fields, see the HazardousMaterialsLabels type definition.

Occurrence: Conditional

repairScorestring

A score that describes how easy it is to repair the product. Score values range from 0.1 (hardest to repair) to 10.0 (easiest to repair).

Occurrence: Conditional

sellerUserIdstring

The unique identifier of an eBay user across all eBay sites.

Occurrence: Conditional