Skip to content
This repository was archived by the owner on Nov 19, 2024. It is now read-only.

GraphQL: Add uid for various products #7416

Merged
merged 14 commits into from
Aug 22, 2020
Merged

GraphQL: Add uid for various products #7416

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
7d41fd9
GraphQL: Add id_v2 for gift cards
keharper Jun 16, 2020
1f65d14
Add id_v2
keharper Jun 24, 2020
edea7ff
Merge branch '2.4.1-develop' of github.com:magento/devdocs into kh_gr…
keharper Jul 27, 2020
dd6a490
Changed attribute name to uid
keharper Jul 27, 2020
de29cee
Merge branch '2.4.1-develop' of github.com:magento/devdocs into kh_gr…
keharper Aug 6, 2020
cba1058
Merge branch '2.4.1-develop' of github.com:magento/devdocs into kh_gr…
keharper Aug 17, 2020
d539c50
Add uid to various product types
keharper Aug 17, 2020
dd8312e
Add CE product-related uid attributes
keharper Aug 19, 2020
b7174fd
Merge branch '2.4.1-develop' of github.com:magento/devdocs into kh_gr…
keharper Aug 19, 2020
7876e3e
more customization instances
keharper Aug 19, 2020
7d34f11
Update examples
keharper Aug 19, 2020
5decf8a
Add attribute to updateCartItems
keharper Aug 19, 2020
e7f6065
Removed attribute. Wrong branch
keharper Aug 19, 2020
c82d8d1
Merge branch '2.4.1-develop' into kh_graphql-giftcard-idv2
keharper Aug 22, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion src/guides/v2.4/graphql/product/bundle-product.md
View file
Open in desktop

This file was deleted.

317 changes: 317 additions & 0 deletions src/guides/v2.4/graphql/product/bundle-product.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,317 @@
---
group: graphql
title: Bundle product data types
---

The `BundleProduct` data type implements the following interfaces:

- `ProductInterface`
- `PhysicalProductInterface`
- `CustomizableProductInterface`

Attributes that are specific to bundle products can be used when performing a [`products`]({{page.baseurl}}/graphql/queries/products.html) query.

## BundleProduct object

The `BundleProduct` object contains the following attributes:

Attribute | Type | Description
--- | --- | ---
`dynamic_price` | Boolean | Indicates whether the bundle product has a dynamic price
`dynamic_sku` | Boolean | Indicates whether the bundle product has a dynamic SKU
`dynamic_weight` | Boolean | Indicates whether the bundle product has a dynamically calculated weight
`items` | [BundleItem] | An array containing information about individual bundle items
`price_view` | PriceViewEnum | One of PRICE_RANGE or AS_LOW_AS
`ship_bundle_items` | ShipBundleItemsEnum | Indicates whether to ship bundle items TOGETHER or SEPARATELY

## BundleItem object

The `BundleItem` object contains the following attributes:

Attribute | Type | Description
--- | --- | ---
`option_id` | Int | An ID assigned to each type of item in a bundle product
`options` | [BundleItemOption] | An array of additional options for this bundle item
`position` | Int | The relative position of this item compared to the other bundle items
`required` | Boolean | Indicates whether the item must be included in the bundle
`sku` | String | The SKU of the bundle product
`title` | String | The display name of the item
`type` | String | The input type that the customer uses to select the item. Examples include radio button and checkbox.

## BundleItemOption object

The `BundleItemOption` object contains the following attributes:

Attribute | Type | Description
--- | --- | ---
`can_change_quantity` | Boolean | Indicates whether the customer can change the number of items for this option
`id` | Int | The ID assigned to the bundled item option
`is_default` | Boolean | Indicates whether this option is the default option
`label` | String | The text that identifies the bundled item option
`position` | Int | When a bundle item contains multiple options, the relative position of this option compared to the other options
`price_type` | PriceTypeEnum | One of FIXED, PERCENT, or DYNAMIC
`price` | Float | The price of the selected option
`product` | [ProductInterface]({{page.baseurl}}/graphql/product/product-interface.html) | Contains details about this product option
`qty` | Float | Deprecated. Use `quantity` instead
`quantity` | Float | Indicates the quantity of this specific bundle item
`uid` | ID! | A string that encodes option details

## Sample Query

The following query returns information about bundle product `24-WG080`, which is defined in the sample data.

```graphql
{
products(filter: {sku:
{eq: "24-WG080"}
})
{
items{
sku
__typename
id
name
... on BundleProduct {
dynamic_sku
dynamic_price
dynamic_weight
price_view
ship_bundle_items
items {
option_id
title
required
type
position
sku
options {
id
uid
quantity
position
is_default
price
price_type
can_change_quantity
label
product {
id
name
sku
__typename
}
}
}
}
}
}
}
```

{% collapsible Response %}

