GET/feed_type/{feed_type_id}
Use the getFeedType method to obtain the details about a particular feed type to determine its applicability to your needs.
With the response, you can compare the eBay marketplaces and categories with the eBay marketplaces and categories that your application is enabled to access. By making these comparisons, you can avoid attempting to download feed files that you do not have access to.
Note: For a list of supported sites and other restrictions, see API Restrictions.
Input
Resource URI
This method is not supported in Sandbox environment.
URI parameters
| Parameter | Type | Description |
|---|---|---|
| feed_type_id | string | This path parameter specifies the unique identifier for the feed type to be used as a search filter. Use the getFeedTypes method to identify available feed types. Note: Refer to Supported feed types to learn more about the feed types supported by the Feed API. Occurrence: Required |
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
All other standard RESTful request headers are optional. For more information on standard RESTful request headers, see the HTTP request headers- opens rest request components page table.
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.
Request payload
This call has no payload.
Request fields
This call has no field definitions.
Output
HTTP response headers
This call has no response headers.
Response payload
Response fields
| Output container/field | Type | Description |
|---|---|---|
| description | string | A description of the feed type. Occurrence: Always |
| feedTypeId | string | The unique identifier of the feed type. Occurrence: Always |
| supportedFeeds | array of SupportedFeed | An array of the feed files of the indicated feed type that are available to be downloaded. Occurrence: Always |
| supportedFeeds.authorizationScopes | array of string | Occurrence: Always |
| supportedFeeds.constraint | Constraint | This container shows the eBay marketplaces that support the corresponding feed type. If no constraints are returned, all marketplaces are supported. Occurrence: Conditional |
| supportedFeeds.constraint.marketplaceIds | array of MarketplaceIdEnum | A list of the marketplaces to which the application is constrained within the feed type. Occurrence: Conditional |
| supportedFeeds.feedScope | FeedScopeEnum | Specifies the frequency with which the feed file is made available ( Occurrence: Always |
| 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. Occurrence: Always |
| supportedFeeds.lookBack.unit | TimeDurationUnitEnum | This enumeration value indicates the time unit used for the time period. Occurrence: Always |
| supportedFeeds.lookBack.value | integer | The number of units of time in the span. Occurrence: Always |
| supportedFeeds.status | FeedStatusEnum | The status for this feed. One of Occurrence: Always |
| supportedFeeds.supportedSchemas | array of SupportedSchema | An array of the supported Feed API schemas for this feed type. Occurrence: Always |
| supportedFeeds.supportedSchemas.definition | string | A list of the fields that will be returned in the feed file. Occurrence: Always |
| supportedFeeds.supportedSchemas.deprecated | boolean | Indicates whether the schema is still functional or deprecated. One of either Occurrence: Always |
| 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. Occurrence: Always |
| supportedFeeds.supportedSchemas.schemaVersion | string | The version of the Feed API schema under which the feed type was created. 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.
| Status | Meaning |
|---|---|
| 200 | OK |
| 403 | Forbidden |
| 404 | Not Found |
| 500 | Internal Server Error |
Error codes
For more on errors, plus the codes of other common errors, see Handling errors.
| Code | Domain | Category | Meaning |
|---|---|---|---|
| 13006 | API_FEED | APPLICATION | There was a problem with an eBay internal system or process. Contact eBay developer support for assistance. |
| 14000 | API_FEED | REQUEST | Invalid feed type id. |
| 14011 | API_FEED | REQUEST | Insufficient permissions for the feed type. Please contact eBay Technical Support for further assistance. |
Warnings
This call has no 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
This call provides a list of the feeds of a particular feedtype that are available to download.
Input
The feed_type_id of the feed type CURATED_ITEM_FEED is appended to the end of the URI.
GEThttps://api.ebay.com/buy/feed/v1/feed_type/CURATED_ITEM_FEED
Output
The returned curated item feed supports a single daily 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.