Developers Program

item_all_active

Response fields

{
"itemId" : "string",
"legacyItemId" : "string",
"title" : "string",
"subtitle" : "string",
"image" : "Image",
"categoryId" : "string",
"categoryIdPath" : "string",
"categoryPath" : "string",
"listingMarketplaceId" : "string",
"adultOnly" : "string",
"itemCreationDate" : "string",
"itemEndDate" : "number",
"itemWebUrl" : "string",
"itemAffiliateWebUrl" : "string",
"itemLocationCountry" : "string",
"itemLocationCity" : "string",
"lotSize" : "string",
"sellerItemRevision" : "string",
"gtin" : "string",
"brand" : "string",
"mpn" : "string",
"epid" : "string",
"inferredEpid" : "string",
"sellerUsername" : "string",
"sellerUserId" : "string",
"sellerAccountType" : "string",
"priceValue" : "string",
"originalPriceValue" : "string",
"originalPriceCurrency" : "string",
"discountAmountValue" : "string",
"discountPercentage" : "string",
"unitPriceValue" : "string",
"unitPricingMeasure" : "string",
"conditionId" : "string",
"condition" : "string",
"conditionDescription" : "string",
"energyEfficiencyClass" : "string",
"returnsAccepted" : "boolean",
"returnPeriodValue" : "integer",
"returnPeriodUnit" : "string",
"qualifiedPrograms" : "string",
"primaryItemGroupId" : "string",
"primaryItemGroupType" : "string",
"ageGroup" : "string",
"color" : "string",
"pattern" : "string",
"size" : "string",
"gender" : "string",
"material" : "string",
"repairScore" : "string",
"tyreLabelImageUrl" : "string",
"alerts" : [
"string"
],
"priorityListing" : "boolean",
"defaultImageUrl" : "string",
"inferredGtin" : "string",
"inferredBrand" : "string",
"inferredMpn" : "string",
"totalUnits" : "string"
}

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

legacyItemIdstring

The numeric eBay item ID for the listing, expressed in legacy (classic) format.

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

subtitlestring

An optional subtitle that displays below the listing title, as provided by the seller. A value is only returned if the seller added a subtitle to the listing.

Occurrence: Conditional

imageImage

The primary image for the listing.

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

Occurrence: Conditional

additionalImagesarray of Image

Additional images for the listing beyond the primary image. A value is only returned if the seller provided more than one image for the listing.

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

Occurrence: Conditional

categoryIdstring

The unique identifier of the listing category.

Occurrence: Always

categoryIdPathstring

A pipe-delimited string of the eBay category IDs from the root category to the leaf category for the listing (e.g. 1|11450|15724).

Occurrence: Conditional

categoryPathstring

A pipe-delimited string of the eBay category display names from the root category to the leaf category for the listing.

Occurrence: Always

listingMarketplaceIdstring

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

Occurrence: Always

adultOnlystring

When true, indicates that the listing contains adult-only content.

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

itemEndDatenumber

A timestamp indicating when the item's sale period will end based on its start date and duration. UTC timestamps are used and have the following format: yyyy-MM-ddThh:mm:ss.sssZ.

Occurrence: Conditional

itemWebUrlstring

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

Occurrence: Always

itemAffiliateWebUrlstring

The URL of the View Item page of the item, with the affiliate tracking ID appended to it.

Example:https://www.ebay.de/itm/2********0?mkevt=1&mkcid=1&mkrid=7**-5***7-1*****0&campid=CAMPAIGNID&toolid=2***6&customid=C******D

Occurrence: Conditional

itemLocationCountrystring

The country where the item is physically located.

Occurrence: Conditional

itemLocationCitystring

The city of the item's physical location. A value is only returned if this information is available for the listing.

Occurrence: Conditional

itemLocationPostalCodestring

The postal code of the item's physical location. A value is only returned if this information is available for the listing.

Occurrence: Conditional

itemLocationStateOrProvincestring

The state or province of the item's physical location. A value is only returned if this information is available for the listing.

Occurrence: Conditional

