feed APIv1_beta.15.0

getItemGroupFeed

GET
/item_group

This method lets you download a TSV_GZIP (tab separated value gzip) Item Group feed file. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.

There are two types of item group feed files generated:

  • A daily Item Group feed file containing the item group variation information associated with items returned in the Item feed file for a specific day, category, and marketplace. (feed_scope = NEWLY_LISTED)
  • A weekly Item Group Bootstrap feed file containing all the item group variation information associated with items returned in the Item Bootstrap feed file for all the items in a specific category. (feed_scope = ALL_ACTIVE)

Note: Filters are applied to the feed files. For details, see Feed File Filters. When curating the items returned, be sure to code as if these filters are not applied as they can be changed or removed in the future.

The contents of these feed files are based on the contents of the corresponding daily Item or Item Bootstrap feed file. When a new Item or Item Bootstrap feed file is generated, the service reads the file and if an item in the file has a primaryItemGroupId value, which indicates the item is part of an item group, it uses that value to return the item group (parent item) information for that item in the corresponding Item Group or Item Group Bootstrap feed file.

This information includes the name/value pair of the aspects of the items in this group returned in the variesByLocalizedAspects column. For example, if the item was a shirt some of the variation names could be Size, Color, etc. Also the images for the various aspects are returned in the additionalImageUrls column.

The first line in any feed file is the header, which labels the columns and indicates the order of the values on each line. Each header is described in the Response fields section.

Combining the Item Group and Item feed files

The Item Group or Item Group Bootstrap feed file contains details about the item group (parent item), including the item group ID itemGroupId. You match the value of itemGroupId from the Item Group feed file with the value of primaryItemGroupId from the corresponding daily Item or Item Bootstrap feed file.

URLs for this method

  • Production URL: https://api.ebay.com/buy/feed/v1_beta/
  • Sandbox URL: https://api.sandbox.ebay.com/buy/feed/v1_beta/

Downloading feed files

Item Group feed files are binary gzip files. If the file is larger than 100 MB, the download must be streamed in chunks. You specify the size of the chunks in bytes using the Range request header. The content-range response header indicates where in the full resource this partial chunk of data belongs and the total number of bytes in the file. For more information about using these headers, see Retrieving a gzip feed file.

Note: The response is always only a TSV_GZIP file. However for documentation purposes, the response is shown as JSON fields so that the value returned in each column can be explained. The order of the response fields, shows you the order of the columns in the feed file.

Restrictions

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

Input

Resource URI (production)

GET https://api.ebay.com/buy/feed/v1_beta/item_group?

URI parameters

ParameterTypeDescription
datestring The date of the daily Item Group feed file (feed_scope=NEWLY_LISTED) you want.

The date is required only for the daily Item Group feed file. If you specify a date for the Item Group Bootstrap file (feed_scope=ALL_ACTIVE), the date is ignored and the latest file is returned. The date the Item Group Bootstrap feed file was generated is returned in the Last-Modified response header.

The Item Group feed files are generated every day and there are always 14 files available.

There is a 48 hour latency when generating the files. This means on July 10, the latest feed file you can download is July 8.

Note: The generated files are stored using MST (US Mountain Standard Time), which is -7 hours UTC time.

Format: yyyyMMdd

Requirement: Requirements:
  • Required only when feed_scope=NEWLY_LISTED
  • Must be within 3-14 days in the past

Occurrence: Optional

category_idstringAn eBay top-level category ID of the items to be returned in the feed file.

The list of eBay category IDs changes over time and category IDs are not the same across all the eBay marketplaces. To get a list of the top-level categories for a marketplaces, you can use the Taxonomy API getCategoryTree method. This method retrieves the complete category tree for the marketplace. The top-level categories are identified by the categoryTreeNodeLevel field.

For example:
  "categoryTreeNodeLevel": 1

For details see Get Categories for Buy APIs.

Restriction: Must be a top-level category

Occurrence: Required

feed_scopestringSpecifies the type of file to return.

