feed APIv1.0.0

getFeedTypes

GET
/feed_type

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.

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

Input

Resource URI (production)

GET https://api.ebay.com/buy/feed/v1/feed_type?

URI parameters

ParameterTypeDescription
feed_scopestringSpecifies the frequency with which the feed file is made available (HOURLY, DAILY, WEEKLY).

Currently only DAILY is supported.

Occurrence: Optional

marketplace_idsstringUse this parameter to limit marketplaces you want to see. To search for multiple marketplaces at once, list them in the URI separated by commas.

Example: GET https://api.ebay.com/buy/feed/v1/feedtype?marketplaceids=EBAY_FR,EBAY_AU.

See API Restrictions for information on supported sites.

Occurrence: Optional

limitstringThe number of records to show in the current response.

Default: 20
Minimum: 20
Maximum: 100

Occurrence: Optional

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

Occurrence: Optional

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

OAuth scope

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

https://api.ebay.com/oauth/api_scope/buy.item.feed

See OAuth access tokens for more information.

Output

HTTP response headers

Output container/fieldTypeDescription
feedTypesarray of FeedTypeAn array of the feed types that match the search criteria.

Occurrence: Always

feedTypes.descriptionstringA description of the feed type.

Occurrence: Always

feedTypes.feedTypeIdstringUnique identifier of the feed type. Currently only CURATED_ITEM_FEED is available.

Occurrence: Always

feedTypes.supportedFeedsarray of SupportedFeedAn array of the feed files of the indicated feed type that are available to be downloaded.

Occurrence: Always

feedTypes.supportedFeeds.authorizationScopesarray of stringThe oauth authorization scopes which grant access to the feed files.

Currently the only applicable authorization scope is https://api.ebay.com/oauth/api_scope/buy.item.feed.

Tip: You can view your application's oauth scopes on the Application Keys page.

Occurrence: Always

feedTypes.supportedFeeds.constraintConstraintThis container shows the eBay marketplaces that support the corresponding feed type. If no constraints are returned, all marketplaces are supported.

Occurrence: Conditional

feedTypes.supportedFeeds.constraint.marketplaceIdsarray of MarketplaceIdEnumA list of the marketplaces to which the application is constrained within the feed type.

Example: A value of EBAY_US means the application is constrained to the U.S. marketplace for the listed feed.

Note: The Buy Feed API is not supported by all eBay marketplaces. See API restrictionsfor information regional constraints.

Occurrence: Conditional

feedTypes.supportedFeeds.feedScopeFeedScopeEnumSpecifies the frequency with which the feed file is made available (HOURLY, DAILY, WEEKLY).

Currently only DAILY is supported.

Occurrence: Always

feedTypes.supportedFeeds.lookBackTimeDurationHow 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 120 will limit the returned feed files to those generated in the past 2 hours (120 minutes). If 3 feed files have been generated in the past 2 hours, those 3 files will be returned. A feed file generated 4 hours earlier will not be returned.

Occurrence: Always

feedTypes.supportedFeeds.lookBack.unitTimeDurationUnitEnumThis enumeration value indicates the time unit used for the time period.

Occurrence: Always

feedTypes.supportedFeeds.lookBack.valueintegerThe number of units of time in the span.

Occurrence: Always

feedTypes.supportedFeeds.statusFeedStatusEnumThe status for this feed. One of ACTIVE, PAUSED, or DEPRECATED.

Occurrence: Always

feedTypes.supportedFeeds.supportedSchemasarray of SupportedSchemaAn array of the supported Feed API schemas for this feed type.

Occurrence: Always

feedTypes.supportedFeeds.supportedSchemas.definitionstringA 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.

Occurrence: Always

feedTypes.supportedFeeds.supportedSchemas.deprecatedbooleanIndicates whether the schema is still functional or deprecated. One of either true or false.

Occurrence: Always

feedTypes.supportedFeeds.supportedSchemas.formatsarray of FormatEnumAn list of the available formats in which the schema can be downloaded. Currently only TSV (Tab Separated Values) is supported.

Occurrence: Always

feedTypes.supportedFeeds.supportedSchemas.schemaVersionstringThe version of the Feed API schema under which the feed type was created.

Example: 1.0.

Occurrence: Always

hrefstringThe URL to to the current set of results.

Occurrence: Always

limitintegerThe number of records to show in the current response.

Occurrence: Always

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

Occurrence: Conditional

totalintegerThe total number of matches for the search criteria.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200OK
400Bad Request
500Internal Server Error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
13003API_FEEDREQUESTInvalid feed_scope. Valid values: [HOURLY,DAILY,WEEKLY]
13006API_FEEDAPPLICATIONThere was a problem with an eBay internal system or process. Contact eBay developer support for assistance.
14001API_FEEDREQUESTInvalid limit. Supported ranges 20 - 100.
14002API_FEEDREQUESTInvalid or expired continuation token.
14010API_FEEDREQUESTInvalid 'marketplace_ids' filter. Please refer to documentation for supported values. Max supported:10

Warnings

Samples

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.

This call provides a detailed list of the feeds of all feed types that are available for the application to download.

Input

No query parameters are used for this sample, so that all supported feed types will be listed in the returned payload.
GET
https://api.ebay.com/buy/feed/v1/feed_type

Output

Only one feed type is returned: 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.