getFeedTypes: eBay Feed API | eBay Developers Program

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

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

feed_scope=string&

marketplace_ids=string&

limit=string&

continuation_token=string

This method is not supported in Sandbox environment.

URI parameters

Parameter	Type	Description
feed_scope	string	This query parameter specifies the frequency with which the feed file is made available (`HOURLY`, `DAILY`, `WEEKLY`). Note: Currently only `DAILY` and `HOURLY` are supported. Occurrence: Optional
marketplace_ids	string	Use this query parameter to limit marketplaces you want to see in the result set. 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 MarketplaceIdEnum for supported values. Occurrence: Optional
limit	string	Specifies the number of records to show in the current response. Default: 20 Minimum: 20 Maximum: 100 Occurrence: Optional
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. Occurrence: Optional

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

Copy complete valid JSON to clipboard

{ /* FeedTypeSearchResponse */

"feedTypes" : [

{ /* FeedType */

"description" : "string",

"feedTypeId" : "string",

"supportedFeeds" : [

{ /* SupportedFeed */

"authorizationScopes" : [

"string"

"constraint" :

{ /* Constraint */

"marketplaceIds" : [

"MarketplaceIdEnum : [EBAY_US,EBAY_CA,EBAY_GB...]"

]

"feedScope" : "FeedScopeEnum : [DAILY,HOURLY,WEEKLY]",

"lookBack" :

{ /* TimeDuration */

"unit" : "TimeDurationUnitEnum : [YEAR,MONTH,DAY...]",

"value" : "integer"

"status" : "FeedStatusEnum : [ACTIVE,PAUSED,DEPRECATED]",

"supportedSchemas" : [

{ /* SupportedSchema */

"definition" : "string",

"deprecated" : "boolean",

"formats" : [

"FormatEnum : [TSV]"

"schemaVersion" : "string"

}

]

}

]

}

"href" : "string",

"limit" : "integer",

"next" : "string",

"total" : "integer"

}

Response fields

Output container/field	Type	Description
feedTypes	array of FeedType	An array of the feed types that match the search criteria. Occurrence: Always
feedTypes.description	string	A description of the feed type. Occurrence: Always
feedTypes.feedTypeId	string	The unique identifier of the feed type. Note: Refer to Supported feed types for additional details. Occurrence: Always
feedTypes.supportedFeeds	array of SupportedFeed	An array of the feed files of the indicated feed type that are available to be downloaded. Occurrence: Always
feedTypes.supportedFeeds.authorizationScopes	array of string	The 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`. Note: You can view your application's oauth scopes on the Application Keys page. Occurrence: Always
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. Occurrence: Conditional
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 `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 restrictions for information about regional constraints. Occurrence: Conditional
feedTypes.supportedFeeds.feedScope	FeedScopeEnum	Specifies the frequency with which the feed file is made available (`HOURLY`, `DAILY`, `WEEKLY`). Currently only `DAILY` and `HOURLY` are supported. Occurrence: Always
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 `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.unit	TimeDurationUnitEnum	This enumeration value indicates the time unit used for the time period. Occurrence: Always
feedTypes.supportedFeeds.lookBack.value	integer	The number of units of time in the span. Occurrence: Always
feedTypes.supportedFeeds.status	FeedStatusEnum	The status for this feed. One of `ACTIVE`, `PAUSED`, or `DEPRECATED`. Occurrence: Always
feedTypes.supportedFeeds.supportedSchemas	array of SupportedSchema	An array of the supported Feed API schemas for this feed type. Occurrence: Always
feedTypes.supportedFeeds.supportedSchemas.definition	string	A list of the fields that will be returned in the feed file. Note: Refer to Supported feed types to learn about the feed fields that are included in each supported feed type. Occurrence: Always
feedTypes.supportedFeeds.supportedSchemas.deprecated	boolean	Indicates whether the schema is still functional or deprecated. One of either `true` or `false`. Occurrence: Always
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. Occurrence: Always
feedTypes.supportedFeeds.supportedSchemas.schemaVersion	string	The version of the Feed API schema under which the feed type was created. Example: 1.0. Occurrence: Always
href	string	The URL to to the current set of results. Occurrence: Always
limit	integer	The number of records to show in the current response. Occurrence: Always
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. Occurrence: Conditional
total	integer	The 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.

Status	Meaning
200	OK
400	Bad Request
500	Internal Server Error

Error codes

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

Code	Domain	Category	Meaning
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

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

GEThttps://api.ebay.com/buy/feed/v1/feed_type

Output

Three supported feed types are returned: CURATED_ITEM_FEED, PRODUCT_FEED, and PROMOTION. The response includes additional information about each feed type, such as the scope, status, and supported marketplaces for each type.

{
  "href": "https://api.ebay.com/buy/feed/v1/feed_type?limit=20",
  "total": 3,
  "limit": 20,
  "feedTypes": [
    {
      "feedTypeId": "CURATED_ITEM_FEED",
      "description": "eBay Partner Network Curated Item Feeds",
      "supportedFeeds": [
        {
          "feedScope": "DAILY",
          "authorizationScopes": [
            "https://api.ebay.com/oauth/api_scope/buy.item.feed"
          ],
          "status": "ACTIVE",
          "supportedSchemas": [
            {
              "formats": [
                "TSV"
              ],
              "schemaVersion": "1.0.0",
               "definition": "{ \"itemLocationCountry\": \"string\", \"buyingOptions\": \"string\", \"priceCurrency\": \"string\", \"priceValue\": \"string\", \"imageUrl\": \"string\", \"itemAffiliateWebUrl\": \"string\", \"categoryId\": \"string\", \"category\": \"string\", \"marketplaceId\": \"string\", \"itemId\": \"string\", \"itemCreationDate\": \"number\", \"itemEndDate\": \"number\", \"title\": \"string\", \"shippingCost\": \"string\", \"defaultImageUrl\": \"string\", \"availability\": \"string\", \"color\": \"string\", \"size\": \"string\", \"gender\": \"string\", \"brand\": \"string\", \"material\": \"string\", \"sellerTrustLevel\": \"string\", \"ageGroup\": \"string\", \"gtin\": \"string\", \"sellerUsername\": \"string\", \"description\": \"string\", \"originalPriceValue\": \"string\", \"energyEfficiencyClass\": \"string\", \"totalUnits\": \"string\", \"unitType\": \"string\", \"shipToIncludedRegions\": \"string\", \"commissionable\": \"string\", \"qualifiedPrograms\": \"string\", \"unitPricingMeasure\": \"string\", \"handlingTime\": \"string\", \"minEstimatedDeliveryDays\": \"string\", \"maxEstimatedDeliveryDays\": \"string\", \"returnsAccepted\": \"string\", \"returnPeriodValue\": \"string\", \"freeReturn\": \"string\", \"itemWebUrl\": \"string\", \"energyEfficiencyRange\": \"string\", \"priorityListingPayload\": \"string\", \"trkparms\": \"string\", \"priorityListing\": \"string\", \"condition\": \"string\", \"manufacturer\": \"string\", \"make\": \"string\", \"mileage\": \"string\", \"vehicleModel\": \"string\", \"manufacturerTitle\": \"string\", \"vehicleType\": \"string\", \"vin\": \"string\", \"vehicleYear\": \"string\" }",
              "deprecated": false
            }
          ],
          "constraint": {
            "marketplaceIds": [
              "EBAY_AU",
              "EBAY_FR",
              "EBAY_US",
              "EBAY_GB",
              "EBAY_DE",
              "EBAY_IT"
            ]
          },
          "lookBack": {
            "unit": "DAY",
            "value": 14
          }
        }
      ]
    },
    {
      "feedTypeId": "PRODUCT_FEED",
      "description": "eBay Partner Network Product Feed",
      "supportedFeeds": [
        {
          "feedScope": "DAILY",
          "authorizationScopes": [
            "https://api.ebay.com/oauth/api_scope/buy.item.feed"
          ],
          "status": "ACTIVE",
          "supportedSchemas": [
            {
              "formats": [
                "TSV"
              ],
              "schemaVersion": "1.0.1",
              "definition": "{ \"itemId\": \"string\",\"title\": \"string\",\"description\": \"string\",\"imageUrl\": \"string\",\"itemWebUrl\": \"string\",\"itemAffiliateWebUrl\": \"string\",\"availability\": \"string\",\"condition\": \"string\", \"priceValue\": \"string\", \"priceCurrency\": \"string\",\"gtin\": \"string\", \"mpn\": \"string\", \"brand\": \"string\",\"defaultImageUrl\": \"string\", \"ageGroup\": \"string\", \"color\": \"string\",\"gender\": \"string\",\"material\": \"string\" ,\"categoryId\": \"string\" ,\"category\": \"string\",\"epid\": \"string\" ,\"unitPricingMeasure\": \"string\" ,\"totalUnits\": \"string\" ,\"unitPrice\": \"string\",\"handlingTime\": \"string\",\"minEstimatedDeliveryDays\": \"string\",\"maxEstimatedDeliveryDays\": \"string\",\"returnsAccepted\": \"string\",\"returnPeriodValue\": \"string\",\"freeReturn\": \"string\",\"qualifiedPrograms\": \"string\",\"sellerTrustLevel\": \"string\",\"shippingCost\": \"string\"}",

"deprecated": false
            }
          ],
          "constraint": {
            "marketplaceIds": [
              "EBAY_US",
              "EBAY_DE",
              "EBAY_GB",
              "EBAY_AU",
              "EBAY_FR",
              "EBAY_IT"
            ]
          },
          "lookBack": {
            "unit": "DAY",
            "value": 14
          }
        }
      ]
    },
    {
      "feedTypeId": "PROMOTION",
      "description": "eBay Partner Network PROMOTION Feed",
      "supportedFeeds": [
        {
          "feedScope": "HOURLY",
          "authorizationScopes": [
            "https://api.ebay.com/oauth/api_scope/buy.item.feed"
          ],
          "status": "ACTIVE",
          "supportedSchemas": [
            {
              "formats": [
                "TSV"
              ],
              "schemaVersion": "1.1.0",
              "definition": "{\"promotionId\":\"string\",\"promotionStartDate\":\"string\",\"promotionEndDate\":\"string\",\"promotionType\":\"string\",\"promotionMessage\":\"string\",\"promotionTermsUrl\":\"string\",\"ruleTemplateName\":\"string\",\"couponCode\":\"string\",\"discountBenefit\":\"string\",\"amountOffItemValue\":\"string\",\"amountOffItemCurrency\":\"string\",\"amountOffOrderValue\":\"string\",\"amountOffOrderCurrency\":\"string\",\"percentageOffItemValue\":\"string\",\"percentageOffOrderValue\"string\",\"discountSpecification\":\"string\",\"minAmountValue\":\"string\",\"minAmountCurrency\":\"string\",\"forEachAmountValue\":\"string\",\"forEachAmountCurrency\":\"string\",\"minQuantity\":\"string\",\"forEachQuantity\":\"string\",\"numberOfDiscountedItems\":\"string\",\"maxDiscountAmountValue\":\"string\",\"maxDiscountAmountCurrency\":\"string\",\"maxRedemptionPerUser\":\"string\",\"itemIds\":\"string\"}",
              "deprecated": false
            }
          ],
          "constraint": {
            "marketplaceIds": [
              "EBAY_US",
              "EBAY_DE",
              "EBAY_GB",
              "EBAY_AU"
            ]
          },
          "lookBack": {
            "unit": "HOUR",
            "value": 24
          }
        }
      ]
    }
  ]
}