Valid Values:
  • NEWLY_LISTED - Returns the Item Group feed file containing the item group variation information for items in the daily Item feed file that were associated with an item group.

    The items in this type of Item feed file are items that were listed on the day specified by the date parameter in the category specified by the category_id parameter.

    The items will be Good 'Til Cancelled and non-Good 'Til Cancelled items. If the item is a non-Good 'Til Cancelled item, the item's end date will be returned in the itemEndDate column.

    /item_group?feed_scope=NEWLY_LISTED&category_id=15032&date=20170925
  • ALL_ACTIVE - Returns the weekly Item Group Bootstrap file containing the item group variation information for items in the weekly Item Bootstrap feed file that were associated with an item group. The items are 'Good 'Til Cancelled' items in the category specified by the category_id parameter.

    Note: Bootstrap files are generated every Tuesday and the file is available on Wednesday. However, the exact time the file is available can vary so we recommend you download the Bootstrap file on Thursday. The item groups in the file are for the items that were in the specified category on Sunday.

    /item_group?feed_scope=ALL_ACTIVE&category_id=15032

    Occurrence: Required

HTTP request headers

All requests made to eBay REST operations require you to provide the Authorization HTTP header for authentication authorization.

HeaderTypeDescription
RangestringThis header specifies the range in bytes of the chunks of the gzip file being returned.

Format: bytes=startpos-endpos

For example, the following retrieves the first 10 MBs of the feed file.

  Range bytes=0-10485760

For more information about using this headers, see Retrieving a gzip feed file.

Maximum: 100 MB (10MB in the Sandbox)

Occurrence: Strongly Recommended

X-EBAY-C-MARKETPLACE-IDstringThe ID of the eBay marketplace where the item is hosted. Note: This value is case sensitive.

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

For a list of supported sites see, API Restrictions.

Occurrence: Required

OAuth scope

This request requires an access token created with the client credentials grant flow, using one scope from the following list:

https://api.ebay.com/oauth/api_scope/buy.item.feed

See OAuth access tokens for more information.

Output

HTTP response headers

See HTTP response headers for details.

HeaderMeaning
Content-rangeThe 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-ModifiedReturns 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

Important: The response of this call is always a TSV_GZIP file. However, the response is shown as JSON fields for each column so that the value returned in each column can be explained. The order in which the response fields are listed is the order of the columns in the feed file.

Output container/fieldTypeDescription
itemGroupsarray of ItemGroupThe 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.

Occurrence: Always

itemGroups.itemGroupIdstringThe unique identifier for the item group. This ID is returned in the primaryItemGroupId column of the Item Feed file.

Occurrence: Always

itemGroups.itemGroupTypestringThe 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.

Occurrence: Always