lotSizestring

The number of items included in a lot listing. A value is not returned for single-unit listings.

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

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

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

sellerUsernamestring

The eBay user ID of the seller.

Occurrence: Always

sellerUserIdstring

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

Occurrence: Conditional

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

sellerAccountTypestring

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

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

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

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

discountAmountValuestring

The discount amount off an item's listing price after a coupon is applied. The currency used for this value is shown in the discountAmountCurrency field.

Occurrence: Conditional

discountAmountCurrencyCurrencyCodeEnum

The currency of the discountAmountValue field.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

Occurrence: Conditional

discountPercentagestring

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

Occurrence: Conditional

unitPriceValuestring

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 unitPriceValue value is 6.8, the unitPriceCurrency is EUR, and 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

unitPriceCurrencyCurrencyCodeEnum

The currency of the unitPriceValue field.

The currency is represented as a 3-letter ISO 4217 currency code. For example, the code for the Canadian Dollar is CAD.

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

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

conditionDescriptionstring

A seller-provided, free-text description of the item's condition. A value is only returned if the seller included this information.

Occurrence: Conditional

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

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

estimatedAvailabilitiesarray of EstimatedAvailability

Availability and delivery information for the item. One entry per delivery option.

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

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

shippingOptionsarray of ShippingOption

The available shipping methods for the listing. The first entry is generally the primary (cheapest/default) method.

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

Occurrence: Conditional

shipToLocationsShipToLocations

The ship-to region inclusions and exclusions for the listing.

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

Occurrence: Conditional

qualifiedProgramsstring

A pipe separated list of eBay programs that the listing qualifies for, such as EBAY_PLUS and AUTHENTICITY_GUARANTEE.

eBay Plus is a premium account option for buyers, which provides benefits such as fast and free domestic shipping and free returns on selected items. 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 luxury watches, collectible sneakers, or high-end handbags.

Occurrence: Conditional

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

primaryItemGroupTypestring

The type of the parent item group for a variation item. Currently, the only value returned is SELLER_DEFINED_VARIATIONS. This field is only populated for variation items.

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

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

ageGroupstring

The age group(s) that the product is intended for. A value for this field will only be returned if age/age level/age range/age group is a defined item specific for the listing. The item specifics in the actual listing will most likely use age values/ranges, but the Buy Feed API maps these age values/ranges to the following values: newborn, infant, toddler, kids, or adult.

Occurrence: Conditional

colorstring

The color of the item. A value for this field will only be returned if 'Color' is a defined item specific or variation specific for the listing.

Occurrence: Conditional

patternstring

The pattern of the item (e.g. Solid, Striped), as derived by eBay's classifier. A value is only returned if this information could be inferred for the listing.

Occurrence: Conditional

sizestring

The size of the item. A value for this field will only be returned if 'Size' is a defined item specific or variation specific for the listing.

Occurrence: Conditional

genderstring

The specified gender that the item is intended for. A value for this field will only be returned if 'Gender' is a defined item specific or variation specific for the listing.

Occurrence: Conditional

materialstring

The material used for the product. A value for this field will only be returned if 'Material' is a defined item specific for the listing.

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

sellerCustomPoliciesarray of SellerCustomPolicy

Seller-defined custom policies for the item (e.g. EU take-back and product compliance policies).

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

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

productSafetyLabelsProductSafetyLabels

The EU product safety label information for an item, distinct from GHS hazardous materials labels.

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

Occurrence: Conditional

responsiblePersonsarray of ResponsiblePerson

An array of EU-required responsible persons or economic operators for product compliance.

For more information about the child fields of this array, see the ResponsiblePerson 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

tyreLabelImageUrlstring

The URL of the tyre label image.

Occurrence: Conditional

alertsarray of string

A list of alerts related to an item.

Occurrence: Conditional

priorityListingboolean

A value of true here indicates that the listing is a Priority Listing, and a value of false here indicates that the listing is not a Priority Listing,

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

defaultImageUrlstring

The URL of the gallery image.

Occurrence: Always

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

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