OrderItemGroup

Stores the group information for line items in an order. It also stores the aggregated line field information (subtotal). It contains a parent-child relationship to order. This object is available in API version 62.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), update(), upsert()

Special Access Rules

Fields

Field Details
Description
Type
string
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Description of the group.
EndDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reserved for future use.
Name
Type
string
Properties
Create, Filter, Group, idLookup, Sort, Update
Description
Name of the group.
OrderId
Type
reference
Properties
Create, Filter, Group, Sort
Description
ID of the order that this order product is a child of.
This field is a relationship field.
Relationship Name
Order
Relationship Type
Master-detail
Refers To
Order (the master object)
SegmentType
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The duration type of the segment. You can use this field from Revenue Cloud only when the Ramp Deals for Groups in Quotes and Orders setting is turned on.
Valid values are:
  • Custom—Available in API version 65.0 and later.
  • Prorated—Available in API version 67.0 and later.
  • Trial—Available in API version 67.0 and later.
  • Yearly—Available in API version 65.0 and later.
The default value is Yearly.
SortOrder
Type
int
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Number indicating the sort order selected by the user.
StartDate
Type
date
Properties
Create, Filter, Group, Nillable, Sort, Update
Description
Reserved for future use.
SummarySubtotal
Type
currency
Properties
Create, Filter, Nillable, Sort, Update
Description
The total amount of all the line items in the group.
Type
Type
picklist
Properties
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort, Update
Description
The type of the group.
Possible values are:
  • CPQOrderGroup—CPQ Line Grouping
The default value is CPQOrderGroup.
UnitPriceUplift
Type
percent
Properties
Create, Filter, Nillable, Sort, Update
Description
The percentage increase of the order item group's unit price.