Use the getFeedTypes method to obtain the details about one or more feed types that are available to be downloaded. If no query parameters are used, all possible feed types are returned.You can filter your search by adding feed_scope and/or marketplace_ids parameters to the URI.
For instance, a call using
GET https://api.ebay.com/buy/feed/v1/feed_type will return all available feed files. A call using
GET https://api.ebay.com/buy/feed/v1/feed_type?feed_scope=DAILY&marketplace_ids=EBAY_US will limit the returned list to daily feed files available from the US marketplace.
For a list of supported sites and other restrictions, see API Restrictions.
Resource URI (production)
|feed_scope||string||Specifies the frequency with which the feed file is made available (|
|marketplace_ids||string||Use this parameter to limit marketplaces you want to see. To search for multiple marketplaces at once, list them in the URI separated by commas.|
See API Restrictions for information on supported sites.
|limit||string||The number of records to show in the current response.|
|continuation_token||string||The server returns this token to the web client when the responses received require multiple pages to display. The web client sends this token back to the server to get the next page of results. |
HTTP request headers
This request requires an access token created with the client credentials grant flow, using one or more scopes from the following list (please check your Application Keys page for a list of OAuth scopes available to your application):
See OAuth access tokens for more information.
|feedTypes||array of FeedType||An array of the feed types that match the search criteria. |
|feedTypes.description||string||A description of the feed type. |
|feedTypes.feedTypeId||string||Unique identifier of the feed type. Currently only |
|feedTypes.supportedFeeds||array of SupportedFeed||An array of the feed files of the indicated feed type that are available to be downloaded. |
|feedTypes.supportedFeeds.||array of string|
|feedTypes.supportedFeeds.constraint||Constraint||This container shows the eBay marketplaces that support the corresponding feed type. If no constraints are returned, all marketplaces are supported. |
|feedTypes.supportedFeeds.constraint.marketplaceIds||array of MarketplaceIdEnum||A list of the marketplaces to which the application is constrained within the feed type.|
Example: A value of
Note: The Buy Feed API is not supported by all eBay marketplaces. See API restrictionsfor information regional constraints.
|feedTypes.supportedFeeds.feedScope||FeedScopeEnum||Specifies the frequency with which the feed file is made available (|
|feedTypes.supportedFeeds.lookBack||TimeDuration||How far back from the current time to limit the returned feed files. The returned feed files will be those generated between the current time and the look-back time.|
Example: A value of
|feedTypes.supportedFeeds.lookBack.unit||TimeDurationUnitEnum||This enumeration value indicates the time unit used for the time period. |
|feedTypes.supportedFeeds.lookBack.value||integer||The number of units of time in the span. |
|feedTypes.supportedFeeds.status||FeedStatusEnum||The status for this feed. One of |
|feedTypes.supportedFeeds.supportedSchemas||array of SupportedSchema||An array of the supported Feed API schemas for this feed type. |
|feedTypes.supportedFeeds.supportedSchemas.definition||string||A list of the fields that will be returned in the feed file. For a detailed description of possible fields that may be included in a feed file, see Feed File Fields. |
|feedTypes.supportedFeeds.supportedSchemas.deprecated||boolean||Indicates whether the schema is still functional or deprecated. One of either |
|feedTypes.supportedFeeds.supportedSchemas.formats||array of FormatEnum||An list of the available formats in which the schema can be downloaded. Currently only TSV (Tab Separated Values) is supported. |
|feedTypes.supportedFeeds.supportedSchemas.schemaVersion||string||The version of the Feed API schema under which the feed type was created.|
|href||string||The URL to to the current set of results. |
|limit||integer||The number of records to show in the current response. |
|next||string||You can use this URL to retrieve the next page of results beyond those displayed on the page if there are more results that match the search criteria. |
|total||integer||The total number of matches for the search criteria. |
For more on errors, plus the codes of other common errors, see Handling errors.
|13003||API_FEED||REQUEST||Invalid feed_scope. Valid values: [HOURLY,DAILY,WEEKLY]|
|13006||API_FEED||APPLICATION||There was a problem with an eBay internal system or process. Contact eBay developer support for assistance.|
|14001||API_FEED||REQUEST||Invalid limit. Supported ranges 20 - 100.|
|14002||API_FEED||REQUEST||Invalid or expired continuation token.|
|14010||API_FEED||REQUEST||Invalid 'marketplace_ids' filter. Please refer to documentation for supported values. Max supported:10|
New to making API calls? Please see Making a Call.
Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.
Sample 1: Retrieving feedType details for all available feed types.
CURATED_ITEM_FEED. The feed is limited to the Australian (
EBAY_AU) and French (
EBAY_FR) marketplaces (but all L1 categories within those markets are supported). The maximum time period that one can search back for this feed type (
lookBack) is 10 days.
Note: The definition sample here is deliberately shortened for space. An typical definition would include many more fields than are listed here.