Grouped product data types
The GroupedProduct
data type implements ProductInterface
and PhysicalProductInterface
. As a result, attributes that are specific to grouped products can be used when performing a products
query.
GroupedProduct
The GroupedProduct
object contains the [items]
array:
Attribute | Type | Description |
---|---|---|
items |
[GroupedProductItem] | An array containing grouped product items |
GroupedProductItem
The GroupedProductItem
object contains the following attributes:
Attribute | Type | Description |
---|---|---|
position |
Int | The relative position of this item compared to the other group items |
product |
ProductInterface | The ProductInterface contains attributes that are common to all types of products. Note that descriptions may not be available for custom and EAV attributes |
qty |
Float | The quantity of this grouped product item |
Sample Query
The following query returns information about downloadable product 24-WG085_Group
, which is defined in the sample data.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
{
products(filter:
{sku: {eq: "24-WG085_Group"}}
)
{
items {
id
name
sku
__typename
... on GroupedProduct {
items{
qty
position
product{
sku
name
__typename
url_key
}
}
}
}
}
}
Response
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
{
"data": {
"products": {
"items": [
{
"id": 45,
"name": "Set of Sprite Yoga Straps",
"sku": "24-WG085_Group",
"__typename": "GroupedProduct",
"items": [
{
"qty": 0,
"position": 0,
"product": {
"sku": "24-WG085",
"name": "Sprite Yoga Strap 6 foot",
"__typename": "SimpleProduct",
"url_key": "sprite-yoga-strap-6-foot"
}
},
{
"qty": 0,
"position": 1,
"product": {
"sku": "24-WG086",
"name": "Sprite Yoga Strap 8 foot",
"__typename": "SimpleProduct",
"url_key": "sprite-yoga-strap-8-foot"
}
},
{
"qty": 0,
"position": 2,
"product": {
"sku": "24-WG087",
"name": "Sprite Yoga Strap 10 foot",
"__typename": "SimpleProduct",
"url_key": "sprite-yoga-strap-10-foot"
}
}
]
}
]
}
}
}