openapi: 3.0.0 info: title: Item Feed Service description: Note: This is a Limited Release(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.

contact: name: eBay Inc, license: name: eBay API License Agreement url: https://go.developer.ebay.com/api-license-agreement version: v1_beta.35.2 servers: - url: https://api.ebay.com{basePath} description: Production variables: basePath: default: /buy/feed/v1_beta paths: /item: get: tags: - item 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.
Note:The downloaded file will be gzipped automatically, so there is no reason to supply Accept-Encoding:gzip as a header. If this header is supplied, the downloaded file will be compressed twice, and this has no extra benefit.

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 Retrieve 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: - name: Accept in: header 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 required: true schema: type: string - name: X-EBAY-C-MARKETPLACE-ID in: header description: 'The ID of the eBay marketplace where the item is hosted. This value is case sensitive.

For example:
  X-EBAY-C-MARKETPLACE-ID = EBAY_US

For a list of supported sites see, API Restrictions.' required: true schema: type: string - name: Range in: header 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) required: true schema: type: string - name: feed_scope in: query description: 'This query parameter specifies the type of feed file to return.

Valid Values: ' required: true schema: type: string - name: category_id in: query description: 'This query parameter specifies the 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.' required: true schema: type: string - name: date in: query description: 'This query parameter specifies the date of the daily Item feed file (feed_scope=NEWLY_LISTED) you want to retrieve.

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: The daily Item feed files are available each day after 9AM MST (US Mountain Standard Time), which is -7 hours UTC time.

There is a 48 hour latency when generating the Item feed files. This means you can download the file for July 10th on July 12 after 9AM MST.

For categories with a large number of items, the latency can be up to 72 hours.

Format: yyyyMMdd

Requirements: ' required: false schema: type: string responses: '200': description: Success headers: Content-range: schema: type: string 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.' Last-Modified: schema: type: string 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 content: text/tab-separated-values: schema: $ref: '#/components/schemas/ItemResponse' '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': description: Partial Content headers: Content-range: schema: type: string 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.' Last-Modified: schema: type: string 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 content: text/tab-separated-values: schema: $ref: '#/components/schemas/ItemResponse' '400': description: Bad request x-response-codes: errors: '13000': domain: API_FEED 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. '13003': domain: API_FEED category: REQUEST description: 'The ''feed_scope'' {feed_scope} submitted is invalid. Valid values: {feedScopes}' '13004': domain: API_FEED category: REQUEST description: The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs. '13005': domain: API_FEED 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.' '13007': domain: API_FEED 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. '13009': domain: API_FEED category: REQUEST description: 'The mandatory ''feed_scope'' query parameter is missing. Valid values: {feedScopes}' '13010': domain: API_FEED category: REQUEST description: The mandatory 'category_id' query parameter is missing. '13011': domain: API_FEED category: REQUEST description: 'The mandatory ''date'' query parameter is missing. Valid values: {earliestDate} to {latestDate} days in the past. The format is yyyyMMdd.' '13012': domain: API_FEED category: REQUEST description: 'The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}' '13013': domain: API_FEED category: REQUEST description: 'The mandatory ''X-EBAY-C-MARKETPLACE-ID'' header is missing. Valid values: {allowedMarketplaces}' '13014': domain: API_FEED category: REQUEST description: 'The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}' '13015': domain: API_FEED category: REQUEST description: The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call. '13016': domain: API_FEED 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.' '13017': domain: API_FEED 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. '13018': domain: API_FEED category: REQUEST description: The start position in the range header is invalid. '13019': domain: API_FEED category: REQUEST description: The end position in the range header is invalid. '13022': domain: API_FEED category: REQUEST description: The 'category_id' {category_id} submitted is not supported. '403': description: Forbidden x-response-codes: errors: '13023': domain: API_FEED category: BUSINESS description: Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical Support for further assistance. '13024': domain: API_FEED category: BUSINESS description: Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical Support for further assistance. '404': description: Not found '409': description: Conflict '416': description: Range not satisfiable '500': description: Internal Server Error x-response-codes: errors: '13006': domain: API_FEED 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. security: - api_auth: - https://api.ebay.com/oauth/api_scope/buy.item.feed /item_group: get: tags: - item_group 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.
Note:The downloaded file will be gzipped automatically, so there is no reason to supply Accept-Encoding:gzip as a header. If this header is supplied, the downloaded file will be compressed twice, and this has no extra benefit.
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 Retrieve 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: - name: Accept in: header 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 required: true schema: type: string - name: X-EBAY-C-MARKETPLACE-ID in: header description: 'The ID of the eBay marketplace where the item is hosted. This value is case sensitive.

For example:
  X-EBAY-C-MARKETPLACE-ID = EBAY_US

For a list of supported sites see, API Restrictions.' required: true schema: type: string - name: Range in: header 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) required: false schema: type: string - name: feed_scope in: query description: 'This query parameter 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.' required: true schema: type: string - name: date in: query description: ' This query parameter specifies 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: ' required: false schema: type: string responses: '200': description: Success headers: Content-range: schema: type: string 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.' Last-Modified: schema: type: string 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 content: text/tab-separated-values: schema: $ref: '#/components/schemas/ItemGroupResponse' '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': description: Partial Content headers: Content-range: schema: type: string 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.' Last-Modified: schema: type: string 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 content: text/tab-separated-values: schema: $ref: '#/components/schemas/ItemGroupResponse' '400': description: Bad Request x-response-codes: errors: '13000': domain: API_FEED 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. '13003': domain: API_FEED category: REQUEST description: 'The ''feed_scope'' {feed_scope} submitted is invalid. Valid values: {feedScopes}' '13004': domain: API_FEED category: REQUEST description: The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs. '13005': domain: API_FEED 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.' '13007': domain: API_FEED 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. '13009': domain: API_FEED category: REQUEST description: 'The mandatory ''feed_scope'' query parameter is missing. Valid values: {feedScopes}' '13010': domain: API_FEED category: REQUEST description: The mandatory 'category_id' query parameter is missing. '13011': domain: API_FEED category: REQUEST description: 'The mandatory ''date'' query parameter is missing. Valid values: {earliestDate} to {latestDate} days in the past. The format is yyyyMMdd.' '13012': domain: API_FEED category: REQUEST description: 'The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}' '13013': domain: API_FEED category: REQUEST description: 'The mandatory ''X-EBAY-C-MARKETPLACE-ID'' header is missing. Valid values: {allowedMarketplaces}' '13014': domain: API_FEED category: REQUEST description: 'The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}' '13015': domain: API_FEED category: REQUEST description: The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call. '13016': domain: API_FEED 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.' '13017': domain: API_FEED 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. '13018': domain: API_FEED category: REQUEST description: The start position in the range header is invalid. '13019': domain: API_FEED category: REQUEST description: The end position in the range header is invalid. '13022': domain: API_FEED category: REQUEST description: The 'category_id' {category_id} submitted is not supported. '403': description: Forbidden x-response-codes: errors: '13023': domain: API_FEED category: BUSINESS description: Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical Support for further assistance. '13024': domain: API_FEED category: BUSINESS description: Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical Support for further assistance. '404': description: Not found '409': description: Conflict '416': description: Range not satisfiable '500': description: Internal Server Error x-response-codes: errors: '13006': domain: API_FEED 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. security: - api_auth: - https://api.ebay.com/oauth/api_scope/buy.item.feed /item_snapshot: get: tags: - item_snapshot 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.
Note:The downloaded file will be gzipped automatically, so there is no reason to supply Accept-Encoding:gzip as a header. If this header is supplied, the downloaded file will be compressed twice, and this has no extra benefit.

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: - name: Accept in: header 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 required: true schema: type: string - name: X-EBAY-C-MARKETPLACE-ID in: header description: 'The ID of the eBay marketplace where the item is hosted. This value is case sensitive.

For example:
  X-EBAY-C-MARKETPLACE-ID = EBAY_US

For a list of supported sites see, API Restrictions.' required: true schema: type: string - name: Range in: header 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) required: true schema: type: string - name: category_id in: query description: 'This query parameter specifies the 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.' required: true schema: type: string - name: snapshot_date in: query description: 'This query parameter specifies the date and hour of the snapshot feed file you want to retrieve.

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

Note: Files are generated on the hour, so minutes and seconds are always zeros.' required: true schema: type: string responses: '200': description: Success headers: Content-range: schema: type: string 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.' Last-Modified: schema: type: string 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 content: text/tab-separated-values: schema: $ref: '#/components/schemas/ItemSnapshotResponse' '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': description: Partial Content headers: Content-range: schema: type: string 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.' Last-Modified: schema: type: string 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 content: text/tab-separated-values: schema: $ref: '#/components/schemas/ItemSnapshotResponse' '400': description: Bad Request x-response-codes: errors: '13000': domain: API_FEED 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. '13004': domain: API_FEED category: REQUEST description: The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs. '13007': domain: API_FEED 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. '13010': domain: API_FEED category: REQUEST description: The mandatory 'category_id' query parameter is missing. '13012': domain: API_FEED category: REQUEST description: 'The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}' '13013': domain: API_FEED category: REQUEST description: 'The mandatory ''X-EBAY-C-MARKETPLACE-ID'' header is missing. Valid values: {allowedMarketplaces}' '13014': domain: API_FEED category: REQUEST description: 'The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}' '13015': domain: API_FEED category: REQUEST description: The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call. '13016': domain: API_FEED 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.' '13017': domain: API_FEED 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. '13018': domain: API_FEED category: REQUEST description: The start position in the range header is invalid. '13019': domain: API_FEED category: REQUEST description: The end position in the range header is invalid. '13020': domain: API_FEED category: REQUEST description: The mandatory 'snapshot_date' query parameter is missing. '13021': domain: API_FEED category: REQUEST description: The 'snapshot_date' query parameter is invalid.Valid format is 'yyyy-MM-ddTHH:mm:ss' '13022': domain: API_FEED category: REQUEST description: The 'category_id' {category_id} submitted is not supported. '403': description: Forbidden x-response-codes: errors: '13023': domain: API_FEED category: BUSINESS description: Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical Support for further assistance. '13024': domain: API_FEED category: BUSINESS description: Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical Support for further assistance. '404': description: Not found '409': description: Conflict '416': description: Range not satisfiable '500': description: Internal server error x-response-codes: errors: '13006': domain: API_FEED 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. security: - api_auth: - https://api.ebay.com/oauth/api_scope/buy.item.feed /item_priority: get: tags: - item_priority 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.


Note: The downloaded file will be gzipped automatically, so there is no reason to supply Accept-Encoding:gzip as a header. If this header is supplied, the downloaded file will be compressed twice, and this has no extra benefit.

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 Retrieve 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: - name: Accept in: header 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 required: true schema: type: string - name: X-EBAY-C-MARKETPLACE-ID in: header description: 'The ID of the eBay marketplace where the item is hosted. 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.' required: true schema: type: string - name: Range in: header description: 'Header specifying content range to be retrieved. Only supported range is bytes.

Example : bytes = 0-102400.' required: true schema: type: string - name: category_id in: query description: 'This query parameter specifies the 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.' required: true schema: type: string - name: date in: query description: 'This query parameter specifies 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: The daily Item feed files are available each day after 9AM MST (US Mountain Standard Time), which is -7 hours UTC time.

There is a 48 hour latency when generating the Item feed files. This means you can download the file for July 10th on July 12 after 9AM MST.

For categories with a large number of items, the latency can be up to 72 hours.' required: true schema: type: string responses: '200': description: Success headers: Content-range: schema: type: string 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.' Last-Modified: schema: type: string description: 'Signifies the date when the files are generated. For example : Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT.' content: text/tab-separated-values: schema: $ref: '#/components/schemas/ItemPriorityResponse' '204': description: No Content '206': description: Partial Content headers: Content-range: schema: type: string 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.' Last-Modified: schema: type: string description: 'Signifies the date when the files are generated. For example : Last-Modified: Wed, 21 Oct 2015 07:28:00 GMT.' content: text/tab-separated-values: schema: $ref: '#/components/schemas/ItemPriorityResponse' '400': description: Bad Request x-response-codes: errors: '13000': domain: API_FEED 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. '13004': domain: API_FEED category: REQUEST description: The 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs. '13005': domain: API_FEED 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.' '13010': domain: API_FEED category: REQUEST description: The mandatory 'category_id' query parameter is missing. '13011': domain: API_FEED category: REQUEST description: 'The mandatory ''date'' query parameter is missing. Valid values: {earliestDate} to {latestDate} days in the past. The format is yyyyMMdd.' '13012': domain: API_FEED category: REQUEST description: 'The marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}' '13013': domain: API_FEED category: REQUEST description: 'The mandatory ''X-EBAY-C-MARKETPLACE-ID'' header is missing. Valid values: {allowedMarketplaces}' '13014': domain: API_FEED category: REQUEST description: 'The marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}' '13015': domain: API_FEED category: REQUEST description: The mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call. '13016': domain: API_FEED 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.' '13018': domain: API_FEED category: REQUEST description: The start position in the range header is invalid. '13019': domain: API_FEED category: REQUEST description: The end position in the range header is invalid. '13022': domain: API_FEED category: REQUEST description: The 'category_id' {category_id} submitted is not supported. '403': description: Forbidden x-response-codes: errors: '13023': domain: API_FEED category: BUSINESS description: Insufficient permissions to access this API for the marketplace {marketplaceId}. Please contact eBay Technical support for further assistance. '13024': domain: API_FEED category: BUSINESS description: Insufficient permissions to access this API for the category {category_id}. Please contact eBay Technical support for further assistance. '404': description: Not found x-response-codes: errors: '13007': domain: API_FEED 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. '409': description: Conflict '416': description: Range not satisfiable x-response-codes: errors: '13017': domain: API_FEED 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. '500': description: Internal server error x-response-codes: errors: '13006': domain: API_FEED 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. security: - api_auth: - https://api.ebay.com/oauth/api_scope/buy.item.feed components: schemas: Error: type: object properties: category: type: string description: Identifies the type of erro. domain: type: string description: Name for the primary system where the error occurred. This is relevant for application errors. errorId: type: integer description: A unique number to identify the error. format: int32 inputRefIds: type: array description: An array of request elements most closely associated to the error. items: type: string longMessage: type: string description: A more detailed explanation of the error. message: type: string description: Information on how to correct the problem, in the end user's terms and language where applicable. outputRefIds: type: array description: An array of request elements most closely associated to the error. items: type: string parameters: type: array description: An array of name/value pairs that describe details the error condition. These are useful when multiple errors are returned. items: $ref: '#/components/schemas/ErrorParameter' subdomain: type: string description: 'Further helps indicate which subsystem the error is coming from. System subcategories include: Initialization, Serialization, Security, Monitoring, Rate Limiting, etc.' description: This type defines the fields that can be returned in an error. ErrorParameter: type: object properties: name: type: string description: The object of the error. value: type: string description: The value of the object. Item: type: object properties: itemId: type: string description: The unique identifier of an item in eBay RESTful format. An example would be v1|1**********2|4**********2. title: type: string 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"

imageUrl: type: string 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. category: type: string description: 'The label of the category. For example: Toys & Hobbies|Action Figures|Comic Book Heroes ' categoryId: type: string description: 'The ID of the category of the item. For example: The ID for Toys & Hobbies|Action Figures|Comic Book Heroes is 158671.' buyingOptions: type: string description: 'A comma separated list of the purchase options available for the item. Currently the only supported option is FIXED_PRICE.

Important! This field no longer returns values and is scheduled for deprecation.

' sellerUsername: type: string description: The seller's eBay user name. sellerFeedbackPercentage: type: string description: The percentage of the seller's total positive feedback. sellerFeedbackScore: type: string description: The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. gtin: type: string 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. brand: type: string description: The name brand of the item, such as Nike, Apple, etc. mpn: type: string description: The manufacturer part number, which is a number that is used in combination with brand to identify a product. epid: type: string 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. conditionId: type: string 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. condition: type: string description: The text describing the condition of the item. For a list of condition names, see Item Condition IDs and Names. priceValue: type: string 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.' priceCurrency: type: string 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 primaryItemGroupId: type: string 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. primaryItemGroupType: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

' itemEndDate: type: string 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' sellerItemRevision: type: string 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.' itemLocationCountry: type: string description: The country where the item is physically located. localizedAspects: type: string 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.

' sellerTrustLevel: type: string 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 availability: type: string 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' imageAlteringProhibited: type: boolean 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.

' estimatedAvailableQuantity: type: integer description: The estimated quantity of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.

Note: If the seller of an item has the available threshold setting turned on, the value of this field will be null, and the availability of the item will instead be expressed through the availabilityThresholdType and availabilityThreshold fields. format: int32 availabilityThresholdType: type: string description: This column has a value only when the seller sets their availability threshold preference. The value of this column will show MORE_THAN, which indicates that the seller has more than the available threshold preference in stock for this item. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity.

Note: This field and the availabilityThreshold field will be returned as null if the actual quantity meets or drops below the threshold value, and then the buyer will want to look at the value in the estimatedAvailableQuantity field. For implementation help, refer to eBay API documentation availabilityThreshold: type: integer description: This column has a value only when the seller sets their availability threshold preference. The value of this column will be "10", which is the threshold value.

Note: This field and the availabilityThresholdType field will be returned as null if the actual quantity meets or drops below the threshold value, and then the buyer will want to look at the value in the estimatedAvailableQuantity field. format: int32 returnsAccepted: type: boolean description: Indicates whether the seller accepts returns for the item. returnPeriodValue: type: integer 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. format: int32 returnPeriodUnit: type: string 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 refundMethod: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

For implementation help, refer to eBay API documentation' returnMethod: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

For implementation help, refer to eBay API documentation' returnShippingCostPayer: type: string 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' acceptedPaymentMethods: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

' deliveryOptions: type: string 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' shipToIncludedRegions: type: string 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.' shipToExcludedRegions: type: string 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.' inferredEpid: type: string 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. inferredGtin: type: string 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. inferredBrand: type: string 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. inferredMpn: type: string 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. inferredLocalizedAspects: type: string 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.

' additionalImageUrls: type: string 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.' originalPriceValue: type: string description: 'The original selling price of the item. This lets you surface a strikethrough price for the item. ' originalPriceCurrency: type: string description: The currency of the originalPriceValue of the item and the discountAmount. For implementation help, refer to eBay API documentation discountAmount: type: string 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.

' discountPercentage: type: string description: The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20. energyEfficiencyClass: type: string 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. qualifiedPrograms: type: string description: 'A pipe separated list of the qualified programs available for the item.

Valid Values:
' lotSize: type: integer 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. ' format: int32 lengthUnitOfMeasure: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

For implementation help, refer to eBay API documentation' packageWidth: type: string description: 'The width of the shipping package that contains the item.

Important! This field no longer returns values and is scheduled for deprecation.

' packageHeight: type: string description: 'The height of the shipping package that contains the item.

Important! This field no longer returns values and is scheduled for deprecation.

' packageLength: type: string description: 'The length of the shipping package that contains the item.

Important! This field no longer returns values and is scheduled for deprecation.

' weightUnitOfMeasure: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

For implementation help, refer to eBay API documentation' packageWeight: type: string description: 'The weight of the package that contains the item.

Important! This field no longer returns values and is scheduled for deprecation.

' shippingCarrierCode: type: string description: 'The name of the shipping provider, such as FedEx, or USPS.

Important! This field no longer returns values and is scheduled for deprecation.

' shippingServiceCode: type: string description: 'The type of shipping service. For example, USPS First Class.

Important! This field no longer returns values and is scheduled for deprecation.

' shippingType: type: string description: The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc. shippingCost: type: string 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.' shippingCostType: type: string description: 'Indicates the class of the shipping cost.

Valid Values: FIXED or CALCULATED.' additionalShippingCostPerUnit: type: string 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).

Important! This field no longer returns values and is scheduled for deprecation.

' quantityUsedForEstimate: type: integer description: 'The number of items used when calculating the estimation information.

Important! This field no longer returns values and is scheduled for deprecation.

' format: int32 unitPrice: type: string 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"
' unitPricingMeasure: type: string 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"
' legacyItemId: type: string 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. alerts: type: string 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. sellerAccountType: type: string 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' tyreLabelImageUrl: type: string description: The URL to the image that shows the information on the tyre label. priorityListingPayload: type: string 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. itemCreationDate: type: string description: 'A timestamp indicating when the item was created.

Format: UTC yyyy-MM-ddThh:mm:ss.sssZ' itemWebUrl: type: string 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 defaultImageUrl: type: string 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 itemAffiliateWebUrl: type: string 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 ageGroup: type: string description: The age group that the product is recommended for.

Valid values: newborn, infant, toddler, kids, adult. color: type: string description: The color of the item. pattern: type: string 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. size: type: string description: The size of the item. gender: type: string 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. material: type: string description: The material that the item is made of. totalUnits: type: string 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. ecoParticipationFeeValue: type: string description: The amount of the Eco Participation Fee, a fee paid toward the eventual disposal of the purchased item. ecoParticipationFeeCurrency: type: string description: The currency in which the Eco Participation Fee for the item is paid. takeBackPolicyLabel: type: string 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. takeBackPolicyDescription: type: string description: The seller-defined description of the TAKE_BACK custom policy for the item. hazmatSignalWordId: type: string description: The ID of the signal word for the hazardous material. hazmatSignalWord: type: string description: The localized signal word for the hazardous material, such as 'Danger'. hazmatStatementIds: type: string description: 'The IDs of hazardous material statements, separated by the pipe symbol. For example:

H200|H221' hazmatStatementDescriptions: type: string description: 'The Base64 encoded descriptions of hazardous material statements, separated by the pipe symbol. For example:

encoded(Unstable explosives)|encoded(Flammable gas)' hazmatPictogramIds: type: string description: 'The IDs of hazardous material pictograms, separated by the pipe symbol. For example:

SGH01|SGH02' hazmatPictogramDescriptions: type: string description: 'The Base64 encoded descriptions of hazardous material pictograms, separated by the pipe symbol. For example:

encoded(exploding bomb)|encoded(flame)' hazmatPictogramImageUrls: type: string description: 'The image URLs of hazardous material pictograms, separated by the pipe symbol. For example:

https://img1|https://img2' hazmatAdditionalInformation: type: string description: Base64 encoded additional information about the hazardous material. repairScore: type: string 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. conditionDescriptors: type: string description: 'Note: Condition descriptors are currently only available for the following trading card categories:
This field contains a list of the name/value pairs for the condition descriptors of the item, which are Base64 encoded. The descriptors are separated as follows: Note: The separators ( : ; | ) are not encoded. You must decode each name, and value or values separately. You cannot decode the entire string.
The name and value are numeric IDs that map to the name and value, respectively, of a condition descriptor. A condition descriptor name-value pair provides more information about an item''s condition in a structured way. Descriptors are name-value attributes that can be either from a closed set or open text. For more information on the numeric IDs and their text equivalents, use the getItemConditionPolicies method of the Metadata API.' sellerUserId: type: string description: The unique identifier of an eBay user across all eBay sites. This value does not change, even when a user changes their username. description: The type that defines the columns returned in the Item feed file. ItemGroup: type: object properties: itemGroupId: type: string description: The unique identifier for the item group. This ID is returned in the primaryItemGroupId column of the Item Feed file. itemGroupType: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

' title: type: string 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"

variesByLocalizedAspects: type: string 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

' imageUrl: type: string description: The URL to the primary image of the item. The other images of the item group are returned in the additionalImageUrls column. additionalImageUrls: type: string 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.' imageAlteringProhibited: type: boolean 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.

' description: The type that defines the columns returned in the Item Group feed file. ItemGroupResponse: type: object properties: itemGroups: type: array 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' description: The type that defines the array for the items returned in the Item Group feed file. ItemPriority: type: object properties: itemId: type: string description: The unique identifier of an item in eBay RESTful format. An example would be v1|1********2|4********2. priorityListingPayload: type: string 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. changeMetadata: type: string 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 (|). ItemPriorityResponse: type: object properties: itemDelta: type: array 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' ItemResponse: type: object properties: items: type: array 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' description: 'The type that defines the array for the items returned in the Item feed file. ' ItemSnapshot: type: object properties: itemId: type: string description: The unique identifier of an item in eBay RESTful format. An example would be v1|1**********2|4**********2. availability: type: string 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' title: type: string 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"

imageUrl: type: string 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. ' category: type: string description: 'The label of the category of the item. For example: Toys & Hobbies|Action Figures|Comic Book Heroes . ' categoryId: type: string description: 'The ID of the category of the item. For example: The ID for Toys & Hobbies|Action Figures|Comic Book Heroes is 158671.' buyingOptions: type: string description: 'A comma separated list of the purchase options available for the item. Currently the only supported option is FIXED_PRICE.

Important! This field no longer returns values and is scheduled for deprecation.

' sellerUsername: type: string description: The seller's eBay user name. sellerFeedbackPercentage: type: string description: The percentage of the seller's total positive feedback. sellerFeedbackScore: type: string description: The feedback score of the seller. This value is based on the ratings from eBay members that bought items from this seller. gtin: type: string 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. brand: type: string description: The name brand of the item, such as Nike, Apple, etc. mpn: type: string description: The manufacturer part number, which is a number that is used in combination with brand to identify a product. epid: type: string 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. conditionId: type: string 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. condition: type: string 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. priceValue: type: string 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.' priceCurrency: type: string 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 primaryItemGroupId: type: string 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. primaryItemGroupType: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

' itemEndDate: type: string 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' sellerItemRevision: type: string 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.' itemLocationCountry: type: string description: The country where the item is physically located. localizedAspects: type: string 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.

' sellerTrustLevel: type: string 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 imageAlteringProhibited: type: boolean 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.

' estimatedAvailableQuantity: type: integer description: The estimated quantity of this item that are available for purchase. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity. So instead of returning quantity, the estimated availability of the item is returned.

Note: If the seller of an item has the available threshold setting turned on, the value of this field will be null, and the availability of the item will instead be expressed through the availabilityThresholdType and availabilityThreshold fields. format: int32 availabilityThresholdType: type: string description: This column has a value only when the seller sets their availability threshold preference. The value of this column will show MORE_THAN, which indicates that the seller has more than the available threshold preference in stock for this item. Because the quantity of an item can change several times within a second, it is very difficult to return the exact quantity.

Note: This field and the availabilityThreshold field will be returned as null if the actual quantity meets or drops below the threshold value, and then the buyer will want to look at the value in the estimatedAvailableQuantity field. For implementation help, refer to eBay API documentation availabilityThreshold: type: integer description: This column has a value only when the seller sets their availability threshold preference.

The value of this column will be "10", which is the threshold value.

Note: This field and the availabilityThresholdType field will be returned as null if the actual quantity meets or drops below the threshold value, and then the buyer will want to look at the value in the estimatedAvailableQuantity field. format: int32 itemSnapshotDate: type: string 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' originalPriceValue: type: string description: 'The original selling price of the item. This lets you surface a strikethrough price for the item. ' originalPriceCurrency: type: string description: The currency of the originalPriceValue of the item and the discountAmount. For implementation help, refer to eBay API documentation discountAmount: type: string 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. discountPercentage: type: string description: The calculated discount percentage. For example, if originalPriceValue is 70 and discountAmount is 14, this value will be 20. returnsAccepted: type: boolean description: Indicates whether the seller accepts returns for the item. returnPeriodValue: type: integer 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. format: int32 returnPeriodUnit: type: string 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 refundMethod: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

For implementation help, refer to eBay API documentation' returnMethod: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

For implementation help, refer to eBay API documentation' returnShippingCostPayer: type: string 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' energyEfficiencyClass: type: string 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. additionalImageUrls: type: string 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.' deliveryOptions: type: string 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' shipToIncludedRegions: type: string 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.' shipToExcludedRegions: type: string 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.' acceptedPaymentMethods: type: string 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.

Important! This field no longer returns values and is scheduled for deprecation.

' qualifiedPrograms: type: string 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.' lotSize: type: integer 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. ' format: int32 shippingCarrierCode: type: string description: 'The name of the shipping provider, such as FedEx, or USPS.

Important! This field no longer returns values and is scheduled for deprecation.

' shippingServiceCode: type: string description: 'The type of shipping service. For example, USPS First Class.

Important! This field no longer returns values and is scheduled for deprecation.

' shippingType: type: string description: The type of a shipping option, such as EXPEDITED, ONE_DAY, STANDARD, ECONOMY, PICKUP, etc. shippingCost: type: string 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.' shippingCostType: type: string 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. ' additionalShippingCostPerUnit: type: string 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).

Important! This field no longer returns values and is scheduled for deprecation.

' quantityUsedForEstimate: type: integer description: 'The number of items used when calculating the shipping estimation information.

Important! This field no longer returns values and is scheduled for deprecation.

' format: int32 unitPrice: type: string 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"
' unitPricingMeasure: type: string 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"
' inferredEpid: type: string 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. itemCreationDate: type: string description: 'A timestamp indicating when the item was created.

Format: UTC yyyy-MM-ddThh:mm:ss.sssZ' legacyItemId: type: string 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. alerts: type: string 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. sellerAccountType: type: string 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' tyreLabelImageUrl: type: string description: The URL to the image that shows the information on the tyre label. ageGroup: type: string description: The age group that the product is recommended for.

Valid values: newborn, infant, toddler, kids, adult. color: type: string description: The color of the item. pattern: type: string 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. size: type: string description: The size of the item. gender: type: string 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. material: type: string description: The material that the item is made of. totalUnits: type: string 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. defaultImageUrl: type: string 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 itemWebUrl: type: string 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 itemAffiliateWebUrl: type: string 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 description: type: string description: The seller created description of the item.

For example:

Brand-new, unused, and unworn. Not in original packaging. changeMetadata: type: string description: Status change indicator of the listing.

Values: ecoParticipationFeeValue: type: string description: The amount of the Eco Participation Fee, a fee paid toward the eventual disposal of the purchased item. ecoParticipationFeeCurrency: type: string description: The currency in which the Eco Participation Fee for the item is paid. takeBackPolicyLabel: type: string 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. takeBackPolicyDescription: type: string description: The seller-defined description of the TAKE_BACK custom policy for the item. authenticityGuaranteeServiceId: type: string description: The unique identifier for the Authenticity Guarantee service associated with the item. authenticityGuaranteeSelection: type: string description: An indication of whether the Authenticity Guarantee service is optional or mandatory for the item. For implementation help, refer to eBay API documentation authenticityGuaranteeFeeValue: type: string 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. authenticityGuaranteeFeeCurrency: type: string description: The currency used for the Authenticity Guarantee service fee. couponDiscountType: type: string description: The type of discount that the coupon applies. couponRedemptionCode: type: string description: The redemption code for the coupon. couponMessage: type: string description: A description of the coupon. couponTermsWebUrl: type: string description: The URL to the coupon terms of use. couponDiscountValue: type: string description: The discount amount after the coupon is applied. couponDiscountCurrency: type: string description: The currency used to specify the coupon discount value. couponExpirationDate: type: string description: 'The expiration date for the coupon.

Format: UTC yyyy-MM-ddThh:mm:ss.sssZ' hazmatSignalWordId: type: string description: The ID of the signal word for the hazardous material. hazmatSignalWord: type: string description: The localized signal word for the hazardous material, such as 'Danger'. hazmatStatementIds: type: string description: 'The IDs of hazardous material statements, separated by the pipe symbol. For example:

H200|H221' hazmatStatementDescriptions: type: string description: 'The Base64 encoded descriptions of hazardous material statements, separated by the pipe symbol. For example:

encoded(Unstable explosives)|encoded(Flammable gas)' hazmatPictogramIds: type: string description: 'The IDs of hazardous material pictograms, separated by the pipe symbol. For example:

SGH01|SGH02' hazmatPictogramDescriptions: type: string description: 'The Base64 encoded descriptions of hazardous material pictograms, separated by the pipe symbol. For example:

encoded(exploding bomb)|encoded(flame)' hazmatPictogramImageUrls: type: string description: 'The image URLs of hazardous material pictograms, separated by the pipe symbol. For example:

https://img1|https://img2' hazmatAdditionalInformation: type: string description: Base64 encoded additional information about the hazardous material. repairScore: type: string 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. conditionDescriptors: type: string description: 'Note: Condition descriptors are currently only available for the following trading card categories:
This field contains a list of the name/value pairs for the condition descriptors of the item, which are Base64 encoded. The descriptors are separated as follows: Note: The separators ( : ; | ) are not encoded. You must decode each name, and value or values separately. You cannot decode the entire string.

The name and value are numeric IDs that map to the name and value, respectively, of a condition descriptor. A condition descriptor name-value pair provides more information about an item''s condition in a structured way. Descriptors are name-value attributes that can be either from a closed set or open text. For more information on the numeric IDs and their text equivalents, use the getItemConditionPolicies method of the Metadata API.' sellerUserId: type: string description: The unique identifier for an eBay user across all eBay sites. This value does not change, even when a user changes their username. 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.

' ItemSnapshotResponse: type: object properties: items: type: array 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' description: The type that defines the array for the items returned in the Hourly Snapshot feed file. securitySchemes: api_auth: type: oauth2 description: The security definitions for this API. Please check individual operations for applicable scopes. flows: clientCredentials: tokenUrl: https://api.ebay.com/identity/v1/oauth2/token scopes: https://api.ebay.com/oauth/api_scope/buy.item.feed: View curated feeds of eBay items