feed APIv1_beta.15.0

Feed API Release Notes

Just getting started with the Feed API? See the following documents for details on using this API:

See the API Site Status for announcements regarding recently resolved or current system wide issues. Visit the Developer Support page for support options and information on filing bugs.

The API release history

The following table lists the Feed API releases:

Release Version

Release Date

Description of Release

v1_beta.15.0 2019-05-15

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

Field

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.