ItemSelectionOptions
Synopsis
struct ItemSelectionOptions {
boolean* wholeComposite;
boolean* subItems;
boolean* parentItems;
ViewId* viewId;
}
Is used to augment the list of items selected by the itemIds parameter (if not empty).
wholeComposite
If the wholeComposite attribute is present and true, the operation iterates over all selected items, and for each basket sub-article item adds the main article item to the list of selected items if it is not already an element of this list. Then, the operation iterates again over the resulting list (including elements added by this step), and for each basket article item adds all sub-article items if they are not already part of the list.
subItems
If the subItems attribute is present and true, the operation iterates over the list of items selected thus far and adds all direct and indirect sub-items if they are not already an element of the list.
parentItems
If the parentItems attribute is present and true, the operation iterates over the list of items selected thus far and adds all direct and indirect parent items if they are not already an element of the list.
viewId
This field is ignored by most operations that take a parameter of type ItemSelectionOptions, or one of its sub-types. However, the operations getAllItems, getItemProperties, getPriceCalculationSheet and getPriceCalculationSheets use this field to select a basket view and interpret item IDs passed to the operation as view item IDs instead of basket item IDs.
Operations that use this field behave as before if the field is missing, has an empty value, or has the NIL-UUID as its value. Otherwise the field’s value must be the ID of an existing basket view.