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" : "boolean",
"itemCreationDate" : "string",
"itemEndDate" : "string",
"itemWebUrl" : "string",
"itemAffiliateWebUrl" : "string",
"lotSize" : "integer",
"sellerItemRevision" : "string",
"gtin" : "string",
"brand" : "string",
"mpn" : "string",
"epid" : "string",
"inferredEpid" : "string",
"seller" : "Seller",
"unitPricingMeasure" : "string",
"conditionId" : "string",
"condition" : "string",
"conditionDescription" : "string",
"energyEfficiencyClass" : "string",
"qualifiedPrograms" : [
"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, 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 displayed below the listing title.

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.

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

The pipe-delimited category IDs from root to leaf (e.g. 1|11450|15724).

Occurrence: Conditional

categoryPathstring

The pipe-delimited category display names from root to leaf.

Occurrence: Always

listingMarketplaceIdstring

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

Occurrence: Conditional

adultOnlyboolean

When true, 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

itemEndDatestring

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: Conditional

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

itemLocationItemLocation

The physical location of the item.

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

Occurrence: Conditional

lotSizeinteger

The number of items in a lot listing. Returned as null 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) associated with the item. Depending on the feed type, this value may be provided by the seller or matched/assigned by eBay's catalog service. When catalog-matched, each eBay catalog product has a unique ePID value.

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

sellerSeller

Information about the seller who listed the item.

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

Occurrence: Always

priceMonetaryAmount

The current listing price of the item.

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

Occurrence: Always

marketingPriceMarketingPrice

Strikethrough / markdown pricing details. Populated when a promotional price is active.

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

Occurrence: Conditional

unitPriceMonetaryAmount

The per-unit price for items sold by measure (e.g. per 100ml). For this value to mean something, also refer to the unitPricingMeasure field.

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

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: Conditional

conditionDescriptionstring

A seller-provided free-text description of the item's condition.

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

returnTermsReturnTerms

The return policy terms set by the seller.

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

Occurrence: Conditional

shippingOptionsarray of ShippingOption

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

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

Occurrence: Conditional

shipToLocationsShipToLocations

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

qualifiedProgramsarray of string

eBay programs the item qualifies for (e.g. EBAY_PLUS, AUTHENTICITY_GUARANTEE, FEATURED).

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

primaryItemGroupPrimaryItemGroup

The parent item group. Populated only for variation items.

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

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 item's pattern (classifier-derived, e.g. Solid, Striped).

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

ecoParticipationFeeMonetaryAmount

The EU eco-participation fee. Applies to EPR-regulated products (e.g. France, Germany).

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

Occurrence: Conditional

sellerCustomPoliciesarray of SellerCustomPolicy

Seller-defined custom policies for the item, such as take-back or 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

EU-required responsible persons / economic operator contacts 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

alertsstring

Pipe-delimited feed alert codes related to an item (e.g. DELAYED_DELIVERY for seller vacation).

Occurrence: Conditional

priorityListingboolean

A value of true here indicates that the item is enrolled in eBay's Promoted Listings Ads program, and a value of false here indicates that it is not.

Occurrence: Conditional

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: 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

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