openapi-directory

Version:

Building & bundling https://github.com/APIs-guru/openapi-directory for easy use from JS

github.com/httptoolkit/openapi-directory-js

1 lines • 76.7 kB

JSON

{"openapi":"3.0.0","info":{"contact":{"name":"eBay Inc,","x-twitter":"ebay"},"description":"The Feed API provides the ability to download TSV_GZIP feed files containing eBay items and an hourly snapshot file of the items that have changed within an hour for a specific category, date and marketplace. In addition to the API, there is an open source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file.","license":{"name":"eBay API License Agreement","url":"https://go.developer.ebay.com/api-license-agreement"},"title":"Item Feed Service","version":"v1_beta.12.0","x-apisguru-categories":["ecommerce"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://twitter.com/ebay/profile_image?size=original"},"x-origin":[{"format":"swagger","url":"https://developer.ebay.com/api-docs/master/buy/feed/openapi/2/buy_feed_v1_beta_oas2.json","version":"2.0"}],"x-providerName":"ebay.com","x-serviceName":"buy-feed"},"paths":{"/item":{"get":{"description":"This method lets you download a TSV_GZIP (tab separated value gzip) Item feed file. The feed file contains all the items from all the child categories of the specified category. The first line of the file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section. There are two types of item feed files generated: A daily Item feed file containing all the newly listed items for a specific category, date, and marketplace (feed_scope = NEWLY_LISTED) A weekly Item Bootstrap feed file containing all the items in a specific category and marketplace (feed_scope = ALL_ACTIVE) Note: Filters are applied to the feed files. For details, see Feed File Filters. When curating the items returned, be sure to code as if these filters are not applied as they can be changed or removed in the future. URLs for this method Production URL: https://api.ebay.com/buy/feed/v1_beta/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ Downloading feed files Item feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The Content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file. In addition to the API, there is an open source Feed SDK written in Java that downloads, combines files into a single file when needed, and unzips the entire feed file. It also lets you specify field filters to curate the items in the file. Note: The response is always a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions.","operationId":"getItemFeed","parameters":[{"description":"The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}},{"description":"This header specifies the range in bytes of the chunks of the gzip file being returned. Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.   Range bytes=0-10485760 For more information about using this headers, see Retrieving a gzip feed file. Maximum: 100 MB","in":"header","name":"Range","required":true,"schema":{"type":"string"}},{"description":"Specifies the type of feed file to return. Valid Values: NEWLY_LISTED - Returns the daily Item feed file containing all items that were listed on the day specified by the date parameter in the category specified by the category_id parameter. The items are Good 'Til Cancelled and non-Good 'Til Cancelled items. If the item is a non-Good 'Til Cancelled item, the item's end date will be returned in the itemEndDate column. /item?feed_scope=NEWLY_LISTED&category_id=15032&date=20170925 ALL_ACTIVE - Returns the weekly Item Bootstrap feed file containing all the 'Good 'Til Cancelled' items in the category specified by the category_id parameter. /item?feed_scope=ALL_ACTIVE&category_id=15032","in":"query","name":"feed_scope","required":true,"schema":{"type":"string"}},{"description":"An eBay top-level category ID of the items to be returned in the feed file. The list of eBay category IDs changes over time and category IDs are not the same across all the eBay marketplaces. To get a list of the top-level categories for a marketplaces, you can use the Taxonomy API getCategoryTree method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example:   "categoryTreeNodeLevel": 1 For details see Get Categories for Buy APIs. Restriction: Must be a top-level (L1) category","in":"query","name":"category_id","required":true,"schema":{"type":"string"}},{"description":"The date of the daily Item feed file (feed_scope=NEWLY_LISTED) you want. The date is required only for the daily Item feed file. If you specify a date for the Item Bootstrap file (feed_scope=ALL_ACTIVE), the date is ignored and the latest file is returned. The date the Item Bootstrap feed file was generated is returned in the Last-Modified response header. The Item feed files are generated every day and there are always 14 files available. The daily Item feed files are available each day after 9AM MST (US Mountain Standard Time), which is -7 hours UTC time. There is a 48 hour latency when generating the Item feed files. This means you can download the file for July 10th on July 12 after 9AM MST. Note: For categories with a large number of items, the latency can be up to 72 hours. Format: yyyyMMdd Requirements: Required when feed_scope=NEWLY_LISTED Must be within 3-14 days in the past","in":"query","name":"date","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Partial Content","headers":{"Content-range":{"description":"The content-range response header indicates where in the full resource this partial chunk of data belongs. It returns the lower and upper values in bytes (specified by the Range header) of the chunk and the total size of the file being downloaded in bytes. Maximum range: 100 MB The following is an example of a content-range response, where 0-10 is the lower and upper limit in bytes and 1000 is the total size of the file in bytes.   0-10/1000 The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    */1000 For more information and examples, see Retrieving a gzip feed file.","schema":{"type":"string"}},"Last-Modified":{"description":"Returns the generated date of the feed file, which will be the latest file available. For example: Last-Modified  Wed, 21 Oct 2015 07:28:00 GMT","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"206":{"description":"Partial Content","headers":{"Content-range":{"description":"The content-range response header indicates where in the full resource this partial chunk of data belongs. It returns the lower and upper values in bytes (specified by the Range header) of the chunk and the total size of the file being downloaded in bytes. Maximum range: 100 MB The following is an example of a content-range response, where 0-10 is the lower and upper limit in bytes and 1000 is the total size of the file in bytes.   0-10/1000 The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    */1000 For more information and examples, see Retrieving a gzip feed file.","schema":{"type":"string"}},"Last-Modified":{"description":"Returns the generated date of the feed file, which will be the latest file available. For example: Last-Modified  Wed, 21 Oct 2015 07:28:00 GMT","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"13000":{"category":"REQUEST","description":"The request contains data that is invalid. Correct the request and submit the call again. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13003":{"category":"REQUEST","description":"The 'feed_scope' {feed_scope} submitted is invalid. Valid values: {feedScopes}","domain":"API_FEED"},"13004":{"category":"REQUEST","description":"The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs.","domain":"API_FEED"},"13005":{"category":"REQUEST","description":"The 'date' {date} submitted is invalid. The date can be 3 to 9 days in the past. The format is yyyyMMdd.","domain":"API_FEED"},"13006":{"category":"REQUEST","description":"There was a problem with an eBay internal system or process. Wait a few minutes and retry the call. If that doesn't work, contact eBay Support.","domain":"API_FEED"},"13007":{"category":"REQUEST","description":"The feed file requested cannot be found. It is possible the file requested is in the process of being generated. Either change the date or try the call again later.","domain":"API_FEED"},"13009":{"category":"REQUEST","description":"The mandatory 'feed_scope' query parameter is missing. Valid values: {feedScopes}","domain":"API_FEED"},"13010":{"category":"REQUEST","description":"The mandatory 'category_id' query parameter is missing.","domain":"API_FEED"},"13011":{"category":"REQUEST","description":"The mandatory 'date' query parameter is missing. Valid values: {earliestDate} to {latestDate} days in the past. The format is yyyyMMdd.","domain":"API_FEED"},"13012":{"category":"REQUEST","description":"The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}","domain":"API_FEED"},"13013":{"category":"REQUEST","description":"The mandatory 'X-EBAY-C-MARKETPLACE-ID' header is missing. Valid values: {allowedMarketplaces}","domain":"API_FEED"},"13014":{"category":"REQUEST","description":"The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}","domain":"API_FEED"},"13015":{"category":"REQUEST","description":"The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13016":{"category":"REQUEST","description":"The 'Range' request header format is invalid. Format: 'bytes=start position-end position'. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13017":{"category":"REQUEST","description":"The 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13018":{"category":"REQUEST","description":"The start position in the range header is invalid.","domain":"API_FEED"},"13019":{"category":"REQUEST","description":"The end position in the range header is invalid.","domain":"API_FEED"},"13022":{"category":"REQUEST","description":"The 'category_id' {category_id} submitted is not supported.","domain":"API_FEED"}}}},"404":{"description":"Not found"},"416":{"description":"Range not satisfiable"},"500":{"description":"Internal server error"}},"security":[{"Client_Credentials":["https://api.ebay.com/oauth/api_scope/buy.item.feed"]}],"tags":["item"]}},"/item_group":{"get":{"description":"This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. There are two types of item group feed files generated: A daily Item Group feed file containing the item group variation information associated with items returned in the Item feed file for a specific day, category, and marketplace. (feed_scope = NEWLY_LISTED) A weekly Item Group Bootstrap feed file containing all the item group variation information associated with items returned in the Item Bootstrap feed file for all the items in a specific category. (feed_scope = ALL_ACTIVE) Note: Filters are applied to the feed files. For details, see Feed File Filters. When curating the items returned, be sure to code as if these filters are not applied as they can be changed or removed in the future. The contents of these feed files are based on the contents of the corresponding daily Item or Item Bootstrap feed file. When a new Item or Item Bootstrap feed file is generated, the service reads the file and if an item in the file has a primaryItemGroupId value, which indicates the item is part of an item group, it uses that value to return the item group (parent item) information for that item in the corresponding Item Group or Item Group Bootstrap feed file. This information includes the name/value pair of the aspects of the items in this group returned in the variesByLocalizedAspects column. For example, if the item was a shirt some of the variation names could be Size, Color, etc. Also the images for the various aspects are returned in the additionalImageUrls column. The first line in any feed file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section. Combining the Item Group and Item feed files The Item Group or Item Group Bootstrap feed file contains details about the item group (parent item), including the item group ID itemGroupId. You match the value of itemGroupId from the Item Group feed file with the value of primaryItemGroupId from the corresponding daily Item or Item Bootstrap feed file. URLs for this method Production URL: https://api.ebay.com/buy/feed/v1_beta/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ Downloading feed files Item Group feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file. Note: The response is always only a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions.","operationId":"getItemGroupFeed","parameters":[{"description":"The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}},{"description":"This header specifies the range in bytes of the chunks of the gzip file being returned. Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.   Range bytes=0-10485760 For more information about using this headers, see Retrieving a gzip feed file. Maximum: 100 MB","in":"header","name":"Range","required":false,"schema":{"type":"string"}},{"description":"Specifies the type of file to return. Valid Values: NEWLY_LISTED - Returns the Item Group feed file containing the item group variation information for items in the daily Item feed file that were associated with an item group. The items in this type of Item feed file are items that were listed on the day specified by the date parameter in the category specified by the category_id parameter. The items will be Good 'Til Cancelled and non-Good 'Til Cancelled items. If the item is a non-Good 'Til Cancelled item, the item's end date will be returned in the itemEndDate column. /item_group?feed_scope=NEWLY_LISTED&category_id=15032&date=20170925 ALL_ACTIVE - Returns the weekly Item Group Bootstrap file containing the item group variation information for items in the weekly Item Bootstrap feed file that were associated with an item group. The items are 'Good 'Til Cancelled' items in the category specified by the category_id parameter. /item_group?feed_scope=ALL_ACTIVE&category_id=15032","in":"query","name":"feed_scope","required":true,"schema":{"type":"string"}},{"description":"An eBay top-level category ID of the items to be returned in the feed file. The list of eBay category IDs changes over time and category IDs are not the same across all the eBay marketplaces. To get a list of the top-level categories for a marketplaces, you can use the Taxonomy API getCategoryTree method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example:   "categoryTreeNodeLevel": 1 For details see Get Categories for Buy APIs. Restriction: Must be a top-level category","in":"query","name":"category_id","required":true,"schema":{"type":"string"}},{"description":"The date of the daily Item Group feed file (feed_scope=NEWLY_LISTED) you want. The date is required only for the daily Item Group feed file. If you specify a date for the Item Group Bootstrap file (feed_scope=ALL_ACTIVE), the date is ignored and the latest file is returned. The date the Item Group Bootstrap feed file was generated is returned in the Last-Modified response header. The Item Group feed files are generated every day and there are always 14 files available. There is a 48 hour latency when generating the files. This means on July 10, the latest feed file you can download is July 8. Note: The generated files are stored using MST (US Mountain Standard Time), which is -7 hours UTC time. Format: yyyyMMdd Requirement: Requirements: Required only when feed_scope=NEWLY_LISTED Must be within 3-14 days in the past","in":"query","name":"date","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"Partial Content","headers":{"Content-range":{"description":"The content-range response header indicates where in the full resource this partial chunk of data belongs. It returns the lower and upper values in bytes (specified by the Range header) of the chunk and the total size of the file being downloaded in bytes. Maximum range: 100 MB The following is an example of a content-range response, where 0-10 is the lower and upper limit in bytes and 1000 is the total size of the file in bytes.   0-10/1000 The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    */1000 For more information and examples, see Retrieving a gzip feed file.","schema":{"type":"string"}},"Last-Modified":{"description":"Returns the generated date of the feed file, which will be the latest file available. For example: Last-Modified  Wed, 21 Oct 2015 07:28:00 GMT","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemGroupResponse"}}}},"206":{"description":"Partial Content","headers":{"Content-range":{"description":"The content-range response header indicates where in the full resource this partial chunk of data belongs. It returns the lower and upper values in bytes (specified by the Range header) of the chunk and the total size of the file being downloaded in bytes. Maximum range: 100 MB The following is an example of a content-range response, where 0-10 is the lower and upper limit in bytes and 1000 is the total size of the file in bytes.   0-10/1000 The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    */1000 For more information and examples, see Retrieving a gzip feed file.","schema":{"type":"string"}},"Last-Modified":{"description":"Returns the generated date of the feed file, which will be the latest file available. For example: Last-Modified  Wed, 21 Oct 2015 07:28:00 GMT","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemGroupResponse"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"13000":{"category":"REQUEST","description":"The request contains data that is invalid. Correct the request and submit the call again. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13003":{"category":"REQUEST","description":"The 'feed_scope' {feed_scope} submitted is invalid. Valid values: {feedScopes}","domain":"API_FEED"},"13004":{"category":"REQUEST","description":"The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs.","domain":"API_FEED"},"13005":{"category":"REQUEST","description":"The 'date' {date} submitted is invalid. The date can be 3 to 9 days in the past. The format is yyyyMMdd.","domain":"API_FEED"},"13006":{"category":"REQUEST","description":"There was a problem with an eBay internal system or process. Wait a few minutes and retry the call. If that doesn't work, contact eBay Support.","domain":"API_FEED"},"13007":{"category":"REQUEST","description":"The feed file requested cannot be found. It is possible the file requested is in the process of being generated. Either change the date or try the call again later.","domain":"API_FEED"},"13009":{"category":"REQUEST","description":"The mandatory 'feed_scope' query parameter is missing. Valid values: {feedScopes}","domain":"API_FEED"},"13010":{"category":"REQUEST","description":"The mandatory 'category_id' query parameter is missing.","domain":"API_FEED"},"13011":{"category":"REQUEST","description":"The mandatory 'date' query parameter is missing. Valid values: {earliestDate} to {latestDate} days in the past. The format is yyyyMMdd.","domain":"API_FEED"},"13012":{"category":"REQUEST","description":"The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}","domain":"API_FEED"},"13013":{"category":"REQUEST","description":"The mandatory 'X-EBAY-C-MARKETPLACE-ID' header is missing. Valid values: {allowedMarketplaces}","domain":"API_FEED"},"13014":{"category":"REQUEST","description":"The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}","domain":"API_FEED"},"13015":{"category":"REQUEST","description":"The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13016":{"category":"REQUEST","description":"The 'Range' request header format is invalid. Format: 'bytes=start position-end position'. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13017":{"category":"REQUEST","description":"The 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13018":{"category":"REQUEST","description":"The start position in the range header is invalid.","domain":"API_FEED"},"13019":{"category":"REQUEST","description":"The end position in the range header is invalid.","domain":"API_FEED"},"13022":{"category":"REQUEST","description":"The 'category_id' {category_id} submitted is not supported.","domain":"API_FEED"}}}},"404":{"description":"Not found"},"416":{"description":"Range not satisfiable"},"500":{"description":"Internal server error"}},"security":[{"Client_Credentials":["https://api.ebay.com/oauth/api_scope/buy.item.feed"]}],"tags":["item_group"]}},"/item_snapshot":{"get":{"description":"The Hourly Snapshot feed file is generated each hour every day for all categories. This method lets you download an Hourly Snapshot TSV_GZIP (tab separated value gzip) feed file containing the details of all the items that have changed within the specified day and hour for a specific category. This means to generate the 8AM file of items that have changed from 8AM and 8:59AM, the service starts at 9AM. You can retrieve the 8AM snapshot file at 10AM. Note: Filters are applied to the feed files. For details, see Feed File Filters. When curating the items returned, be sure to code as if these filters are not applied as they can be changed or removed in the future. You can use the response from this method to update the item details of items stored in your database. By comparing the value of itemSnapshotDate for the same item you will be able to tell which information is the latest. Important: When the value of the availability column is UNAVAILABLE, only the itemId and availability columns are populated. URLs for this method Production URL: https://api.ebay.com/buy/feed/v1_beta/ Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/ Downloading feed files Hourly snapshot feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The Content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file. Note: The response is always a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file. Restrictions For a list of supported sites and other restrictions, see API Restrictions.","operationId":"getItemSnapshotFeed","parameters":[{"description":"The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example:   X-EBAY-C-MARKETPLACE-ID = EBAY_US For a list of supported sites see, API Restrictions.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}},{"description":"This header specifies the range in bytes of the chunks of the gzip file being returned. Format: bytes=startpos-endpos For example, the following retrieves the first 10 MBs of the feed file.   Range bytes=0-10485760 For more information about using this headers, see Retrieving a gzip feed file. Maximum: 100 MB","in":"header","name":"Range","required":true,"schema":{"type":"string"}},{"description":"An eBay top-level category ID of the items to be returned in the feed file. The list of eBay category IDs changes over time and category IDs are not the same across all the eBay marketplaces. To get a list of the top-level categories for a marketplace, you can use the Taxonomy API getCategoryTree method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example:   "categoryTreeNodeLevel": 1 For details see Get Categories for Buy APIs. Restriction: Must be a top-level category","in":"query","name":"category_id","required":true,"schema":{"type":"string"}},{"description":"The hour of the incremental feed file you want, for a particular day. There are always 14 days of Hourly Snapshot feed files available. If you specify that you want the 9AM file for July 15, 2017 (2017-07-15T09:00:00.000Z), the data in the feed file will be items that changed after 9AM on July 15, 2017. Restrictions: Files are generated on the hour, so minutes and seconds are always zeros.    (2017-07-12T09:00:00.000Z) Format: UTC format (yyyy-MM-ddThh:00:00.000Z)","in":"query","name":"snapshot_date","required":true,"schema":{"type":"string"}}],"responses":{"200":{"description":"Partial Content","headers":{"Content-range":{"description":"The content-range response header indicates where in the full resource this partial chunk of data belongs. It returns the lower and upper values in bytes (specified by the Range header) of the chunk and the total size of the file being downloaded in bytes. Maximum range: 100 MB The following is an example of a content-range response, where 0-10 is the lower and upper limit in bytes and 1000 is the total size of the file in bytes.   0-10/1000 The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    */1000 For more information and examples, see Retrieving a gzip feed file.","schema":{"type":"string"}},"Last-Modified":{"description":"Returns the generated date of the feed file, which will be the latest file available. For example: Last-Modified  Wed, 21 Oct 2015 07:28:00 GMT","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemSnapshotResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemSnapshotResponse"}}}},"206":{"description":"Partial Content","headers":{"Content-range":{"description":"The content-range response header indicates where in the full resource this partial chunk of data belongs. It returns the lower and upper values in bytes (specified by the Range header) of the chunk and the total size of the file being downloaded in bytes. Maximum range: 100 MB The following is an example of a content-range response, where 0-10 is the lower and upper limit in bytes and 1000 is the total size of the file in bytes.   0-10/1000 The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    */1000 For more information and examples, see Retrieving a gzip feed file.","schema":{"type":"string"}},"Last-Modified":{"description":"Returns the generated date of the feed file, which will be the latest file available. For example: Last-Modified  Wed, 21 Oct 2015 07:28:00 GMT","schema":{"type":"string"}}},"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemSnapshotResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemSnapshotResponse"}}}},"400":{"description":"Bad Request","x-response-codes":{"errors":{"13000":{"category":"REQUEST","description":"The request contains data that is invalid. Correct the request and submit the call again. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13004":{"category":"REQUEST","description":"The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs.","domain":"API_FEED"},"13006":{"category":"REQUEST","description":"There was a problem with an eBay internal system or process. Wait a few minutes and retry the call. If that doesn't work, contact eBay Support.","domain":"API_FEED"},"13007":{"category":"REQUEST","description":"The feed file requested cannot be found. It is possible the file requested is in the process of being generated. Either change the date or try the call again later.","domain":"API_FEED"},"13010":{"category":"REQUEST","description":"The mandatory 'category_id' query parameter is missing.","domain":"API_FEED"},"13012":{"category":"REQUEST","description":"The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}","domain":"API_FEED"},"13013":{"category":"REQUEST","description":"The mandatory 'X-EBAY-C-MARKETPLACE-ID' header is missing. Valid values: {allowedMarketplaces}","domain":"API_FEED"},"13014":{"category":"REQUEST","description":"The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}","domain":"API_FEED"},"13015":{"category":"REQUEST","description":"The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13016":{"category":"REQUEST","description":"The 'Range' request header format is invalid. Format: 'bytes=start position-end position'. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13017":{"category":"REQUEST","description":"The 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call.","domain":"API_FEED"},"13018":{"category":"REQUEST","description":"The start position in the range header is invalid.","domain":"API_FEED"},"13019":{"category":"REQUEST","description":"The end position in the range header is invalid.","domain":"API_FEED"},"13020":{"category":"REQUEST","description":"The mandatory 'snapshot_date' query parameter is missing.","domain":"API_FEED"},"13021":{"category":"REQUEST","description":"The 'snapshot_date' query parameter is invalid.Valid format is 'yyyy-MM-ddTHH:mm:ss'","domain":"API_FEED"},"13022":{"category":"REQUEST","description":"The 'category_id' {category_id} submitted is not supported.","domain":"API_FEED"}}}},"404":{"description":"Not found"},"416":{"description":"Range not satisfiable"},"500":{"description":"Internal server error"}},"security":[{"Client_Credentials":["https://api.ebay.com/oauth/api_scope/buy.item.feed"]}],"tags":["item_snapshot"]}}},"servers":[{"url":"https://api.ebay.com/buy/feed/v1_beta"}],"components":{"securitySchemes":{"Client_Credentials":{"description":"The security definitions for this API. Please check individual operations for applicable scopes.","type":"oauth2","flows":{"clientCredentials":{"tokenUrl":"https://api.ebay.com/identity/v1/oauth2/token","scopes":{"https://api.ebay.com/oauth/api_scope/buy.item.feed":"View curated feeds of eBay items"}}}}},"schemas":{"AvailabilityEnum":{"description":"An enumerated type for the values that represent the item's availability. Code so that your app gracefully handles any future changes to this list.","enum":["TEMPORARILY_UNAVAILABLE","AVAILABLE","UNAVAILABLE"],"type":"object"},"AvailabilityThresholdEnum":{"description":"An enumerated type for the values that indicate the availability of an item based on the <a href=\"#display-item-quantity\">display item quantity</a> preference set by the seller. Code so that your app gracefully handles any future changes to this list.","enum":["MORE_THAN"],"type":"object"},"CurrencyCodeEnum":{"description":"The three-letter <a href=\"https://www.iso.org/iso-4217-currency-codes.html\" target=\"_blank\">ISO 4217</a> code representing a world currency.","enum":["AED","AFN","ALL","AMD","ANG","AOA","ARS","AUD","AWG","AZN","BAM","BBD","BDT","BGN","BHD","BIF","BMD","BND","BOB","BRL","BSD","BTN","BWP","BYR","BZD","CAD","CDF","CHF","CLP","CNY","COP","CRC","CUP","CVE","CZK","DJF","DKK","DOP","DZD","EGP","ERN","ETB","EUR","FJD","FKP","GBP","GEL","GHS","GIP","GMD","GNF","GTQ","GYD","HKD","HNL","HRK","HTG","HUF","IDR","ILS","INR","IQD","IRR","ISK","JMD","JOD","JPY","KES","KGS","KHR","KMF","KPW","KRW","KWD","KYD","KZT","LAK","LBP","LKR","LRD","LSL","LTL","LYD","MAD","MDL","MGA","MKD","MMK","MNT","MOP","MRO","MUR","MVR","MWK","MXN","MYR","MZN","NAD","NGN","NIO","NOK","NPR","NZD","OMR","PAB","PEN","PGK","PHP","PKR","PLN","PYG","QAR","RON","RSD","RUB","RWF","SAR","SBD","SCR","SDG","SEK","SGD","SHP","SLL","SOS","SRD","STD","SYP","SZL","THB","TJS","TMT","TND","TOP","TRY","TTD","TWD","TZS","UAH","UGX","USD","UYU","UZS","VEF","VND","VUV","WST","XAF","XCD","XOF","XPF","YER","ZAR","ZMW","ZWL"],"type":"object"},"DeliveryOptionsEnum":{"description":"An enumerated type for the values that represent how an item can be delivered to the buyer. You use this information to filter for items that can be shipped. Code so that your app gracefully handles any future changes to this list. Code so that your app gracefully handles any future changes to this list.","enum":["SHIP_TO_HOME","SELLER_ARRANGED_LOCAL_PICKUP"],"type":"object"},"Item":{"description":"The type that defines the columns returned in the Item feed file.","properties":{"acceptedPaymentMethods":{"description":"Indicates the credit card service that will be used to process the transaction. If this column contains PAYPAL, you can use the Buy Order API to checkout and purchase the item. If this column is empty, you must use another method for checkout.","type":"string"},"additionalImageUrls":{"description":"A pipe separated (|) list of URLs for the additional images of the item. These images are in addition to the primary image, which is returned in the imageUrl column. Note: This column can contain multiple values.","type":"string"},"availability":{"$ref":"#/components/schemas/AvailabilityEnum"},"availabilityThreshold":{"description":"This column has a value only when the seller sets their 'display item quantity' preference to Display "More than 10 available" in your listing (if applicable). The value of this column will be "10", which is the threshold value. Code so that your app gracefully handles any future changes to this value.","type":"integer"},"availabilityThresholdType":{"$ref":"#/components/schemas/AvailabilityThresholdEnum"},"brand":{"description":"The name brand of the item, such as Nike, Apple, etc.","type":"string"},"buyingOptions":{"description":"A comma separated list of the purchase options available for the item, such as FIXED_PRICE, AUCTION. FIXED_PRICE - Returned for fixed-price items (non-auction) AUCTION - Returned for auction items without Buy It Now feature FIXED_PRICE and AUCTION - Returned for auction items enabled with the Buy It Now feature Code so that your app gracefully handles any future changes to this list.","type":"string"},"category":{"description":"The label of the category. For example: Toys & Hobbies|Action Figures|Comic Book Heroes","type":"string"},"categoryId":{"description":"The ID of the category of the item. For example: The ID for Toys & Hobbies|Action Figures|Comic Book Heroes is 158671.","type":"string"},"condition":{"description":"The text describing the condition of the item. For a list of condition names, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list.","type":"string"},"conditionId":{"description":"The identifier of the condition of the item. For example, 1000 is the identifier for NEW. For a list of condition names and IDs, see Item Condition IDs and Names. Code so that your app gracefully handles any future changes to this list.","type":"string"},"deliveryOptions":{"$ref":"#/components/schemas/DeliveryOptionsEnum"},"discountAmount":{"description":"The calculated amount of the discount (originalPriceValue - priceValue). For example, if originalPriceValue is 70 and priceValue is 56, this value would be 14. Note: The currency shown in originalPriceCurrency is used for both discountAmount and originalPriceCurrency.","type":"string"},"discountPercentage":{"description":"The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20.","type":"string"},"energyEfficiencyClass":{"description":"Indicates the European energy efficiency rating (EEK) of the item. This field is returned only if the seller specified the energy efficiency rating. The rating is a set of energy efficiency classes from A to G, where 'A' is the most energy efficient and 'G' is the least efficient. This rating helps buyers choose between various models. To retrieve the manufacturer's specifications for this item, when they are available, use the getItem method in the Browse API. The information is returned in the productFicheWebUrl field.","type":"string"},"epid":{"description":"The eBay product identifier of a product from the eBay product catalog. You can use this value in the Browse API search method to retrieve items for this product and in the Marketing API methods to retrieve 'also viewed' and 'also bought' products to encourage up-selling and cross-selling.","type":"string"},"estimatedAvailableQuantity":{"description":"The estimated number of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is impossible to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.","type":"integer"},"gtin":{"description":"The unique Global Trade Item Number of the item as defined by http://www.gtin.info. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value.","type":"string"},"imageAlteringProhibited":{"description":"A boolean that indicates whether the images can be altered. If the value is true, you cannot modify the image. Note: Due to image licensing agreements and other legal concerns, modification (including resizing) of some images is strictly prohibited. These images are for display as-is only.","type":"boolean"},"imageUrl":{"description":"The URL to the primary image of the item. This is the URL of the largest image available based on what the seller submitted.","type":"string"},"inferredBrand":{"description":"The name brand for the item, such as Nike or Apple, which has been programmatically determined by eBay. To identify the product, this is always used along with MPN. If the seller provided a brand for the item, the seller's value is returned in the brand column.","type":"string"},"inferredEpid":{"description":"The ePID (eBay Product ID of a product from the eBay product catalog) for the item, which has been programmatically determined by eBay. If the seller provided an ePID for the item, the seller's value is returned in the epid column.","type":"string"},"inferredGtin":{"description":"The GTIN (Global Trade Item Number) of the product as defined by http://www.gtin.info, which as been programmatically determined by eBay. This can be a UPC (Universal Product Code), EAN (European Article Number), or an ISBN (International Standard Book Number) value. If the seller provided a GTIN for the item, the seller's value is returned in the gtin column.","type":"string"},"inferredLocalizedAspects":{"description":"A semicolon separated list of the name/value pairs for the aspects of the item, which are BASE64 encoded. These aspects have been programmatically determined by eBay. If the seller provided aspects for the item, the seller's values are returned in the localizedAspects column. The aspect label is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;). Example without Label    Encoded Format:    encodedName:encodedValue;encodedName:encodedValue;encodedName:encodedValue    Encoded Example (encoded text shown in orange):    U2l6ZQ==:WEw=;Q29sb3I=:UmVk;U2xlZXZlcw==:TG9uZw==    Decoded:    Size:XL;Color:Red;Sleeves:Long Example with Label    Encoded Format:    encodedLabel|encodedName:encodedValue;encodedName:encodedValue;encodedLabel|    Encoded Example (encoded text shown in orange):    UHJvZHVjdCBJZGVudGlmaWVycw==|R1RJTg==:MDE5MDE5ODA2NjYzMw==;QlJBTkQ=:QXBwbGU=;UHJvZHVjdCBLZXkgRmVhdHVyZXM=|TW9kZWw=:aVBob25lIDc=    Decoded:    Product Identifiers|GTIN:0190198066633;BRAND:Apple;Product Key Features|Model:iPhone 7 Note: The separators ( | : ; ) are not encoded. You must decode each label, name, and value separately. You cannot decode the entire string. For more information, see Encoded Aspects in the Buying Integration Guide.","type":"string"},"inferredMpn":{"description":"The MPN (Manufacturer's Part Number) for the item, which has been programmatically determined by eBay. To identify the product, this is always used along with brand. If the seller provided a MPN for the item, the seller's value is returned in the mpn column.","type":"string"},"itemEndDate":{"description":"A timestamp indicating when the item's sale period will end based on its start date and duration. For Good 'Til Cancelled' items, no value is returned in this column. Format: UTC (yyyy-MM-ddThh:mm:ss.sssZ).","type":"string"},"itemId":{"description":"The unique identifier of the eBay item.","type":"string"},"itemLocationCountry":{"description":"The country where the item is physically located.","type":"string"},"localizedAspects":{"description":"A semicolon separated list of the name/value pairs for the aspects of the item, which are BASE64 encoded. The aspect label is separated by a pipe (|), the aspect name and value are separated by a colon (:) and the name/value pairs are separated by a semicolon (;). Example without Label    Encoded Format:    encodedName:encodedValue;encodedName:encodedValue;encodedName:encodedValue    Encoded Example (encoded text shown in orange):    U2l6ZQ==:WEw=;Q29sb3I=:UmVk;U2xlZXZlcw==:TG9uZw==    Decoded:    Size:XL;Color:Red;Sleeves:Long Example with Label    Encoded Format:    encodedLabel|encodedName:encodedValue;encodedName:encodedValue;encodedLabel|    Encoded Example (encoded text shown in orange):    UHJvZHVjdCBJZGVudGlmaWVycw==|R1RJTg==:MDE5MDE5ODA2NjYzMw==;QlJBTkQ=:QXBwbGU=;UHJvZHVjdCBLZXkgRmVhdHVyZXM=|TW9kZWw=:aVBob25lIDc=    Decoded:    Product Identifiers|GTIN:0190198066633;BRAND:Apple;Product Key Features|Model:iPhone 7 Note: The separators ( | : ; ) are not encoded. You must decode each label, name, and value separately. You cannot decode the entire string. For more information, see Encoded Aspects in the Buying Integration Guide.","type":"string"},"mpn":{"description":"The manufacturer part number, which is a number that is used in combination with brand to identify a product.","type":"string"},"originalPriceCurrency":{"$ref":"#/components/schemas/CurrencyCodeEnum"},"originalPriceValue":{"description":"The original selling price of the item. This lets you surface a strikethrough price for the item.","type":"string"},"priceCurrency":{"$ref":"#/components/schemas/CurrencyCodeEnum"},"priceValue":{"description":"The price of the item. This price can be a discounted price. If it is discounted, information about the discount is returned in the originalPriceValue, originalPriceCurrency, discountAmount, and discountPercentage columns.","type":"string"},"primaryItemGroupId":{"description":"The unique identifier for the item group that contains this item. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.","type":"string"},"primaryItemGroupType":{"description":"The item group type. Supported value: SELLER_DEFINED_VARIATIONS, indicates that the item group was created by the seller. Code so that your app gracefully handles any future changes to this list.","type":"string"},"qualifiedPrograms":{"description":"A pipe separated list of the qualified programs available for the item. Currently, the only qualified program returned is EBAY_PLUS. Note: The EBAY_PLUS program is supported only on the EBAY_DE and EBAY_AU marketplaces. This means the qualifiedPrograms column will be populated only in feed files for these marketplaces. Currently, only EBAY_DE feed files are available. For a list of marketplaces supported by the Feed API, see Buy API Support by Marketplace. Program Values: EBAY_PLUS","type":"string"},"refundMethod":{"$ref":"#/components/schemas/RefundMethodEnum"},"returnMethod":{"$ref":"#/components/schemas/ReturnMethodEnum"},"returnPeriodUnit":{"$ref":"#/components/schemas/TimeDurationUnitEnum"},"returnPeriodValue":{"description":"The amount of time the buyer has to return the item after the purchase date. This can be the number of years, months, or days depending on returnPeriodUnit. For example, if this value is '30', and the returnPeriodUnit value is 'DAY', the return period is 30 days.","type":"integer"},"returnShippingCostPayer":{"$ref":"#/components/schemas/ReturnShippingCostPayerEnum"},"returnsAccepted":{"description":"Indicates whether the seller accepts returns for the item.","type":"boolean"},"sellerFeedbackPercentage":{"description":"The percentage of the seller's total positive feedback.","type":"string"},"sellerFeedbackScore":{"description":"The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller.","type":"string"},"sellerItemRevision":{"description":"An identifier generated/incremented when a seller revises the item. There are two types of item revisions; seller changes, such as changing the title and eBay system changes, such as changing the quantity when an item is purchased. This ID is changed only when the seller makes a change to the item.","type":"string"},"sellerTrustLevel":{"$ref":"#/components/schemas/SellerTrustLevelEnum"},"sellerUsername":{"description":"The seller's eBay user name.","type":"string"},"shipToExcludedRegions":{"description":"A pipe (|) separated alphabetical list of the geographic countries and regions where the item cannot be shipped. These countries and regions refine (restric