```json
{
"data": {
"products": {
"items": [
{
"sku": "24-WG080",
"__typename": "BundleProduct",
"id": 46,
"name": "Sprite Yoga Companion Kit",
"dynamic_sku": true,
"dynamic_price": true,
"dynamic_weight": true,
"price_view": "PRICE_RANGE",
"ship_bundle_items": "TOGETHER",
"items": [
{
"option_id": 1,
"title": "Sprite Stasis Ball",
"required": true,
"type": "radio",
"position": 1,
"sku": "24-WG080",
"options": [
{
"id": 1,
"uid": "YnVuZGxlLzEvMS8x",
"quantity": 1,
"position": 1,
"is_default": true,
"price": 0,
"price_type": "FIXED",
"can_change_quantity": true,
"label": "Sprite Stasis Ball 55 cm",
"product": {
"id": 26,
"name": "Sprite Stasis Ball 55 cm",
"sku": "24-WG081-blue",
"__typename": "SimpleProduct"
}
},
{
"id": 2,
"uid": "YnVuZGxlLzEvMi8x",
"quantity": 1,
"position": 2,
"is_default": false,
"price": 0,
"price_type": "FIXED",
"can_change_quantity": true,
"label": "Sprite Stasis Ball 65 cm",
"product": {
"id": 29,
"name": "Sprite Stasis Ball 65 cm",
"sku": "24-WG082-blue",
"__typename": "SimpleProduct"
}
},
{
"id": 3,
"uid": "YnVuZGxlLzEvMy8x",
"quantity": 1,
"position": 3,
"is_default": false,
"price": 0,
"price_type": "FIXED",
"can_change_quantity": true,
"label": "Sprite Stasis Ball 75 cm",
"product": {
"id": 32,
"name": "Sprite Stasis Ball 75 cm",
"sku": "24-WG083-blue",
"__typename": "SimpleProduct"
}
}
]
},
{
"option_id": 2,
"title": "Sprite Foam Yoga Brick",
"required": true,
"type": "radio",
"position": 2,
"sku": "24-WG080",
"options": [
{
"id": 4,
"uid": "YnVuZGxlLzIvNC8x",
"quantity": 1,
"position": 1,
"is_default": true,
"price": 0,
"price_type": "FIXED",
"can_change_quantity": true,
"label": "Sprite Foam Yoga Brick",
"product": {
"id": 21,
"name": "Sprite Foam Yoga Brick",
"sku": "24-WG084",
"__typename": "SimpleProduct"
}
}
]
},
{
"option_id": 3,
"title": "Sprite Yoga Strap",
"required": true,
"type": "radio",
"position": 3,
"sku": "24-WG080",
"options": [
{
"id": 5,
"uid": "YnVuZGxlLzMvNS8x",
"quantity": 1,
"position": 1,
"is_default": true,
"price": 0,
"price_type": "FIXED",
"can_change_quantity": true,
"label": "Sprite Yoga Strap 6 foot",
"product": {
"id": 33,
"name": "Sprite Yoga Strap 6 foot",
"sku": "24-WG085",
"__typename": "SimpleProduct"
}
},
{
"id": 6,
"uid": "YnVuZGxlLzMvNi8x",
"quantity": 1,
"position": 2,
"is_default": false,
"price": 0,
"price_type": "FIXED",
"can_change_quantity": true,
"label": "Sprite Yoga Strap 8 foot",
"product": {
"id": 34,
"name": "Sprite Yoga Strap 8 foot",
"sku": "24-WG086",
"__typename": "SimpleProduct"
}
},
{
"id": 7,
"uid": "YnVuZGxlLzMvNy8x",
"quantity": 1,
"position": 3,
"is_default": false,
"price": 0,
"price_type": "FIXED",
"can_change_quantity": true,
"label": "Sprite Yoga Strap 10 foot",
"product": {
"id": 35,
"name": "Sprite Yoga Strap 10 foot",
"sku": "24-WG087",
"__typename": "SimpleProduct"
}
}
]
},
{
"option_id": 4,
"title": "Sprite Foam Roller",
"required": true,
"type": "radio",
"position": 4,
"sku": "24-WG080",
"options": [
{
"id": 8,
"uid": "YnVuZGxlLzQvOC8x",
"quantity": 1,
"position": 1,
"is_default": true,
"price": 0,
"price_type": "FIXED",
"can_change_quantity": true,
"label": "Sprite Foam Roller",
"product": {
"id": 22,
"name": "Sprite Foam Roller",
"sku": "24-WG088",
"__typename": "SimpleProduct"
}
}
]
}
]
}
]
}
}
}
```

{% endcollapsible %}

## Related topics

- [addBundleProductsToCart mutation]({{page.baseurl}}/graphql/mutations/add-bundle-products.html)
Loading