Skip to main content

feed API

Feed API Release Notes Archive

This archive document contains information about previous releases. For current releases, see Feed API Release Notes.

The API release history

Release Version

Release Date

Description of Release

v1_beta.20.0

2020-05-29

Added a new sellerAccountType column to the getItemFeed and getItemSnapshotFeed files

v1_beta.19.0

2020-05-01

Added a new alerts column to the getItemFeed and getItemSnapshotFeed files

v1_beta.18.0

2020-02-27

  • Added a new legacyItemId column to the getItemFeed and getItemSnapshotFeed files
  • Added new inferredEpid and itemCreationDate columns to the getItemSnapshotFeed file

v1_beta.17.0

2019-10-09

Added new unitPricingMeasure and unitPrice columns to the getItemFeed and getItemSnapshotFeed files

v1_beta.16.0

2019-09-10

Added the following new columns to the getItemFeed and getItemSnapshotFeed files:

  • shippingCostType
  • shippingCost
  • additionalShippingCostPerUnit
  • quantityUsedForEstimate
  • shippingCarrierCode
  • shippingServiceCode
  • shippingType
v1_beta.15.0 2019-07-08

2019-05-15
  • The feed files no longer include non-Good 'til Cancelled items and the documentation has been updated
  • Added columns for package size and weight to the Item Feed (daily and bootstrap)
v1_beta.14.0 2019-04-16

Added support for the AU, ES, FR, IT marketplaces

2019-03-27
  • Returns items in used condition
  • Returns items from Above Standard sellers
2019-03-04 Added an HTTP status code and changed error 13006
v1_beta.13.0 2019-02-12 Added a column for lot size to the getItemFeed and getItemSnapshotFeed files
v1_beta.12.0 2019-01-23
  • Added a column for qualified programs to the getItemFeed and getItemSnapshotFeed files
  • Added a new error message for unsupported categories
v1_beta.11.0 2018-12-18 Removed the item_description resource
v1_beta.10.0 2018-10-23 Added columns to the getItemSnapshotFeed files
v1_beta.9.0 2018-10-01 getItemSnapshotFeed: Change the data in the Title column to an escaped string when special characters are present
2018-08-01
  • Removed the restockingFeePercentage column from getItemFeed (backwards incompatible change)
  • Added Last-Modified response header to all feeds
  • New open source Feed SDK written in Java
v1_beta.8.0 2018-06-18
  • Added return and discount columns and support for the GB marketplace to getItemSnapshotFeed file
  • Added the energyEfficiencyClass column to getItemFeed file
v1_beta.7.0 2018-05-15
  • Added the getItemGroupFeed method
  • Added discount columns to the getItemFeed file
v1_beta.6.0 2018-03-19
  • Added support for the DE and GB eBay marketplaces
  • Added inferredLocalizedAspects and additionalImages columns
v1_beta.5.0 2018-03-01 Added columns for:
  • Shipping information: include/exclude countries and regions and delivery options
  • Inferred (derived) product identification

Important: These columns will first appear in the feed file for Feb. 27, 2018. All feed files after Feb. 27, will contain these columns. Be sure that your app can handle these new columns.

v1_beta.4.0 2018-02-14 Added getItemSnapshotFeed method
v1_beta.3.0 2018-01-29
  • Renamed the feed_type parameter (backwards incompatible change)
  • Added columns for payment processing and return information

 

v1_beta.20.0

The following column was added to the Item Feed and Item Snapshot Feed (daily and bootstrap) files.

Column Name

Type

Description

sellerAccountType string A string value specifying the seller account type.

v1_beta.19.0

The following column was added to the Item Feed and Item Snapshot Feed (daily and bootstrap) files.

Column Name

Type

Description

alerts string A pipe-separated list of alerts available for the item.

v1_beta.18.0

The following column was added to the Item Feed (daily and bootstrap) files.

Column Name

Type

Description

legacyItemId string The traditional/legacy version of the eBay listing's unique identifier.

The following columns were added to the Item Snapshot Feed (daily and bootstrap) files.

Column Name

Type

Description

inferredEpid string The ePID (eBay Product ID) of the product in the listing, which has been programmatically determined by eBay using the listing's title, aspects, and other data.
itemCreationDate string A timestamp indicating when the item was created. The format is UTC (yyyy-MM-ddThh:mm:ss.sssZ).
legacyItemId string The traditional/legacy version of the eBay listing's unique identifier.

v1_beta.17.0

The following columns were added to the Item Feed (daily and bootstrap) and snapshot files. These fields provide the price per unit information.

Column Name

Type

