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 • 136 kB

JSON

{"openapi":"3.0.0","servers":[{"url":"https://api.ebay.com/buy/feed/v1_beta"}],"info":{"contact":{"name":"eBay Inc,","x-twitter":"ebay"},"description":"Note: This is a <a href=\"https://developer.ebay.com/api-docs/static/versioning.html#limited \" target=\"_blank\"> <img src=\"/cms/img/docs/partners-api.svg\" class=\"legend-icon partners-icon\" title=\"Limited Release\" alt=\"Limited Release\" />(Limited Release)</a> API available only to select developers approved by business units. For information on how to obtain access to this API in production, see the <a href=\"api-docs/buy/static/buy-requirements.html\" target=\"_blank\">Buy APIs Requirements</a>. 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 <a href=\"https://github.com/eBay/FeedSDK \" target=\"_blank\">Feed SDK</a> 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.34.0","x-apisguru-categories":["ecommerce"],"x-logo":{"backgroundColor":"#FFFFFF","url":"https://twitter.com/ebay/profile_image?size=original"},"x-origin":[{"format":"openapi","url":"https://developer.ebay.com/api-docs/master/buy/feed/openapi/2/buy_feed_v1_beta_oas2.json","version":"3.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 <a href=\"/api-docs/buy/feed/resources/item/methods/getItemFeed#h3-response-fields\">Response fields</a> section. There are two types of item feed files generated: <ul> <li>A daily Item feed file containing all the newly listed items for a specific category, date, and marketplace (feed_scope = <code>NEWLY_LISTED</code>)</li> <li>A weekly Item Bootstrap feed file containing all the items in a specific category and marketplace (feed_scope = <code>ALL_ACTIVE</code>)</li> </ul> Note: Filters are applied to the feed files. For details, see <a href=\"/api-docs/buy/static/api-feed_beta.html#Feed2\">Feed File Filters</a>. 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.<h3>Downloading feed files </h3> 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 <a href=\"#range-header\">Range</a> request header. The <a href=\"#content-range\">Content-range</a> 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 <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>. In addition to the API, there is an open source <a href=\"https://github.com/eBay/FeedSDK\" target=\"_blank\">Feed SDK</a> 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: A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. For documentation purposes, the successful call response is shown below as JSON fields so that the value returned in each column can be explained. The order of the response fields shows the order of the columns in the feed file. <h3>Restrictions </h3> For a list of supported sites and other restrictions, see <a href=\"/api-docs/buy/feed/overview.html#API\">API Restrictions</a>.","operationId":"getItemFeed","parameters":[{"description":"The formats that the client accepts for the response. A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. Default: <code>application/json,text/tab-separated-values</code>","in":"header","name":"Accept","required":true,"schema":{"type":"string"}},{"description":"The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example:   <code>X-EBAY-C-MARKETPLACE-ID = EBAY_US</code> For a list of supported sites see, <a href=\"/api-docs/buy/feed/overview.html#API\">API Restrictions</a>.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}},{"description":"<a name=\"range-header\"></a>This header specifies the range in bytes of the chunks of the gzip file being returned. Format: <code >bytes=startpos-endpos</code> For example, the following retrieves the first 10 MBs of the feed file.   <code>Range bytes=0-10485760</code> For more information about using this header, see <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>. Maximum: 100 MB (10MB in the Sandbox)","in":"header","name":"Range","required":true,"schema":{"type":"string"}},{"description":"Specifies the type of feed file to return. Valid Values: <ul> <li> NEWLY_LISTED - Returns the daily Item feed file containing all Good 'Til Cancelled items that were listed on the day specified by the date parameter in the category specified by the category_id parameter. <code>/item?feed_scope=NEWLY_LISTED&category_id=15032&date=20170925</code></li><li>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. Note: Bootstrap files are generated every Tuesday and the file is available on Wednesday. However, the exact time the file is available can vary so we recommend you download the Bootstrap file on Thursday. The items in the file are the items that were in the specified category on Sunday. <code>/item?feed_scope=ALL_ACTIVE&category_id=15032</code> </ul>","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 marketplace, you can use the Taxonomy API <a href=\"/api-docs/commerce/taxonomy/resources/category_tree/methods/getCategoryTree\">getCategoryTree</a> method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example:   <code>\"categoryTreeNodeLevel\": 1</code> For details see <a href=\"/api-docs/buy/buy-categories.html\">Get Categories for Buy APIs</a>. </li> </ul> Restriction: Must be a top-level (L1) category other than Real Estate. Items listed under Real Estate L1 categories are excluded from all feeds in all marketplaces.","in":"query","name":"category_id","required":true,"schema":{"type":"string"}},{"description":"The date of the daily Item feed file (feed_scope=<code>NEWLY_LISTED</code>) 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=<code>ALL_ACTIVE</code>), 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.</code> The Item feed files are generated every day and there are 14 daily files available. Note: <ul> <li>The daily Item feed files are available each day after 9AM MST (US Mountain Standard Time), which is -7 hours UTC time.</li> <li>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.</li> </ul> Format: <code>yyyyMMdd</code> Requirements: <ul> <li>Required when feed_scope=<code>NEWLY_LISTED</code> </li> <li>Must be within 3-14 days in the past</li></ul>","in":"query","name":"date","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}},"description":"Partial Content","headers":{"Content-range":{"description":"<a name=\"content-range\"></a>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.   <code>0-10/1000</code> The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    <code>*/1000</code> For more information and examples, see <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>.","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  <code>Wed, 21 Oct 2015 07:28:00 GMT</code>","schema":{"type":"string"}}}},"204":{"description":"No Content This code is returned when there are no items that meet the criteria for this feed file. See <a href=\"/api-docs/buy/static/api-feed.html#feed-filters\">Feed File Filters</a> for details."},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemResponse"}}},"description":"Partial Content","headers":{"Content-range":{"description":"<a name=\"content-range\"></a>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.   <code>0-10/1000</code> The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    <code>*/1000</code> For more information and examples, see <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>.","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  <code>Wed, 21 Oct 2015 07:28:00 GMT</code>","schema":{"type":"string"}}}},"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' {feedDate} submitted is invalid. Either the date format is wrong, or the files are not available for the specific date. Valid values: {earliestDate} to {latestDate} in the past. The format is yyyyMMdd.","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"}}}},"403":{"description":"Forbidden","x-response-codes":{"errors":{"13023":{"category":"BUSINESS","description":"Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical Support for further assistance.","domain":"API_FEED"},"13024":{"category":"BUSINESS","description":"Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical Support for further assistance.","domain":"API_FEED"}}}},"404":{"description":"Not found"},"409":{"description":"Conflict"},"416":{"description":"Range not satisfiable"},"500":{"description":"Internal server error","x-response-codes":{"errors":{"13006":{"category":"APPLICATION","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"}}}}},"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: <ul> <li>A daily Item Group feed file containing the item group variation information associated with items returned in the <a href=\"/api-docs/buy/feed/resources/item/methods/getItemFeed\">Item</a> feed file for a specific day, category, and marketplace. (feed_scope = <code>NEWLY_LISTED</code>)</li> <li>A weekly Item Group Bootstrap feed file containing all the item group variation information associated with items returned in the <a href=\"/api-docs/buy/feed/resources/item/methods/getItemFeed\">Item Bootstrap</a> feed file for all the items in a specific category. (feed_scope = <code>ALL_ACTIVE</code>)</li> </ul> Note: Filters are applied to the feed files. For details, see <a href=\"/api-docs/buy/static/api-feed.html#feed-filters\">Feed File Filters</a>. 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 <a href=\"/api-docs/buy/feed/resources/item_group/methods/getItemGroupFeed#h3-response-fields\">Response fields</a> section. <h3>Combining the Item Group and Item feed files</h3> 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.<h3>Downloading feed files </h3> 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 <a href=\"#range-header\">Range</a> request header. The <a href=\"#content-range\">content-range</a> 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 <a href=\"/api-docs/{swift-folder}/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>. Note: A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. For documentation purposes, the successful call response is shown below as JSON fields so that the value returned in each column can be explained. The order of the response fields shows the order of the columns in the feed file. <h3>Restrictions </h3> For a list of supported sites and other restrictions, see <a href=\"/api-docs/{swift-folder}/buy/feed/overview.html#API\">API Restrictions</a>. ","operationId":"getItemGroupFeed","parameters":[{"description":"The formats that the client accepts for the response. A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate error codes that are returned in JSON format. Default: <code>application/json,text/tab-separated-values</code>","in":"header","name":"Accept","required":true,"schema":{"type":"string"}},{"description":"The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example:   <code>X-EBAY-C-MARKETPLACE-ID = EBAY_US</code> For a list of supported sites see, <a href=\"/api-docs/buy/feed/overview.html#API\">API Restrictions</a>.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}},{"description":"<a name=\"range-header\"></a>This header specifies the range in bytes of the chunks of the gzip file being returned. Format: <code>bytes=startpos-endpos</code> For example, the following retrieves the first 10 MBs of the feed file.   <code>Range bytes=0-10485760</code> For more information about using this header, see <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>. Maximum: 100 MB (10MB in the Sandbox)","in":"header","name":"Range","required":false,"schema":{"type":"string"}},{"description":"Specifies the type of file to return. Valid Values: <ul> <li> NEWLY_LISTED - Returns the Item Group feed file containing the item group variation information for items in the daily <a href=\"/api-docs/buy/feed/resources/item/methods/getItemFeed\">Item</a> 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. <code>/item_group?feed_scope=NEWLY_LISTED&category_id=15032&date=20170925</code></li> <li>ALL_ACTIVE - Returns the weekly Item Group Bootstrap file containing the item group variation information for items in the weekly <a href=\"/api-docs/buy/feed/resources/item/methods/getItemFeed\">Item Bootstrap</a> 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. Note: Bootstrap files are generated every Tuesday and the file is available on Wednesday. However, the exact time the file is available can vary so we recommend you download the Bootstrap file on Thursday. The item groups in the file are for the items that were in the specified category on Sunday. <code>/item_group?feed_scope=ALL_ACTIVE&category_id=15032</code> ","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 <a href=\"/api-docs/commerce/taxonomy/resources/category_tree/methods/getCategoryTree\">getCategoryTree</a> method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example:   <code>\"categoryTreeNodeLevel\": 1</code> For details see <a href=\"/api-docs/buy/buy-categories.html\">Get Categories for Buy APIs</a>. </li> </ul> Restriction: Must be a top-level category other than Real Estate. Items listed under Real Estate L1 categories are excluded from all feeds in all marketplaces.","in":"query","name":"category_id","required":true,"schema":{"type":"string"}},{"description":" The date of the daily Item Group feed file (feed_scope=<code>NEWLY_LISTED</code>) 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=<code>ALL_ACTIVE</code>), 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.</code> The Item Group feed files are generated every day and there are 14 daily 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: <code>yyyyMMdd</code> Requirements: <ul> <li>Required only when feed_scope=<code>NEWLY_LISTED</code> </li> <li>Must be within 3-14 days in the past</li> </ul> ","in":"query","name":"date","required":false,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemGroupResponse"}}},"description":"Partial Content","headers":{"Content-range":{"description":"<a name=\"content-range\"></a>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.   <code>0-10/1000</code> The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    <code>*/1000</code> For more information and examples, see <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>.","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  <code>Wed, 21 Oct 2015 07:28:00 GMT</code>","schema":{"type":"string"}}}},"204":{"description":"No Content This code is returned when there are no items that meet the criteria for this feed file. See <a href=\"/api-docs/buy/static/api-feed.html#feed-filters\">Feed File Filters</a> for details."},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemGroupResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemGroupResponse"}}},"description":"Partial Content","headers":{"Content-range":{"description":"<a name=\"content-range\"></a>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.   <code>0-10/1000</code> The following example of a content-range response indicates the value of the Range header is invalid and a 416 status code is returned.    <code>*/1000</code> For more information and examples, see <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>.","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  <code>Wed, 21 Oct 2015 07:28:00 GMT</code>","schema":{"type":"string"}}}},"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' {feedDate} submitted is invalid. Either the date format is wrong, or the files are not available for the specific date. Valid values: {earliestDate} to {latestDate} in the past. The format is yyyyMMdd.","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"}}}},"403":{"description":"Forbidden","x-response-codes":{"errors":{"13023":{"category":"BUSINESS","description":"Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical Support for further assistance.","domain":"API_FEED"},"13024":{"category":"BUSINESS","description":"Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical Support for further assistance.","domain":"API_FEED"}}}},"404":{"description":"Not found"},"409":{"description":"Conflict"},"416":{"description":"Range not satisfiable"},"500":{"description":"Internal server error","x-response-codes":{"errors":{"13006":{"category":"APPLICATION","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"}}}}},"security":[{"Client_Credentials":["https://api.ebay.com/oauth/api_scope/buy.item.feed"]}],"tags":["item_group"]}},"/item_priority":{"get":{"description":"Using this method, you can download a TSV_GZIP (tab separated value gzip) Item Priority feed file, which allows you to track changes (deltas) in the status of your priority items, such as when an item is added or removed from a campaign. The delta feed tracks the changes to the status of items within a category you specify in the input URI. You can also specify a specific date for the feed you want returned. Important: You must consume the daily feeds (Item, Item Group) before consuming the Item Priority feed. This ensures that your inventory is up to date.<h3>Downloading feed files </h3> Note: Filters are applied to the feed files. For details, see <a href=\"/api-docs/buy/static/api-feed.html#feed-filters\">Feed File Filters</a>. 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.Priority 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 <a href=\"#range-header\">Range</a> request header. The <a href=\"#content-range\">Content-range</a> 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 <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>. In addition to the API, there is an open source <a href=\"https://github.com/eBay/FeedSDK\" target=\"_blank\">Feed SDK</a> 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: A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. For documentation purposes, the successful call response is shown below as JSON fields so that the value returned in each column can be explained. The order of the response fields shows the order of the columns in the feed file. <h3>Restrictions </h3> For a list of supported sites and other restrictions, see <a href=\"/api-docs/buy/feed/overview.html#API\">API Restrictions</a>.","operationId":"getItemPriorityFeed","parameters":[{"description":"The formats that the client accepts for the response. A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate error codes that are returned in JSON format. Default: <code>application/json,text/tab-separated-values</code>","in":"header","name":"Accept","required":true,"schema":{"type":"string"}},{"description":"The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example:   <code>X-EBAY-C-MARKETPLACE-ID = EBAY_US</code> For a list of supported sites see, <a href=\"/api-docs/buy/static/ref-marketplace-supported.html\">Buy API Support by Marketplace</a>.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}},{"description":"Header specifying content range to be retrieved. Only supported range is bytes. Example : <code>bytes = 0-102400</code>.","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 marketplaces, you can use the Taxonomy API <a href=\"/api-docs/commerce/taxonomy/resources/category_tree/methods/getCategoryTree\">getCategoryTree</a> method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example:   <code>\"categoryTreeNodeLevel\": 1</code> For details see <a href=\"/api-docs/buy/api-feed.html#Getcat\">Get the eBay categories of a marketplace</a>.</li></ul> Restriction: Must be a top-level category other than Real Estate. Items listed under Real Estate L1 categories are excluded from all feeds in all marketplaces.","in":"query","name":"category_id","required":true,"schema":{"type":"string"}},{"description":"The date of the feed you want returned. This can be up to 14 days in the past but cannot be set to a date in the future. Format: <code>yyyyMMdd</code> Note: <ul> <li>The daily Item feed files are available each day after 9AM MST (US Mountain Standard Time), which is -7 hours UTC time.</li> <li>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.</li> </ul>","in":"query","name":"date","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemPriorityResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemPriorityResponse"}}},"description":"Partial Content","headers":{"Content-range":{"description":"The content range for the current request. Typically in the format : <code>0-100/1000</code> where <code>0-100</code> is the content length of the current response and <code>1000</code> is the total content length. In case of a 416 status code, content-range would be <code>*/1000</code>, which denotes an invalid range header.","schema":{"type":"string"}},"Last-Modified":{"description":"Signifies the date when the files are generated. For example : <code>Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT</code>.","schema":{"type":"string"}}}},"204":{"description":"No Content"},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemPriorityResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemPriorityResponse"}}},"description":"Partial Content","headers":{"Content-range":{"description":"The content range for the current request. Typically in the format : <code>0-100/1000</code> where <code>0-100</code> is the content length of the current response and <code>1000</code> is the total content length. In case of a 416 status code, content-range would be <code>*/1000</code>, which denotes an invalid range header.","schema":{"type":"string"}},"Last-Modified":{"description":"Signifies the date when the files are generated. For example : <code>Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT</code>.","schema":{"type":"string"}}}},"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"},"13005":{"category":"REQUEST","description":"The 'date' {feedDate} submitted is invalid. Either the date format is wrong, or the files are not available for the specific date. Valid values: {earliestDate} to {latestDate} in the past. The format is yyyyMMdd.","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"},"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"}}}},"403":{"description":"Forbidden","x-response-codes":{"errors":{"13023":{"category":"BUSINESS","description":"Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical support for further assistance.","domain":"API_FEED"},"13024":{"category":"BUSINESS","description":"Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical support for further assistance.","domain":"API_FEED"}}}},"404":{"description":"Not found","x-response-codes":{"errors":{"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"}}}},"409":{"description":"Conflict"},"416":{"description":"Range not satisfiable","x-response-codes":{"errors":{"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"}}}},"500":{"description":"Internal server error","x-response-codes":{"errors":{"13006":{"category":"APPLICATION","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"}}}}},"security":[{"Client_Credentials":["https://api.ebay.com/oauth/api_scope/buy.item.feed"]}],"tags":["item_priority"]}},"/item_snapshot":{"get":{"description":" The Hourly Snapshot feed file is generated each hour every day for most 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 <a href=\"/api-docs/buy/static/api-feed.html#changed-items\">changed</a> 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. Snapshot feeds now include new listings. You can check <a href=\"/api-docs/buy/feed/resources/item_snapshot/methods/getItemSnapshotFeed#response.items.itemCreationDate\">itemCreationDate</a> to identify listings that were newly created within the specified hour. Note: Filters are applied to the feed files. For details, see <a href=\"/api-docs/buy/static/api-feed.html#feed-filters\">Feed File Filters</a>. 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 looking at the value of <a href=\"/api-docs/buy/feed/resources/item_snapshot/methods/getItemSnapshotFeed#response.items.itemSnapshotDate\">itemSnapshotDate</a> for a given item, you will be able to tell which information is the latest. Important: When the value of the availability column is <code>UNAVAILABLE</code>, only the itemId and availability columns are populated. <h3>Downloading feed files </h3>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 <a href=\"#range-header\">Range</a> request header. The <a href=\"#content-range\">Content-range</a> 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 <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>. Note: A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate errors that are returned in JSON format. For documentation purposes, the successful call response is shown below as JSON fields so that the value returned in each column can be explained. The order of the response fields shows the order of the columns in the feed file.<h3>Restrictions </h3>For a list of supported sites and other restrictions, see <a href=\"/api-docs/buy/feed/overview.html#API\">API Restrictions</a>. ","operationId":"getItemSnapshotFeed","parameters":[{"description":"The formats that the client accepts for the response. A successful call will always return a TSV.GZIP file; however, unsuccessful calls generate error codes that are returned in JSON format. Default: <code>application/json,text/tab-separated-values</code>","in":"header","name":"Accept","required":true,"schema":{"type":"string"}},{"description":"The ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive. For example:   <code>X-EBAY-C-MARKETPLACE-ID = EBAY_US</code> For a list of supported sites see, <a href=\"/api-docs/buy/feed/overview.html#API\">API Restrictions</a>.","in":"header","name":"X-EBAY-C-MARKETPLACE-ID","required":true,"schema":{"type":"string"}},{"description":"<a name=\"range-header\"></a>This header specifies the range in bytes of the chunks of the gzip file being returned. Format: <code>bytes=startpos-endpos</code> For example, the following retrieves the first 10 MBs of the feed file.   <code>Range bytes=0-10485760</code> For more information about using this header, see <a href=\"/api-docs/buy/static/api-feed_beta.html#retrv-gzip\">Retrieving a gzip feed file</a>. Maximum: 100 MB (10MB in the Sandbox)","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 <a href=\"/api-docs/commerce/taxonomy/resources/category_tree/methods/getCategoryTree\">getCategoryTree</a> method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field. For example:   <code>\"categoryTreeNodeLevel\": 1</code> For details see <a href=\"/api-docs/buy/buy-categories.html\">Get Categories for Buy APIs</a>.</li> </ul> Restriction: Must be a top-level category other than Real Estate. Items listed under Real Estate L1 categories are excluded from all feeds in all marketplaces.","in":"query","name":"category_id","required":true,"schema":{"type":"string"}},{"description":"The date and hour of the snapshot feed file you want. Each file contains the items that changed within the hour in the specified category. So, the 9AM file contains the items that changed between 9AM and 9:59AM on the day specified. It takes 2 hours to generate