{"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 \"Limited(Limited Release) API available only to select developers approved by business units. For information on how to obtain access to this API in production, see the Buy APIs Requirements.

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.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 Response fields section.

There are two types of item feed files generated:

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.

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

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

","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: application/json,text/tab-separated-values","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:
  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 header, see Retrieving a gzip feed file.

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: ","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 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 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=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 14 daily files available.

Note:

Format: yyyyMMdd

Requirements:

","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":"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"}}}},"204":{"description":"No Content
This code is returned when there are no items that meet the criteria for this feed file. See Feed File Filters 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":"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"}}}},"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:

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.

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

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

","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: application/json,text/tab-separated-values","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:
  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 header, see Retrieving a gzip feed file.

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:

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=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 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: yyyyMMdd

Requirements: ","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":"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"}}}},"204":{"description":"No Content
This code is returned when there are no items that meet the criteria for this feed file. See Feed File Filters 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":"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"}}}},"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.

Downloading feed files

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.

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

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

","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: application/json,text/tab-separated-values","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:
  X-EBAY-C-MARKETPLACE-ID = EBAY_US

For a list of supported sites see, Buy API Support by Marketplace.","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 : bytes = 0-102400.","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 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 the eBay categories of a marketplace.

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: yyyyMMdd

Note: ","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 : 0-100/1000 where 0-100 is the content length of the current response and 1000 is the total content length. In case of a 416 status code, content-range would be */1000, which denotes an invalid range header.","schema":{"type":"string"}},"Last-Modified":{"description":"Signifies the date when the files are generated. For example : Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT.","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 : 0-100/1000 where 0-100 is the content length of the current response and 1000 is the total content length. In case of a 416 status code, content-range would be */1000, which denotes an invalid range header.","schema":{"type":"string"}},"Last-Modified":{"description":"Signifies the date when the files are generated. For example : Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT.","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 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.

Snapshot feeds now include new listings. You can check itemCreationDate to identify listings that were newly created within the specified hour.

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 looking at the value of itemSnapshotDate for a given 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.

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

Restrictions

For a list of supported sites and other restrictions, see API Restrictions.

","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: application/json,text/tab-separated-values","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:
  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 header, see Retrieving a gzip feed file.

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 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 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 a snapshot file, which means to get the file for 9AM the earliest you could submit the call is at 11AM.

There are 7 days of Hourly Snapshot feed files available.

Note: The Feed API uses GMT, so you must convert your local time to GMT. For example, if you lived in California and wanted the September 15th 7pm file, you would submit the following call:

item_snapshot?category_id=625&snapshot_date=2017-09-16T02:00:00.000Z

Format: UTC yyyy-MM-ddThh:00:00.000Z

Files are generated on the hour, so minutes and seconds are always zeros.","in":"query","name":"snapshot_date","required":true,"schema":{"type":"string"}}],"responses":{"200":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemSnapshotResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemSnapshotResponse"}}},"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"}}}},"204":{"description":"No Content
This code is returned when there are no items that meet the criteria for this feed file. See Feed File Filters for details."},"206":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ItemSnapshotResponse"}},"text/tab-separated-values":{"schema":{"$ref":"#/components/schemas/ItemSnapshotResponse"}}},"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"}}}},"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"},"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"}}}},"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_snapshot"]}}},"components":{"schemas":{"Item":{"description":"The type that defines the columns returned in the Item feed file.","properties":{"acceptedPaymentMethods":{"description":"This field is returned empty. For a list of payment methods available for a marketplace, see eBay help pages or the actual View Item page.","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"},"additionalShippingCostPerUnit":{"description":"Any per item additional shipping costs for a multi-item purchase. For example, let's say the shipping cost for a power cord is $3. But for an additional cord, the shipping cost is only $1. So if you bought 3 cords, the shippingCost would be $3 and this value would be $2 ($1 for each additional item).","type":"string"},"ageGroup":{"description":"The age group that the product is recommended for.

Valid values: newborn, infant, toddler, kids, adult.","type":"string"},"alerts":{"description":"A pipe-separated list of alerts available for the item.

For example, if the DELAYED_DELIVERY alert was returned for an item, it would indicate a delay in shipping by the seller.","type":"string"},"availability":{"description":"An enumeration value representing the item's availability (possibility of being purchased).

Values: Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"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":{"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 MORE_THAN. This indicates that the seller has more than the 'Display Item Quantity', which is 10, in stock for this item.

The following are the Display Item Quantity preferences the seller can set.

Code so that your app gracefully handles any future changes to these preferences. For implementation help, refer to eBay API documentation","type":"string"},"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. Currently the only supported option is FIXED_PRICE.","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"},"color":{"description":"The color of the item.","type":"string"},"condition":{"description":"The text describing the condition of the item. For a list of condition names, see Item Condition IDs and Names.","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"},"defaultImageUrl":{"description":"URL to the gallery or default image of the item. The other images of the item are returned in the additionalImageUrls field.

For example

https://i.ebayimg.com/00/s/M********w/z/W********p/$_1.JPG?set_id=8********F","type":"string"},"deliveryOptions":{"description":"A comma-separated list of available delivery options. This column lets you filter out items than cannot be shipped to the buyer.

Valid Values: SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, and PICKUP_DROP_OFF.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"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"},"ecoParticipationFeeCurrency":{"description":"The currency in which the Eco Participation Fee for the item is paid.","type":"string"},"ecoParticipationFeeValue":{"description":"The amount of the Eco Participation Fee, a fee paid toward the eventual disposal of the purchased item.","type":"string"},"energyEfficiencyClass":{"description":"Indicates the European energy efficiency rating (EEK) of the item. Data is returned in this column 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"},"gender":{"description":"In cases where items could vary by gender, this specifies for which gender the product is intended. Possible values include male, female, and unisex.","type":"string"},"gtin":{"description":"The unique Global Trade Item Number of the item as defined by https://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"},"hazmatAdditionalInformation":{"description":"Base64 encoded additional information about the hazardous material.","type":"string"},"hazmatPictogramDescriptions":{"description":"The base64 encoded descriptions of hazardous material pictograms, separated by the pipe symbol. For example:

encoded(exploding bomb)|encoded(flame)","type":"string"},"hazmatPictogramIds":{"description":"The IDs of hazardous material pictograms, separated by the pipe symbol. For example:

SGH01|SGH02","type":"string"},"hazmatPictogramImageUrls":{"description":"The image URLs of hazardous material pictograms, separated by the pipe symbol. For example:

https://img1|https://img2","type":"string"},"hazmatSignalWord":{"description":"The localized signal word for the hazardous material, such as 'Danger'.","type":"string"},"hazmatSignalWordId":{"description":"The ID of the signal word for the hazardous material.","type":"string"},"hazmatStatementDescriptions":{"description":"The base64 encoded descriptions of hazardous material statements, separated by the pipe symbol. For example:

encoded(Unstable explosives)|encoded(Flammable gas)","type":"string"},"hazmatStatementIds":{"description":"The IDs of hazardous material statements, separated by the pipe symbol. For example:

H200|H221","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 in the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data.

If the seller actually provided an ePID at listing time for the item, the ePID value is returned in the epid column instead.","type":"string"},"inferredGtin":{"description":"The GTIN (Global Trade Item Number) of the product as defined by https://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 (The delimiters are emphasized):
   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 (The delimiters are emphasized):
   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"},"itemAffiliateWebUrl":{"description":"The URL of the View Item page of the item, with the affiliate tracking ID appended to it.

For example

https://www.ebay.de/itm/2********0?mkevt=1&mkcid=1&mkrid=707-53477-19255-0&campid=CAMPAIGNID&toolid=2***6&customid=CUSTOMID","type":"string"},"itemCreationDate":{"description":"A timestamp indicating when the item was created.

Format: UTC yyyy-MM-ddThh:mm:ss.sssZ","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 an item in eBay RESTful format. An example would be v1|1**********2|4**********2.","type":"string"},"itemLocationCountry":{"description":"The country where the item is physically located.","type":"string"},"itemWebUrl":{"description":"The URL of the View Item page of the item.

For example:

Single SKU:
https://www.ebay.de/itm/2********0

MSKU:
https://www.ebay.com/itm/2********9?var=5********2","type":"string"},"legacyItemId":{"description":"The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.","type":"string"},"lengthUnitOfMeasure":{"description":"The unit of measurement used for the package dimensions, such as INCH, FEET, CENTIMETER, or METER.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","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 (The delimiters are emphasized):
   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 (The delimiters are emphasized):
   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"},"lotSize":{"description":"The number of items in a lot. In other words, a lot size is the number of items that are being sold together.

A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.

For example:

Item Lot Definition Lot Size
A package of 24 AA batteries A box of 10 packages 10
A P235/75-15 Goodyear tire 4 tires 4
Fashion Jewelry Rings Package of 100 assorted rings 100


Note: Lots are not supported in all categories. ","type":"integer"},"material":{"description":"The material that the item is made of.","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":{"description":"The currency of the originalPriceValue of the item and the discountAmount. For implementation help, refer to eBay API documentation","type":"string"},"originalPriceValue":{"description":"The original selling price of the item. This lets you surface a strikethrough price for the item. ","type":"string"},"packageHeight":{"description":"The height of the shipping package that contains the item.","type":"string"},"packageLength":{"description":"The length of the shipping package that contains the item.","type":"string"},"packageWeight":{"description":"The weight of the package that contains the item.","type":"string"},"packageWidth":{"description":"The width of the shipping package that contains the item.","type":"string"},"pattern":{"description":"Text describing the pattern used on the item. For example, paisley.

Note: All the item aspects, including this aspect, are returned in the localizedAspects container.","type":"string"},"priceCurrency":{"description":"The currency used for the price of the item. Generally, this is the currency used by the country of the eBay site offering the item. For implementation help, refer to eBay API documentation","type":"string"},"priceValue":{"description":"The price of the item, which can be a discounted price. If it is discounted, information about the discount is returned in the originalPriceValue, originalPriceCurrency, discountAmount, and discountPercentage columns.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.","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"},"priorityListingPayload":{"description":"EPN (eBay Partner Network) publishers append this value to their affiliate tracking URL when using an EPN tracking link to track changes that occur to Priority Listing items.

Example:amdata=enc%3AAQAFAAAAkB1DmsmXf%2BqZ%2BCEMGdebW6oR75GCMdBmc4MCQ%2FCEPqgKHbT0jdWhPwfY5LdUs6HTaP0eBlwKE7Smy2eDslewF7l3xjwWxjqwzNAnsYgxn2PiGkTKbiQSQytFUiymdtANpk1qOnBOoMGMK%2BWsji7jYlvySSs9o9s24TxD6RqWZpNrltzOU7mfnv3H40SZ3YESzg%3D%3D

See Creating an EPN Tracking Link for information on EPN tracking links.","type":"string"},"qualifiedPrograms":{"description":"A pipe separated list of the qualified programs available for the item, such as EBAY_PLUS and AUTHENTICITY_GUARANTEE.

eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items. Note: eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.

The eBay Authenticity Guarantee program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers.","type":"string"},"quantityUsedForEstimate":{"description":"The number of items used when calculating the estimation information.","type":"integer"},"refundMethod":{"description":"An enumeration value that indicates how a buyer is refunded when an item is returned.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"repairScore":{"description":"A score that describes how easy it is to repair the product. Score values range from 0.1 (hardest to repair) to 10.0 (easiest), always including a single decimal place.

Note: Support for this field is currently limited to the France marketplace.","type":"string"},"returnMethod":{"description":"An enumeration value that indicates the alternative methods for a full refund when an item is returned. This column will have data if the seller offers the buyer an item replacement or exchange instead of a monetary refund. For implementation help, refer to eBay API documentation","type":"string"},"returnPeriodUnit":{"description":"An enumeration value that indicates the period of time being used to measure the duration, such as business days, months, or years.

TimeDurationUnitEnum is a common type shared by multiple eBay APIs and fields to express the time unit, but for return period duration, this value will always be DAY. For implementation help, refer to eBay API documentation","type":"string"},"returnPeriodValue":{"description":"The amount of days that the buyer has to return the item after the purchase date. For example, if this value is '30', the return period is 30 days.","type":"integer"},"returnShippingCostPayer":{"description":"The party responsible for the return shipping costs when an item is returned.

Valid Values: BUYER or SELLER

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"returnsAccepted":{"description":"Indicates whether the seller accepts returns for the item.","type":"boolean"},"sellerAccountType":{"description":"A string value that specifies whether the seller is a business or an individual. This is determined when the seller registers with eBay. If the seller registers for a business account, the value returned in this field will be BUSINESS. If the seller registers for a private account, the value returned in this field will be INDIVIDUAL.

Note: This designation is required by the tax laws in some countries.

This field is returned only on the following sites: EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, and EBAY_PL.

Code so that your app gracefully handles any future changes to this list.

Valid Values: BUSINESS or INDIVIDUAL","type":"string"},"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: This ID is changed only when the seller makes a change to the item.","type":"string"},"sellerTrustLevel":{"description":"An enumeration value representing the eBay status of the seller.

Valid Values: TOP_RATED, ABOVE_STANDARD, or an empty value.

An empty value indicates a return of anything other than TOP_RATED or ABOVE_STANDARD.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"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 (restrict) the shipToIncludedRegions list. The COUNTRY: list is separated from the REGION: list with a semicolon (;).

Format Example:
COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;

Country Values: The two-letter ISO 3166 standard code of the country.

Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE

Code so that your app gracefully handles any future changes to this list.","type":"string"},"shipToIncludedRegions":{"description":"A pipe (|) separated alphabetical list of the geographic countries and regions where the seller will ship the item.

If a region is specified, you will need to subtract any countries and regions returned in the shipToExcludedRegions column to fully understand where the seller will ship.

The COUNTRY: list is separated from the REGION: list with a semicolon (;).

Format Example:
COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;

Country Values: The two-letter ISO 3166 standard code of the country.

Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE

Code so that your app gracefully handles any future changes to this list.","type":"string"},"shippingCarrierCode":{"description":"The name of the shipping provider, such as FedEx, or USPS.","type":"string"},"shippingCost":{"description":"The final shipping cost for all the items after all discounts are applied.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.","type":"string"},"shippingCostType":{"description":"Indicates the class of the shipping cost.

Valid Values: FIXED or CALCULATED.","type":"string"},"shippingServiceCode":{"description":"The type of shipping service. For example, USPS First Class.","type":"string"},"shippingType":{"description":"The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.","type":"string"},"size":{"description":"The size of the item.","type":"string"},"takeBackPolicyDescription":{"description":"The seller-defined description of the TAKE_BACK custom policy for the item.","type":"string"},"takeBackPolicyLabel":{"description":"The seller-defined label of the TAKE_BACK custom policy for the item. A TAKE_BACK policy describes the seller's regulatory responsibility to take back a purchased item for disposal when the buyer purchases a new one.","type":"string"},"title":{"description":"The seller created title of the item. This text is an escaped string when special characters are present, using the following rules:

For example

Before:

Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\Tracking

Marvel Legends HULK 8" Figure Avengers Age of Ultron Studios 6" Series

After:

"Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\\ Tracking"

"Marvel Legends HULK 8\" Figure Avengers Age of Ultron Studios 6\" Series"

","type":"string"},"totalUnits":{"description":"For an item that is priced by the unit, the total number of units that are on offer. For example, if the item is priced by the meter and 50 cm is on offer, the totalUnits would be 0.5 m.","type":"string"},"tyreLabelImageUrl":{"description":"The URL to the image that shows the information on the tyre label.","type":"string"},"unitPrice":{"description":"This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices.

For example:

\"unitPricingMeasure\": \"100g\",
\"unitPrice\": {
  \"value\": \"7.99\",
  \"currency\": \"GBP\"","type":"string"},"unitPricingMeasure":{"description":"The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices.

For example, the following tells the buyer that the item is 7.99 per 100 grams.

\"unitPricingMeasure\": \"100g\",
\"unitPrice\": {
  \"value\": \"7.99\",
  \"currency\": \"GBP\"","type":"string"},"weightUnitOfMeasure":{"description":"The unit of measurement used for the package weight, such as POUND, KILOGRAM, OUNCE, or GRAM.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"}},"type":"object"},"ItemGroup":{"description":"The type that defines the columns returned in the Item Group feed file.","properties":{"additionalImageUrls":{"description":"A pipe separated (|) list of URLs for the additional images for the item group. 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"},"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. The other images of the item group are returned in the additionalImageUrls column.","type":"string"},"itemGroupId":{"description":"The unique identifier for the item group. This ID is returned in the primaryItemGroupId column of the Item Feed file.","type":"string"},"itemGroupType":{"description":"The item group type. For example: 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"},"title":{"description":"The seller created title of the item group. This text is an escaped string when special characters are present, using the following rules:

For example

Before:

Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\Tracking

Marvel Legends HULK 8" Figure Avengers Age of Ultron Studios 6" Series

After:

"Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\\ Tracking"

"Marvel Legends HULK 8\" Figure Avengers Age of Ultron Studios 6\" Series"

","type":"string"},"variesByLocalizedAspects":{"description":"A pipe separated (|) list of the aspect (variation) names for this item group. The aspect name is BASE64 encoded. Note: This column can contain multiple values.

   Encoded Format:
   aspectName|aspectName

   Encoded Example (The delimiters are emphasized):
   Q29sb3I=|U2l6ZQ==

   Decoded:
   Color|Size

","type":"string"}},"type":"object"},"ItemGroupResponse":{"description":"The type that defines the array for the items returned in the Item Group feed file.","properties":{"itemGroups":{"description":"The container for the array of items groups returned by the getItemGroupFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values for each item. The header labels match the fields that are described in the Response fields section.","items":{"$ref":"#/components/schemas/ItemGroup"},"type":"array"}},"type":"object"},"ItemPriority":{"properties":{"changeMetadata":{"description":"Status change indicator of the listing.

Values: Note: When a listing is removed from the campaign, PriorityListingPayload will be empty.

When multiple status changes are returned for a listing, the changeMetadata value will be a pipe-separated string (e.g., ADDED_TO_CAMPAIGN|TRACKING_PAYLOAD_REFRESHED).

To use the returned value, you will need to separate the string by pipe (|).","type":"string"},"itemId":{"description":"The unique identifier of an item in eBay RESTful format. An example would be v1|1********2|4********2.","type":"string"},"priorityListingPayload":{"description":"EPN (eBay Partner Network) publishers append this value to their affiliate tracking URL when using an EPN tracking link to track changes that occur to Priority Listing items.

Example:_trkparms=ispr%3D1&amdata=enc%3AAQAFAAAAkB1DmsmXf%2BqZ%2BCEMGdebW6oR75GCMdBmc4MCQ%2FCEPqgKHbT0jdWhPwfY5LdUs6HTaP0eBlwKE7Smy2eDslewF7l3xjwWxjqwzNAnsYgxn2PiGkTKbiQSQytFUiymdtANpk1qOnBOoMGMK%2BWsji7jYlvySSs9o9s24TxD6RqWZpNrltzOU7mfnv3H40SZ3YESzg%3D%3D

See Creating an EPN Tracking Link for information on EPN tracking links.","type":"string"}},"type":"object"},"ItemPriorityResponse":{"properties":{"itemDelta":{"description":"The container for the array of items returned by the getItemPriorityFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values on each line. The header labels match the fields that are described in the Response fields section.","items":{"$ref":"#/components/schemas/ItemPriority"},"type":"array"}},"type":"object"},"ItemResponse":{"description":"The type that defines the array for the items returned in the Item feed file. ","properties":{"items":{"description":"The container for the array of items returned by the getItemFeed method. The data in the file is tab separated and the first row is the header, which labels the columns and indicates the order of the values on each line. The header labels match the fields that are described in the Response fields section.","items":{"$ref":"#/components/schemas/Item"},"type":"array"}},"type":"object"},"ItemSnapshot":{"description":"The type that defines the columns returned in the Hourly Snapshot feed file.

Note: When the value of the availability column is UNAVAILABLE, only the itemId and availability columns are populated.

","properties":{"acceptedPaymentMethods":{"description":"This field is returned empty. For a list of payment methods available for a marketplace, see eBay help pages or the actual View Item page.","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"},"additionalShippingCostPerUnit":{"description":"Any per item additional shipping costs for a multi-item purchase. For example, let's say the shipping cost for a power cord is $3. But for an additional cord, the shipping cost is only $1. So if you bought 3 cords, the shippingCost would be $3 and this value would be $2 ($1 for each additional item).","type":"string"},"ageGroup":{"description":"The age group that the product is recommended for.

Valid values: newborn, infant, toddler, kids, adult.","type":"string"},"alerts":{"description":"A pipe-separated list of alerts available for the item.

For example, if the DELAYED_DELIVERY alert was returned for an item, it would indicate a delay in shipping by the seller.","type":"string"},"authenticityGuaranteeFeeCurrency":{"description":"The currency used for the Authenticity Guarantee service fee.","type":"string"},"authenticityGuaranteeFeeValue":{"description":"The price of the Authenticity Guarantee service for the item.

Note: The price returned in this field indicates the service fee for a single item quantity.","type":"string"},"authenticityGuaranteeSelection":{"description":"An indication of whether the Authenticity Guarantee service is optional or mandatory for the item. For implementation help, refer to eBay API documentation","type":"string"},"authenticityGuaranteeServiceId":{"description":"The unique identifier for the Authenticity Guarantee service associated with the item.","type":"string"},"availability":{"description":"An enumeration value representing the item's availability (possibility of being purchased).

Values: Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"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":{"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 MORE_THAN. This indicates that the seller has more than the 'Display Item Quantity', which is 10, in stock for this item.

The following are the Display Item Quantity preferences the seller can set.

Code so that your app gracefully handles any future changes to these preferences. For implementation help, refer to eBay API documentation","type":"string"},"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. Currently the only supported option is FIXED_PRICE.","type":"string"},"category":{"description":"The label of the category of the item. 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"},"changeMetadata":{"description":"Status change indicator of the listing.

Values: ","type":"string"},"color":{"description":"The color of the item.","type":"string"},"condition":{"description":"The text describing the condition of the item, such as New or Used. For a list of condition names, see Item Condition IDs and Names.","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"},"couponDiscountCurrency":{"description":"The currency used to specify the coupon discount value.","type":"string"},"couponDiscountType":{"description":"The type of discount that the coupon applies.

Note: If all coupon fields return null values, it indicates that the item never had a coupon, or that the coupon has been removed. Please ensure that you update your inventory accordingly.","type":"string"},"couponDiscountValue":{"description":"The discount amount after the coupon is applied.","type":"string"},"couponExpirationDate":{"description":"The expiration date for the coupon.

Format: UTC yyyy-MM-ddThh:mm:ss.sssZ","type":"string"},"couponMessage":{"description":"A description of the coupon.","type":"string"},"couponRedemptionCode":{"description":"The redemption code for the coupon.","type":"string"},"couponTermsWebUrl":{"description":"The URL to the coupon terms of use.","type":"string"},"defaultImageUrl":{"description":"URL to the gallery or default image of the item. The other images of the item are returned in the additionalImageUrls field.

For example

https://i.ebayimg.com/00/s/M********w/z/W********p/$_1.JPG?set_id=8********F","type":"string"},"deliveryOptions":{"description":"A comma-separated list of available delivery options. This column lets you filter out items than cannot be shipped to the buyer.

Valid Values: SHIP_TO_HOME, SELLER_ARRANGED_LOCAL_PICKUP, IN_STORE_PICKUP, and PICKUP_DROP_OFF.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"description":{"description":"The seller created description of the item.

For example:

Brand-new, unused, and unworn. Not in original packaging.","type":"string"},"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"},"ecoParticipationFeeCurrency":{"description":"The currency in which the Eco Participation Fee for the item is paid.","type":"string"},"ecoParticipationFeeValue":{"description":"The amount of the Eco Participation Fee, a fee paid toward the eventual disposal of the purchased item.","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"},"gender":{"description":"In cases where items could vary by gender, this specifies for which gender the product is intended. Possible values include male, female, and unisex.","type":"string"},"gtin":{"description":"The unique Global Trade Item Number of the item as defined by https://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"},"hazmatAdditionalInformation":{"description":"Base64 encoded additional information about the hazardous material.","type":"string"},"hazmatPictogramDescriptions":{"description":"The base64 encoded descriptions of hazardous material pictograms, separated by the pipe symbol. For example:

encoded(exploding bomb)|encoded(flame)","type":"string"},"hazmatPictogramIds":{"description":"The IDs of hazardous material pictograms, separated by the pipe symbol. For example:

SGH01|SGH02","type":"string"},"hazmatPictogramImageUrls":{"description":"The image URLs of hazardous material pictograms, separated by the pipe symbol. For example:

https://img1|https://img2","type":"string"},"hazmatSignalWord":{"description":"The localized signal word for the hazardous material, such as 'Danger'.","type":"string"},"hazmatSignalWordId":{"description":"The ID of the signal word for the hazardous material.","type":"string"},"hazmatStatementDescriptions":{"description":"The base64 encoded descriptions of hazardous material statements, separated by the pipe symbol. For example:

encoded(Unstable explosives)|encoded(Flammable gas)","type":"string"},"hazmatStatementIds":{"description":"The IDs of hazardous material statements, separated by the pipe symbol. For example:

H200|H221","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"},"inferredEpid":{"description":"The ePID (eBay Product ID of a product in the eBay product catalog) for the item, which has been programmatically determined by eBay using the item's title, aspects, and other data.

If the seller actually provided an ePID at listing time for the item, the ePID value is returned in the epid column instead.","type":"string"},"itemAffiliateWebUrl":{"description":"The URL of the View Item page of the item, with the affiliate tracking ID appended to it.

For example

https://www.ebay.de/itm/2********0?mkevt=1&mkcid=1&mkrid=707-53477-19255-0&campid=CAMPAIGNID&toolid=2***6&customid=CUSTOMID","type":"string"},"itemCreationDate":{"description":"A timestamp indicating when the item was created.

Format: UTC yyyy-MM-ddThh:mm:ss.sssZ","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 an item in eBay RESTful format. An example would be v1|1**********2|4**********2.","type":"string"},"itemLocationCountry":{"description":"The country where the item is physically located.","type":"string"},"itemSnapshotDate":{"description":"This timestamp denotes the date and time the changes for that item were picked up and added to the snapshot feed file.

For example, let's say you have a snapshot feed file and also ran the getItem method. When you compare the same item information from the two sources, you see that the price in the getItem method response is different from the price in the snapshot feed file. By knowing the date and time you submitted the getItem method, you can use the itemSnapshotDate data to determine which price is the most current for this item.

Format: UTC yyyy-MM-ddThh:mm:ss.sssZ","type":"string"},"itemWebUrl":{"description":"The URL of the View Item page of the item.

For example:

Single SKU:
https://www.ebay.de/itm/2********0

MSKU:
https://www.ebay.com/itm/2********9?var=5********2","type":"string"},"legacyItemId":{"description":"The unique identifier of the eBay listing that contains the item. This is the traditional/legacy ID that is often seen in the URL of the listing View Item page.","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 (The delimiters are emphasized):
   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 (The delimiters are emphasized):
   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"},"lotSize":{"description":"The number of items in a lot. In other words, a lot size is the number of items that are being sold together.

A lot is a set of two or more items included in a single listing that must be purchased together in a single order line item. All the items in the lot are the same but there can be multiple items in a single lot, such as the package of batteries shown in the example below.

Item Lot Definition Lot Size
A package of 24 AA batteries A box of 10 packages 10
A P235/75-15 Goodyear tire 4 tires 4
Fashion Jewelry Rings Package of 100 assorted rings 100


Note: Lots are not supported in all categories. ","type":"integer"},"material":{"description":"The material that the item is made of.","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":{"description":"The currency of the originalPriceValue of the item and the discountAmount. For implementation help, refer to eBay API documentation","type":"string"},"originalPriceValue":{"description":"The original selling price of the item. This lets you surface a strikethrough price for the item. ","type":"string"},"pattern":{"description":"(Primary Item Aspect) Text describing the pattern used on the item. For example, paisley.

Note: All the item aspects, including this aspect, are returned in the localizedAspects container.","type":"string"},"priceCurrency":{"description":"The currency used for the price of the item. Generally, this is the currency used by the country of the eBay site offering the item. For implementation help, refer to eBay API documentation","type":"string"},"priceValue":{"description":"The price of the item, which can be a discounted price.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.","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, such as EBAY_PLUS and AUTHENTICITY_GUARANTEE.

eBay Plus is a premium account option for buyers, which provides benefits such as fast free domestic shipping and free returns on selected items. Top-Rated eBay sellers must opt in to eBay Plus to be able to offer the program on qualifying listings. Sellers must commit to next-day delivery of those items. Note: eBay Plus is available only to buyers in Germany, Austria, and Australia marketplaces.

The eBay Authenticity Guarantee program enables third-party authenticators to perform authentication verification inspections on items such as watches and sneakers.","type":"string"},"quantityUsedForEstimate":{"description":"The number of items used when calculating the shipping estimation information.","type":"integer"},"refundMethod":{"description":"An enumeration value representing how a buyer is refunded when an item is returned.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"repairScore":{"description":"A score that describes how easy it is to repair the product. Score values range from 0.1 (hardest to repair) to 10.0 (easiest), always including a single decimal place.

Note: Support for this field is currently limited to the France marketplace.","type":"string"},"returnMethod":{"description":"An enumeration value that indicates the alternative methods for a full refund when an item is returned. This column will have data if the seller offers the buyer an item replacement or exchange instead of a monetary refund. For implementation help, refer to eBay API documentation","type":"string"},"returnPeriodUnit":{"description":"An enumeration value that indicates the period of time being used to measure the duration, such as business days, months, or years.

TimeDurationUnitEnum is a common type shared by multiple eBay APIs and fields to express the time unit, but for return period duration, this value will always be DAY. For implementation help, refer to eBay API documentation","type":"string"},"returnPeriodValue":{"description":"The amount of days that the buyer has to return the item after the purchase date. For example, if this value is 30, the return period is 30 days.","type":"integer"},"returnShippingCostPayer":{"description":"An enumeration value that indicates the party responsible for the return shipping costs when an item is returned.

Valid Values: BUYER or SELLER

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"returnsAccepted":{"description":"Indicates whether the seller accepts returns for the item.","type":"boolean"},"sellerAccountType":{"description":"A string value that specifies whether the seller is a business or an individual. This is determined when the seller registers with eBay. If the seller registers for a business account, the value returned in this field will be BUSINESS. If the seller registers for a private account, the value returned in this field will be INDIVIDUAL.

Note: This designation is required by the tax laws in some countries.

This field is returned only on the following sites: EBAY_AT, EBAY_BE, EBAY_CH, EBAY_DE, EBAY_ES, EBAY_FR, EBAY_GB, EBAY_IE, EBAY_IT, and EBAY_PL.

Code so that your app gracefully handles any future changes to this list.

Valid Values: BUSINESS or INDIVIDUAL","type":"string"},"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: This ID is changed only when the seller makes a change to the item.","type":"string"},"sellerTrustLevel":{"description":"An enumeration value representing the eBay status of the seller.

Valid Values: TOP_RATED, ABOVE_STANDARD, or an empty value.

An empty value indicates a return of anything other than TOP_RATED or ABOVE_STANDARD.

Code so that your app gracefully handles any future changes to this list. For implementation help, refer to eBay API documentation","type":"string"},"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 (restrict) the shipToIncludedRegions list.

The COUNTRY: list is separated from the REGION: list with a semicolon (;).

Format Example:
COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;

Country Values: The two-letter ISO 3166 standard code of the country.

Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE

Code so that your app gracefully handles any future changes to this list.","type":"string"},"shipToIncludedRegions":{"description":"A pipe (|) separated alphabetical list of the geographic countries and regions where the seller will ship the item.

If a region is specified, you will need to subtract any countries and regions returned in the shipToExcludedRegions column to fully understand where the seller will ship.

The COUNTRY: list is separated from the REGION: list with a semicolon (;).

Format Example:
COUNTRY:US|BM|GL|MX|PM;REGION:AFRICA|ASIA|CENTRAL_AMERICA_AND_CARIBBEAN|EUROPE|MIDDLE_EAST|OCEANIA|SOUTH_AMERICA|SOUTHEAST_ASIA;

Country Values: The two-letter ISO 3166 standard code of the country.

Region Values: AFRICA, AMERICAS, ANTARCTIC, ARCTIC, ASIA, AUSTRALIA, CENTRAL_AMERICA_AND_CARIBBEAN, EUROPE, EURO_UNION, GREATER_CHINA, MIDDLE_EAST, NORTH_AMERICA, OCEANIA, REST_OF_ASIA, SOUTHEAST_ASIA, SOUTH_AMERICA, WORLDWIDE

Code so that your app gracefully handles any future changes to this list.","type":"string"},"shippingCarrierCode":{"description":"The name of the shipping provider, such as FedEx, or USPS.","type":"string"},"shippingCost":{"description":"The final shipping cost for all the items after all discounts are applied.

Note: The price includes the value-added tax (VAT) for applicable jurisdictions when requested from supported marketplaces. In this case, users must pass the X-EBAY-C-MARKETPLACE-ID request header specifying the supported marketplace (such as EBAY_GB) to see the VAT-inclusive pricing. For more information on VAT, refer to VAT Obligations in the EU.","type":"string"},"shippingCostType":{"description":"Indicates the class of the shipping cost.

Valid Values: FIXED or CALCULATED

Code so that your app gracefully handles any future changes to this list. ","type":"string"},"shippingServiceCode":{"description":"The type of shipping service. For example, USPS First Class.","type":"string"},"shippingType":{"description":"The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc.","type":"string"},"size":{"description":"The size of the item.","type":"string"},"takeBackPolicyDescription":{"description":"The seller-defined description of the TAKE_BACK custom policy for the item.","type":"string"},"takeBackPolicyLabel":{"description":"The seller-defined label of the TAKE_BACK custom policy for the item. A TAKE_BACK policy describes the seller's regulatory responsibility to take back a purchased item for disposal when the buyer purchases a new one.","type":"string"},"title":{"description":"The seller created title of the item. This text is an escaped string when special characters are present, using the following rules:

For example

Before:

Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\Tracking

Marvel Legends HULK 8" Figure Avengers Age of Ultron Studios 6" Series

After:

"Misty Rainforest Modern Masters 2017 MTG Magic Fetch Land Free Ship W\\ Tracking"

"Marvel Legends HULK 8\" Figure Avengers Age of Ultron Studios 6\" Series"

","type":"string"},"totalUnits":{"description":"For an item that is priced by the unit, the total number of units that are on offer. For example, if the item is priced by the meter and 50 cm is on offer, the totalUnits would be 0.5 m.","type":"string"},"tyreLabelImageUrl":{"description":"The URL to the image that shows the information on the tyre label.","type":"string"},"unitPrice":{"description":"This is the price per unit for the item. Some European countries require listings for certain types of products to include the price per unit so buyers can accurately compare prices.

For example:

\"unitPricingMeasure\": \"100g\",
\"unitPrice\": {
  \"value\": \"7.99\",
  \"currency\": \"GBP\"","type":"string"},"unitPricingMeasure":{"description":"The designation, such as size, weight, volume, count, etc., that was used to specify the quantity of the item. This helps buyers compare prices.

For example, the following tells the buyer that the item is 7.99 per 100 grams.

\"unitPricingMeasure\": \"100g\",
\"unitPrice\": {
  \"value\": \"7.99\",
  \"currency\": \"GBP\"","type":"string"}},"type":"object"},"ItemSnapshotResponse":{"description":"The type that defines the array for the items returned in the Hourly Snapshot feed file.","properties":{"items":{"description":"The container for the array of items returned by the getItemSnapshotFeed method.

Note: When the value of the availability column is UNAVAILABLE, only the itemId and availability columns are populated.

","items":{"$ref":"#/components/schemas/ItemSnapshot"},"type":"array"}},"type":"object"}},"securitySchemes":{"Client_Credentials":{"description":"The security definitions for this API. Please check individual operations for applicable scopes.","flows":{"clientCredentials":{"scopes":{"https://api.ebay.com/oauth/api_scope/buy.item.feed":"View curated feeds of eBay items"},"tokenUrl":"https://api.ebay.com/identity/v1/oauth2/token"}},"type":"oauth2"}}}}