Description

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",
"unitPrice": {
  "value": "7.99",
  "currency": "GBP"
unitPrice string 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",
"unitPrice": {
  "value": "7.99",
  "currency": "GBP"

v1_beta.16.0

The following columns were added to the Item Feed (daily and bootstrap) and snapshot files. These return shipping information for the item.

Column Name

Type

Description

shippingCostType string Indicates the class of the shipping cost.

Valid Values: FIXED or CALCULATED
shippingCost string The final shipping cost for all the items after all discounts are applied.
additionalShippingCostPerUnit string 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).
quantityUsedForEstimate integer The number of items used when calculating the shipping estimation information.
shippingCarrierCode string The name of the shipping provider, such as FedEx, or USPS.
shippingServiceCode string The type of shipping service. For example, USPS First Class.
shippingType string The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.

v1_beta.15.0

The following columns were added to the Item Feed (daily and bootstrap) files. These return the weight and dimensions of the item's package.

Column Name

Type

Description

lengthUnitOfMeasure LengthUnitOfMeasureEnum The unit of measurement used for the package dimensions, such as INCH, FEET, CENTIMETER, or METER.

Code so that your app gracefully handles any future changes to this list.
packageWidth string The width of the shipping package that contains the item.
packageHeight string The height of the shipping package that contains the item.
packageLength string The length of the shipping package that contains the item.
weightUnitOfMeasure WeightUnitOfMeasureEnum The unit of measurement used for the package weight, such as POUND, KILOGRAM, OUNCE, or GRAM.

Code so that your app gracefully handles any future changes to this list.
packageWeight string The weight of the package that contains the item.

v1_beta.14.0

2019-03-16

The feed files are now available for the following marketplaces:

  • EBAY_AU - Australia (ebay.com.au)
  • EBAY_ES - Spain (ebay.es)
  • EBAY_FR - France (ebay.fr)
  • EBAY_IT - Italy (ebay.it)

2019-03-27

The following changes have been made.

Returns items in used condition

Now the feed files will contain items in New (ID 1000) or Used (ID 3000) condition. You can add your own filter to control the condition of the items you want.

Returns items from Above Standard sellers

The feed files now contain items from Top Rated sellers and Above Standard sellers. For more information about these seller levels, see the eBay help page Seller levels and performance standards.

2019-03-04

The following changes have been made.

Added 204 HTTP Status Code This code is returned when there are no items that meet the criteria for this feed file. See Feed File Filters for details.
Changed ID 13006 For error ID 13006 the category was changed from REQUEST to APPLICATION.

v1_beta.13.0

Added the lotSize column to the Item and Item Snapshot feed files. This column returns 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.

For example

Item

Lot Definition

Lot Size

A fashion jewelry ring

A package of 100 assorted rings

100

A P235/75-15 Goodyear tire

A set of 4 tires

4

A package of 24 AA batteries

A box of 10 packages

10

Note: Lots are not supported in all categories.

v1_beta.12.0

Added the qualifiedPrograms column to the Item and Item Snapshot feed files. This column is a pipe separated list of the qualified programs available for the item. The only qualified program returned is EBAY_PLUS.

Note: EBAY_PLUS is supported only on the EBAY_DE and EBAY_AU marketplaces. This means the qualifiedPrograms column will be populated only in feed files for these marketplaces. Currently, only EBAY_DE feed files are available. For a list of marketplaces supported by the Feed API, see Buy API Support by Marketplace.

The following error message has been added. The Feed API does not support all the eBay categories. For example, there are no feed files for the real estate category. This error appears when the category ID is valid for the marketplace, but the Feed API does not support that category.

Error ID

Error Message

13022

The 'category_id' {category_id} submitted is not supported.

v1_beta.11.0

Because the item_description resource was not being used by any Partners, it has been removed. This resource returned a feed file containing the item descriptions written by the seller. These descriptions were often very large and contained HTML code, links, images, etc. You can still get this description for any item using the getItem method of the Browse API.

v1_beta.10.0

The following columns were added to the getItemSnapshotFeed file. These new columns will be in the feed file after 10-23-18 5pm UTC-7.

New Columns

Description

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

To retrieve the manufacturer's specifications for this item, when they are available, use the getItem method in the Browse API. The information is returned in the productFicheWebUrl field.
additionalImageUrls A pipe separated (|) list of URLs for the additional images of the item. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values.
deliveryOptions A comma separated list of delivery options for the item, such as SHIP_TO_HOME and SELLER_ARRANGED_LOCAL_PICKUP. This column lets you filter out items that cannot be shipped to the buyer.
shipToIncludedRegions A pipe (|) separated alphabetical list of the geographic countries and regions where the seller will ship the item. If a region is specified, you will need to subtract any countries and regions returned in the shipToExcludedRegions column to fully understand where the seller will ship. The COUNTRY: list is separated from the REGION: list with a semicolon (;).

Format Example:
COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;

Country Values: The two-letter ISO 3166 standard code of the country.

Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE
shipToExcludedRegions A pipe (|) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. These countries and regions refine (restrict) the shipToIncludedRegions list. The COUNTRY: list is separated from the REGION: list with a semicolon (;).

Format Example:
COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;

Country Values: The two-letter ISO 3166 standard code of the country.

Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE
acceptedPaymentMethods Indicates the credit card service that will be used to process the transaction.
  • If this column contains PAYPAL, you can use the Buy Order API to checkout and purchase the item.
  • If this column is empty, you must use another method for checkout.

v1_beta.9.0

The following changes have been made to the Feed API.

2018-10-01

The following change has been made to the getItemSnapshotFeed files. All other feed files already have this encoding.

Starting with feed files generated on October 1, 2018, the Title will be an escaped string when special characters are present, using the following rules:

  • Double quotes (") and backslashes (\) in the Title are escaped with a backslash (\) character
  • If there are any tabs (\t), double quotes ("), or backslashes (\) in the Title, the entire Title will be wrapped in double quotes.

For example

Before:

Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\Tracking

Marvel Legends HULK 8" Figure Avengers Age of Ultron Studios 6" Series

After:

"Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\\Tracking"

"Marvel Legends HULK 8\" Figure Avengers Age of Ultron Studios 6\" Series"

 

2018-08-01

Removed restockingFeePercentage column

The restockingFeePercentage column was removed from the getItemFeed method because eBay has deprecated the restocking fee in listings.

Note: This is a backwards incompatible change.

Added a Last-Modified response header

The Last-Modified response header has been added to all the Feed API methods. This header returns the generation date of the feed file, which will be the latest file available.

For example:

Last-Modified Wed 21 Oct 2015 07:28:00 GMT

Also, the date field is needed only when feed_scope=NEWLY_LISTED. If you specify a date and feed_scope=ALL_ACTIVE, the date value is ignored and the latest file is returned. The date of that file is returned in the Last-Modified response header.

Provided an open source Feed SDK

In addition to the API, there is an open source Feed SDK written in Java that downloads and unzips the feed file and lets you specify field filters to curate the items in the file.

v1_beta.8.0

The following changes have been made to the Feed API.

Added return and discount columns to getItemSnapshotFeed

The snapshot feed files are now available for the GB eBay Great Britain (ebay.co.uk) marketplace.

The following columns were added to the getItemSnapshotFeed.

New Columns

Description

returnsAccepted Indicates whether the seller accepts returns for the item.
refundMethod An enumeration value that indicates how a buyer is refunded when an item is returned.

Code so that your app gracefully handles any future changes to this list.
returnMethod An enumeration value that indicates the alternative methods for a full refund when an item is returned. This column will have data if the seller offers the buyer an item replacement or exchange instead of a monetary refund.
returnShippingCostPayer The party responsible for the return shipping costs when an item is returned. This will be either buyer or seller.
returnPeriodValue The amount of time the buyer has to return the item after the purchase date. This can be the number of years, months, or days depending on returnPeriodUnit. For example, if this value is '30', and the returnPeriodUnit value is 'DAY', the return period is 30 days.
returnPeriodUnit An enumeration value that indicates the period of time being used to measure the duration, such as business days or months, or years.

See the TimeDurationUnitEnum type for a list of possible time-measuring units.
originalPriceValue The original selling price of the item. This lets you surface a strikethrough price for the item.
originalPriceCurrency The currency of the originalPriceValue of the item and the discountAmount.
discountAmount The calculated amount of the discount (originalPriceValue - priceValue). For example, if originalPriceValue is 70 and priceValue is 56, this value would be 14.

Note: The currency shown in originalPriceCurrency is used for both discountAmount and originalPriceCurrency.
discountPercentage The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20.

Added energyEfficiencyClass to getItemFeed

Added the energyEfficiencyClass column that 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.

v1_beta.7.0

Added getItemGroupFeed method

The getItemGroupFeed method was added to the Feed API. This lets you download an Item Group TSV_GZIP (tab separated value gzip) feed file containing the item group variation information for items in the Item feed file that were associated with an item group. This information includes a list of the aspect (variation) names for this item group. For example, if the item was a shirt some of the aspect names could be Size, Color, etc., which are returned in the variesByLocalizedAspects column. (An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.)

The first line of the file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section.

Added item discount information to getItemFeed

The following columns were added the Item feed file. This information gives you the ability to show the item that have been discounted.

New Columns

Description

originalPriceValue The original selling price of the item. This lets you surface a strikethrough price for the item.
originalPriceCurrency The currency of the originalPriceValue of the item and the discountAmount.
discountAmount The calculated amount of the discount (originalPriceValue - price). For example, if originalPriceValue is 70 and price is 56, this value would be 14.
Note: The currency shown in originalPriceCurrency is used for both discountAmount and originalPriceCurrency.
discountPercentage The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20.

v1_beta.6.0

The following changes have been made to the Feed API.

Added support for the DE and GB marketplaces

You can now download the feed files for items hosted on the Germany (ebay.de) and Great Britain (ebay.co.uk) eBay marketplaces. To do this, set the X-EBAY-C-MARKETPLACE-ID request header to either EBAY_DE or EBAY_GB.

Added two new columns

The following columns were added to the getItemFeed method.

New Columns

Description

inferredLocalizedAspects The inferredLocalizedAspects column was added to the getItemFeed method. The column contains item aspects have been programmatically determined by eBay. Just like the localizedAspects column, these aspects are a semicolon separated list of the name/value pairs for the aspects of the item, which are BASE64 encoded. If the seller provided aspects for the item, the seller's values are returned in the localizedAspects column.
additionalImages A pipe (|) separated list of URLs for the images of the item. These images are in addition to the primary image, which is returned in the imageUrl column.

 

v1_beta.5.0

The following columns, which provide shipping, delivery, and inferred product information of the item, were added to the getItemFeed method.

New Columns

Description

deliveryOptions A comma separated list of delivery options for the item, such as SHIP_TO_HOME and SELLER_ARRANGED_LOCAL_PICKUP. This column lets you filter out items that cannot be shipped to the buyer.
shipToIncludedRegions A pipe (|) separated alphabetical list of the geographic countries and regions where the seller will ship the item. If a region is specified, you will need to subtract any countries and regions returned in the shipToExcludedRegions column to fully understand where the seller will ship. The COUNTRY: list is separated from the REGION: list with a semicolon (;).

Format Example:

COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;


Country Values: The two-letter ISO 3166 standard code of the country.

Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE
shipToExcludedRegions A pipe (|) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. These countries and regions refine (restrict) the shipToIncludedRegions list. The COUNTRY: list is separated from the REGION: list with a semicolon (;).

Format Example:

COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;


Country Values: The two-letter ISO 3166 standard code of the country.

Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE
inferredEpid The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay.

If the seller provided an ePID for the item, the seller's value is returned in the epid column.
inferredGtin The GTIN (Global Trade Item Number) of the item as defined by http://www.gtin.info, which as been programmatically determined by eBay. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.

If the seller provided a GTIN for the item, the seller's value is returned in the gtin column.
inferredBrand The name brand for the item, such as Nike or Apple, which has been programmatically determined by eBay. To identify the product, this is always used along with MPN.

If the seller provided a brand for the item, the seller's value is returned in the brand column.
inferredMpn The MPN for the item, which has been programmatically determined by eBay. MPN is 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.

If the seller provided a MPN for the item, the seller's value is returned in the mpn column.

v1_beta.4.0

You can now get an hourly snapshot feed file using the getItemSnapshotFeed method. This file contains all the items that have changed within the hour/day/category specified. You can use this file to update the information of your curated stored items.

v1_beta.3.0

The following changes have been made to the Feed API.

Renamed a query parameter

The feed_type query parameter was renamed to feed_scope. The feed_type parameter will stop being supported on March 31, 2018. Please update your application to use feed_scope before this date.

Added New Columns

The following columns were added to the Item feed file. These columns were add to the end of the existing columns in the order shown below.

New Columns

Description

acceptedPaymentMethods Indicates whether you can checkout using the Buy Order API. If this column contains PAYPAL, you can use the Buy Order API to checkout and purchase the item. If this column is empty, you must use another method for checkout.
returnsAccepted Indicates whether the seller accepts returns for the item.
refundMethod An enumeration value that indicates how a buyer is refunded when an item is returned.
returnMethod An enumeration value that indicates the alternative methods for a full refund when an item is returned. This column had data if the seller offers the buyer an item replacement or exchange instead of a monetary refund.
returnShippingCostPayer The party responsible for the return shipping costs when an item is returned. This will be either buyer or seller.
returnPeriodValue The amount of time the buyer has to return the item after the purchase date. This can be shown in the number of years, months, days, hours, or minutes. If this value is '30', and the returnPeriodUnit value is 'DAY', the return period is 30 days.
returnPeriodUnit An enumeration value that indicates period of time being used to measure the duration, such as business days, months, or years. See the TimeDurationUnitEnum type for a list of possible time-measuring units.
restockingFeePercentage

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 received $80 due to the restocking fee.

Values returned are: NoRestockingFee, Percent_10, Percent_15, and Percent_20