GET/file/{file_id}
Use the getFile method to fetch the details of a feed file available to download, as specified by the file's file_id.
Details in the response include: the feed's file_id, the date it became available, eBay categories that support the feed, its frequency, the time span it covers, its feed type, its format (currently only TSV is available), its size in bytes, the schema under which it was pulled, and the marketplaces it applies to.
Input
Resource URI
This method is not supported in Sandbox environment.
URI parameters
HTTP request headers
All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.
The table below shows additional HTTP request headers that are either required, conditionally required, or strongly recommended for this method. Other standard HTTP request headers- opens rest request components page (not in this table) can also be used, but they are optional.
| Header | Type | Description |
|---|---|---|
| X-EBAY-C-MARKETPLACE-ID | string | Indicates the unique identifier of the eBay marketplace on which the feed file exists. Example: X-EBAY-C-MARKETPLACE-ID: EBAY_US.See MarketplaceIdEnum for supported values. Occurrence: Required |
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 |
|---|---|---|
| access | AccessEnum | Indicates whether the application is permitted to access the feed file. One of Occurrence: Always |
| dimensions | array of Dimension | An array of dimensions supported by the corresponding feed file. Occurrence: Always |
| dimensions.dimensionKey | DimensionKeyEnum | The key element for a value in the dimensions array, paired with its value(s). Currently, only CATEGORY (available L1 category) is available. Occurrence: Always |
| dimensions.values | array of string | The dimension value(s) paired with the dimensionKey in the dimensions array. Currently, the only supported dimension is CATEGORY, so the values in this array will be L1 eBay categories.” Occurrence: Always |
| feedDate | string | The date on which the feed was created. Occurrence: Always |
| feedScope | FeedScopeEnum | Specifies the frequency with which the feed file is made available ( Occurrence: Always |
| feedTypeId | string | The unique identifier of the feed type. Occurrence: Always |
| fileId | string | The file's unique identifier. This fileid is used to select the feed file when using the downloadFile method. Occurrence: Always |
| format | FormatEnum | Format of the returned feed file. Currently only TSV is supported. Occurrence: Always |
| marketplaceId | MarketplaceIdEnum | The eBay marketplace identifier for the marketplace(s) to which the feed applies. Occurrence: Always |
| schemaVersion | string | Version of the API schema under which the feed was created. Occurrence: Always |
| size | integer | Size of the feed file in bytes. Occurrence: Always |
| span | TimeDuration | The time span between feed files that applies to the feed type (e.g., hourly, daily, weekly). Occurrence: Always |
| span.unit | TimeDurationUnitEnum | This enumeration value indicates the time unit used for the time period. Occurrence: Always |
| span.value | integer | The number of units of time in the span. 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 |
| 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. |
| 13014 | API_FEED | REQUEST | Invalid or missing header X-EBAY-C-MARKETPLACE-ID. |
| 14004 | API_FEED | REQUEST | The specified file Id does not exist for marketplace specified or may have expired. Please check the maximum allowed look back for the feed type and scope. |
| 14009 | API_FEED | REQUEST | Insufficient permissions for the feed type for the specified marketplace. 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: Retrieve a List of a File's Details
The getFile method returns a metadata details for a specified file.
Input
The desired file, test_feedapi_file.gzip, is specified in the URI. The file name is obtained using the getFiles method.
GEThttps://api.ebay.com/buy/feed/v1/file/test_feedapi_file.gzip
Output
The call returns details about the test_feedapi_file.gzip file. The metadata in the response indicates that the feed file is for Category 1 (‘Collectables’) on the eBay Australia marketplace for November 10, 2021.