Description
The ComponentGroup object represents a group of related components in a New Product Bundle. Component groups define constraints such as minimum and maximum number of components that can be selected.
ℹ️ Note
This object supports custom data via the data attribute.
Attributes
| Attribute | Type | Description |
|---|---|---|
components |
List[ProductComponent] | Returns the ProductComponents in this group |
display_name |
String | Returns the customer-facing display name of this ComponentGroup |
id |
String | Returns the unique id of this ComponentGroup |
max_components |
Number | Returns the maximum number of different components allowed in this group |
max_group_quantity |
Number | Returns the maximum total quantity across all components in this group |
min_components |
Number | Returns the minimum number of different components required in this group |
min_group_quantity |
Number | Returns the minimum total quantity across all components in this group |
name |
String | Returns the internal name of this ComponentGroup |
optional? |
Boolean | Returns true if this ComponentGroup is optional |
position |
Number | Returns the display order position of this ComponentGroup |
required? |
Boolean | Returns true if this ComponentGroup is required to have selections |
single_choice? |
Boolean | Returns true if this ComponentGroup allows only one component selection |