CpqOptionGroupType

A set of options the shopper chooses from, which may itself hold further groups

type CpqOptionGroupType {
  id: String
  code: String
  name: String
  description: String
  available: Boolean!
  minSelections: Int
  maxSelections: Int
  minQuantity: Decimal
  maxQuantity: Decimal
  quantityEditable: Boolean!
  sortIndex: Int
  optionGroups: [CpqOptionGroupType]
  options: [CpqOptionType]
  messages: [CpqMessageType]
}

Fields

id ● String scalar

The option group id

code ● String scalar

The provider's own code for the group

name ● String scalar

The option group name, in the requested language

description ● String scalar

The option group description, in the requested language

available ● Boolean! non-null scalar required

'false' when the shopper's other choices rule this group out

minSelections ● Int scalar

How many options have to be selected

maxSelections ● Int scalar

How many options may be selected at once. One means the group is single-select.

minQuantity ● Decimal scalar

The lowest quantity an option in this group takes

maxQuantity ● Decimal scalar

The highest quantity an option in this group takes

quantityEditable ● Boolean! non-null scalar required

'true' when the shopper may set an option's quantity in this group

sortIndex ● Int scalar

Orders this group against every other member of the same parent, its sibling groups and, where the parent is a section, that section's variables and nested sections. Sort those on sortIndex, nulls last, and render them in that order. Null on every member means no order was reported, so keep the order the lists arrive in.

optionGroups ● [CpqOptionGroupType] list object

Option groups nested in this one

options ● [CpqOptionType] list object

The options in this group

messages ● [CpqMessageType] list object

Messages about this option group

Member Of

CpqOptionGroupType object ● CpqSectionType object