eBay · Schema

ItemGroupSummary

The type that defines the fields for the details of each item in an item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the "parent". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc.

Note: This container is returned only if the item_id in the request is an item group (parent ID of an item with variations).

AuctionsCommerceProductsMarketplaceFortune 500

Properties

Name Type Description
itemGroupAdditionalImages array An array of containers with the URLs for images that are in addition to the primary image of the item group. The primary image is returned in the itemGroupImage field.
itemGroupHref string The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
itemGroupId string The unique identifier for the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
itemGroupImage object The URL of the primary image of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
itemGroupTitle string The title of the item that appears on the item group page. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc.
itemGroupType string An enumeration value that indicates the type of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. For implementation help, refer
View JSON Schema on GitHub

JSON Schema

ebay-itemgroupsummary-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ItemGroupSummary",
  "title": "ItemGroupSummary",
  "type": "object",
  "properties": {
    "itemGroupAdditionalImages": {
      "type": "array",
      "description": "An array of containers with the URLs for images that are in addition to the primary image of the item group.  The primary image is returned in the <b> itemGroupImage</b> field.",
      "items": {
        "$ref": "#/components/schemas/Image"
      }
    },
    "itemGroupHref": {
      "type": "string",
      "description": "The HATEOAS reference of the parent page of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. "
    },
    "itemGroupId": {
      "type": "string",
      "description": "The unique identifier for the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. "
    },
    "itemGroupImage": {
      "description": "The URL of the primary image of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. ",
      "$ref": "#/components/schemas/Image"
    },
    "itemGroupTitle": {
      "type": "string",
      "description": "The title of the item that appears on the item group page. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. "
    },
    "itemGroupType": {
      "type": "string",
      "description": "An enumeration value that indicates the type of the item group. An item group is an item that has various aspect differences, such as color, size, storage capacity, etc. For implementation help, refer to <a href='https://developer.ebay.com/api-docs/buy/browse/types/gct:ItemGroupTypeEnum'>eBay API documentation</a>"
    }
  },
  "description": "The type that defines the fields for the details of each item in an item group. An item group is  an item that has various aspect differences, such as color, size, storage capacity, etc. When an item group is created, one of the item variations, such as the red shirt size L, is chosen as the \"parent\". All the other items in the group are the children, such as the blue shirt size L, red shirt size M, etc. <br><br><span class=\"tablenote\"><b> Note: </b> This container is returned only if the <b> item_id</b> in the request is an item group (parent ID of an item with variations).</span>"
}