itemGroups.titlestringThe seller created title of the item group. This text is an escaped string when special characters are present, using the following rules:

  • Double quotes (") and backslashes (\) in the Title are escaped with a backslash (\) character
  • If there are any tabs (\t), double quotes ("), or backslashes (\) in the Title, the entire Title will be wrapped in double quotes.

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"

Occurrence: Always

itemGroups.variesByLocalizedAspectsstringA 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 empathized):
   Q29sb3I=|U2l6ZQ==

   Decoded:
   Color|Size

Occurrence: Always

itemGroups.imageUrlstringThe URL to the primary image of the item. The other images of the item group are returned in the additionalImageUrls column.

Occurrence: Always

itemGroups.additionalImageUrlsstringA 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.

Occurrence: Conditional

itemGroups.imageAlteringProhibitedbooleanA 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.

Occurrence: Always

HTTP status codes

This call can return one of the following HTTP status codes. For an overview of the status codes, see HTTP status codes in Using eBay RESTful APIs.

StatusMeaning
200Success
204No Content
This code is returned when there are no items that meet the criteria for this feed file. See Feed File Filters for details.
206Partial Content
400Bad request
404Not found
416Range not satisfiable
500Internal server error

Error codes

For more on errors, plus the codes of other common errors, see Handling errors.

CodeDomainCategoryMeaning
13000API_FEEDREQUESTThe request contains data that is invalid. Correct the request and submit the call again. For help, see the API Reference documentation for this call.
13003API_FEEDREQUESTThe 'feed_scope' {feed_scope} submitted is invalid. Valid values: {feedScopes}
13004API_FEEDREQUESTThe 'category_id' {category_id} submitted is invalid. See the API documentation for help on how to find category IDs.
13005API_FEEDREQUESTThe 'date' {date} submitted is invalid. The date can be 3 to 9 days in the past. The format is yyyyMMdd.
13006API_FEEDAPPLICATIONThere 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.
13007API_FEEDREQUESTThe 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.
13009API_FEEDREQUESTThe mandatory 'feed_scope' query parameter is missing. Valid values: {feedScopes}
13010API_FEEDREQUESTThe mandatory 'category_id' query parameter is missing.
13011API_FEEDREQUESTThe mandatory 'date' query parameter is missing. Valid values: {earliestDate} to {latestDate} days in the past. The format is yyyyMMdd.
13012API_FEEDREQUESTThe marketplace Id {marketplaceId} is invalid. Valid values: {allowedMarketplaces}
13013API_FEEDREQUESTThe mandatory 'X-EBAY-C-MARKETPLACE-ID' header is missing. Valid values: {allowedMarketplaces}
13014API_FEEDREQUESTThe marketplace Id {marketplaceId} is not supported. Valid values: {allowedMarketplaces}
13015API_FEEDREQUESTThe mandatory 'Range' request header is missing. For help, see the API Reference documentation for this call.
13016API_FEEDREQUESTThe 'Range' request header format is invalid. Format: 'bytes=start position-end position'. For help, see the API Reference documentation for this call.
13017API_FEEDREQUESTThe 'Range' header is invalid. Please verify that the start and end positions are correct. For help, see the API Reference documentation for this call.
13018API_FEEDREQUESTThe start position in the range header is invalid.
13019API_FEEDREQUESTThe end position in the range header is invalid.
13022API_FEEDREQUESTThe 'category_id' {category_id} submitted is not supported.

Samples

New to making API calls? Please see Making a Call.

Note: Identifiers, such as order IDs or user IDs, and personal data in these samples might be anonymized or may no longer be active on eBay. If necessary, substitute current, relevant eBay data in your requests.

Sample 1: Download the Daily Item Group Feed File

This sample returns a GZIP file containing the item group information for items in the Item feed (September 18, 2017 in the Cameras & Photo category) that were associated with an item group.

Input

The inputs are feed_scope=NEWLY_LISTED and category_id URI parameters.

The request parameters are: Range bytes=0-10485760 and X-EBAY-C-MARKETPLACE-ID EBAY_US. For more information about using these headers, see HTTP request headers.
GET
https://api.ebay.com/buy/feed/v1_beta/item_group?feed_scope=NEWLY_LISTED&category_id=625&date=20180418

Output

If the call is successful, the portion of the file specified by the Range header, is returned. The call returns a 206 HTTP status and the Content-range bytes=0-10485760/251658240 response header.

Sample 2: Download the Weekly Bootstrap Item Group Feed File

This sample returns the latest weekly Item Group Bootstrap feed file. It contains the item group variation information for the items in the corresponding Item Bootstrap feed file that were associated with an item group.

Note: Bootstrap files are generated every Tuesday and the file is available on Wednesday. However, the exact time the file is available can vary so we recommend you download the Bootstrap file on Thursday. The item groups in the file are for the items that were in the specified category on Sunday.

Input

The inputs are feed_scope=ALL_ACTIVE, category_id, and date URI parameters.

The request parameters are: Range bytes=0-10485760 and X-EBAY-C-MARKETPLACE-ID EBAY_US. For more information about using these headers, see HTTP request headers.
GET
https://api.ebay.com/buy/feed/v1_beta/item_group?feed_scope=ALL_ACTIVE&category_id=625

Output

If the call is successful, the portion of the file specified by the Range header, is returned. The call returns a 206 HTTP status and the Content-range bytes=0-10485760/251658240 response header.

Note: You can use the Feed SDK to download the entire entire file and you can also apply filters.