--- title: "GET /item_group" method: GET path: "/item_group" tags: ["item_group"] --- # GET /item_group `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](/api-docs/buy/feed/resources/item/methods/getItemFeed) 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](/api-docs/buy/feed/resources/item/methods/getItemFeed) 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](/api-docs/buy/static/api-feed.html#feed-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](/api-docs/buy/feed/resources/item_group/methods/getItemGroupFeed#h3-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](#range-header) request header. The [content-range](#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](/api-docs/{swift-folder}/buy/static/api-feed_beta.html#retrv-gzip). **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](/api-docs/{swift-folder}/buy/feed/overview.html#API). ## Query parameters - `feed_scope` string, required - `category_id` string, required - `date` string ## Headers - `Accept` string, required - `X-EBAY-C-MARKETPLACE-ID` string, required - `Range` string ## Response `200` Partial Content - ItemGroupResponse — The type that defines the array for the items returned in the Item Group feed file. - `itemGroups` ItemGroup[] — 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. - `additionalImageUrls` string — 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` boolean — 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.

- `imageUrl` string — The URL to the primary image of the item. The other images of the item group are returned in the additionalImageUrls column. - `itemGroupId` string — The unique identifier for the item group. This ID is returned in the primaryItemGroupId column of the Item Feed file. - `itemGroupType` string — 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. - `title` string — 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` string — 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

## Other responses - `204` — 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` — Partial Content - `400` — Bad Request - `403` — Forbidden - `404` — Not found - `409` — Conflict - `416` — Range not satisfiable - `500` — Internal server error --- [API](https://skmtc.net/ebay/apis/buy-feed.md) · [All operations](https://skmtc.net/ebay/apis/buy-feed/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/ebay/buy-feed/versions/de3f4b3f2096/schema)