---
title: "getItemProperties"
slug: "api/basket/operations/getitemproperties"
sidebar:
  order: 446
---

<a id="ref-0443d746c320"></a>
<a id="ref-79c89109e0ff"></a>
<a id="ref-865300e101d8"></a>

## Synopsis

```text
ItemProperties[] getItemProperties(SessionId sessionId,
    BItemId[]          itemIds,
    GetItemPropertiesOptions options)
throws BasketServiceFault;
```

See also: [ItemProperties](/pCon/configuratorOnline/specs/api/basket/types/itemproperties#ref-8e7aae346f0f), [SessionId](/pCon/configuratorOnline/specs/api/session/types/sessionid#ref-02e397c8fdb4), [BItemId](/pCon/configuratorOnline/specs/api/basket/types/bitemid#ref-bccb6c926e5b), [GetItemPropertiesOptions](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties#ref-9f6740185de1), [BasketServiceFault](/pCon/configuratorOnline/specs/api/basket/faults/basketservicefault#ref-d5adb74faa1b)

<a id="ref-9f6740185de1"></a>

```text
struct GetItemPropertiesOptions : ItemSelectionOptions {
    DescrType[] tmDescrMode,
    string[] extraPriceInfoSelectors
    boolean priceInfo,
    string pricingProcedureName,
    boolean positionNumbers,
    boolean addStateCodes,
    GetItemPropertiesTextMode textMode,
    TextFormat? textFormat,
    boolean? preservePlainText,
    boolean? omitTMRows,
    boolean preferUserDescriptions,
    boolean separateCurrencies,
    boolean? includeCalculationErrorsInInconsistencies,
    boolean? nactivePositionState,
    boolean?  articleClassifications
}
```

See also: [ItemSelectionOptions](/pCon/configuratorOnline/specs/api/basket/types/itemselectionoptions#ref-96d714d65dbc), [DescrType](/pCon/configuratorOnline/specs/api/basket/types/descrtype#ref-6ea92a0017a1)

See also: [GetItemPropertiesTextMode](/pCon/configuratorOnline/specs/api/session/types/getitempropertiestextmode#ref-a5a0321eabf7)

The `getItemProperties` operation returns the item properties (not the OFML or OCD properties) of the basket items specified by the `itemIds` parameter. The basket items must be part of the basket item tree maintained by the basket service for the session identified by the `sessionId` parameter.

If `itemIds` parameter is an empty sequence, then the properties of all basket items will be returned. Otherwise, the sequence of returned [`ItemProperties`](/pCon/configuratorOnline/specs/api/basket/types/itemproperties) structures contains one entry for each passed item ID, with the order of returned `ItemProperties` structures equal to the order of passed item IDs.

Unless explicitly specified otherwise, all fields of the `ItemProperties` structures (§[ItemProperties](/pCon/configuratorOnline/specs/api/basket/types/itemproperties#ref-8e7aae346f0f)) returned by this operation, and all fields of the `FolderProperties` (§[FolderProperties](/pCon/configuratorOnline/specs/api/basket/types/folderproperties#ref-d11e577ce20b)) and `ArticleProperties` (§[ArticleProperties](/pCon/configuratorOnline/specs/api/basket/types/articleproperties#ref-6e1bbaf707f1)) structures referenced by the `ItemProperties` structure, are non-null.

The `folder` and `article` fields of the [`ItemProperties`](/pCon/configuratorOnline/specs/api/basket/types/itemproperties) structure are non-null if and only if the item is a folder (field `folder`) or an article (field `article`).

The `finalArticleNumber` and/or `variantCode` fields of the [`ArticleProperties`](/pCon/configuratorOnline/specs/api/basket/types/articleproperties) structure may be null if the Online Configurator failed to fetch their values from the product database.

The `currency`, `purchasePrice` and `salesPrice` fields of the [`ArticleProperties`](/pCon/configuratorOnline/specs/api/basket/types/articleproperties) structure may all be null if the Online Configurator failed to fetch either price from the product database.

The `options` parameter has no effect if the `itemIds` parameter is empty, as all items are selected in this case anyway. If the itemIds parameter is not empty, the list of selected items is determined as follows:

If the options parameter is missing (null), the list of selected items consists of one entry for each ID in itemIds, in the same order.

If the options parameter is present (non-null), the initial list of selected items consists of one entry for each ID in itemIds, in the same order.

The final order of selected items is determined by a pre-order traversal of the basket item hierarchy.

The option `viewId` of [`ItemSelectionOptions`](/pCon/configuratorOnline/specs/api/basket/types/itemselectionoptions) is supported by this operation. If it contains the ID of a view then the behavior of the operation is changed as follows:

- Item IDs passed with parameter `itemIds` are interpreted as IDs of items within this view.

- The options `parentItems` and `subItems`, if set, affect the selection of additional view items.

- Instances of [`ItemProperties`](/pCon/configuratorOnline/specs/api/basket/types/itemproperties) returned for view items

  - contain the view item ID instead of the basket item ID in field `itemId`,

  - do not contain fields `visible` and `expanded`,

  - contain the ID of the view item representing the set-article instead of the set-article’s basket item ID in field `setArticleId`,

  - use field `positionNumber` to return a position number, and

  - use field `composableGeometries` instead of `composableGeometry` to return composable geometry information.

- Instances of [`ArticleProperties`](/pCon/configuratorOnline/specs/api/basket/types/articleproperties) returned for view items differ from those instances returned for basket items as follows:

  - The `quantity` field contains the total quantity of all referenced basket article items in case of merged article view items.

  - The value of the `pricingProcedureName` option is used to determine the value of the deprecated `alternativePosition` field.

  - If the `priceInfo` option is `true`, the `priceInfo` field may be used to return price information obtained from the article item’s calculation named by option `pricingProcedureName`.

  - In case of merged article view items, fields `ofmlUpdateState` and `geometryId` return the value of one randomly chosen basket item. This behavior may change in future versions of EAIWS. Clients should use the geometry IDs returned by operation [`getAllItems`](/pCon/configuratorOnline/specs/api/basket/operations/getallitems) (with option `basketItems` set to `true`) instead of the geometry IDs returned by operation `getItemProperties`.

  - In case of item properties returned for article items of views with merge mode `Compact`, field `subArticles` may be used to return information of sub-articles folded into the view item that represents the whole composite article.

- Instances of [`SetArticleProperties`](/pCon/configuratorOnline/specs/api/basket/types/setarticleproperties) returned for view items differ from those instances returned for basket items as follows:

  - Field `collapsed` takes the set-article mode of the view into account. In case of `Expand` or `Collapse` the value will always be `false` or `true`, respectively. In case of `Dynamic` the value will be equal to the value returned for the basket’s set-article item[^1].

  - Returned set-article part IDs are IDs of view items, not basket item Ids.

- tmDescrMode - a possible empty list of [DescrType](/pCon/configuratorOnline/specs/api/basket/types/descrtype); If the list is not empty, a description composed from article text table texts is returned in element \<tmDescription\> of complex type [ItemProperties](/pCon/configuratorOnline/specs/api/basket/types/itemproperties). The description is built from non-empty texts in the article text table, in row order, except that texts that are marked as invisible and texts not selected by this option are skipped.

Type [`GetItemPropertiesOptions`](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties#ref-9f6740185de1) defines the following options:

**priceInfo**

Controls whether or not summary price information should be returned in field `priceInfo` of type [`ArticleProperties`](/pCon/configuratorOnline/specs/api/basket/types/articleproperties). Price information is returned if the value of this option is `true`, return of price information is enabled[^2] and valid price information could be determined.

Return of this price information is made optional as it requires computation of calculation data, which may be a bit expensive, especially if the use of group calculations is required, and unnecessary if the client will fetch complete calculation data anyway.

The default value of this option is `false`.

**pricingProcedureName**

Contains the name of the pricing procedure to use to fetch price information. The pricing procedure name is also used to compute the value of the deprecated `alternativePosition` property.

If option `priceInfo` is `true` and return of price information is enabled then the pricing procedure name must be empty and the basket must use exactly one price calculation, or the pricing procedure name must be equal to the name of one of the price calculations used by the basket.

The default value of this option is an empty string.

**positionNumbers**

This option is ignored if `getItemProperties` is called for basket items. If called for view items, the option controls whether or not position numbers are returned using field `positionNumber` of type [`ItemProperties`](/pCon/configuratorOnline/specs/api/basket/types/itemproperties).

The default value of this option is `false`.

**includeCalculationErrorsInInconsistencies**

If true, validation errors in all item calculations of an article item are considered an inconsistency of that article item. If false, only OFML article inconsistencies are used to set fields inconsistencyFlag and inconsistencyReason of complex type [ArticleProperties](/pCon/configuratorOnline/specs/api/basket/types/articleproperties).

The default value of this option is `true`.

**articleClassifications**

The option is used to control whether operation getItemProperties returns article classifications. The default value of this option is `false`.

**inactivePositionState**

If true, operation getItemProperties returns information about inactive positions in field inactivePositionState of type [ArticleProperties](/pCon/configuratorOnline/specs/api/basket/types/articleproperties). Fields alternativePosition and excludedCalcualtions are not returned. Otherwise, if false (the default value), information about inactive positions is returned as before in fields alternativePosition and excludedCalculations, and inactivePositionState is not returned.

The default value of this option is `false`.

**textFormat**

For operation `getItemProperties` to return formatted text, `textMode` must be set to a value other than `Legacy` and the option `textFormat` must be set to a value other than `Plain` or `None` (which is forbidden anyway).

**`preservePlainText`**

The `option` `preservePlainText` is ignored if option `textFormat` is unset, set to `Plain` or None, or is ignored. Otherwise, if set to true, texts that are stored as plain text are returned unmodified instead of being converted to the requested format.

**`omitTMRows`**

If `omitTMRows` is set to true, operation `getItemProperties` doesn't return text manager rows in field tmRows. This might be desirable to reduce traffic if operation [`tmGetText2`](/pCon/configuratorOnline/specs/api/basket/operations/tmgettext2) is used to fetch text manager data, or simply because the client isn't interested in that data.

(Return of `tmDescription` is already suppressed if no `tmDescrMode` options are set in GetItemPropertiesOptions, which is also the default.)

A [`BasketServiceFault`](/pCon/configuratorOnline/specs/api/basket/faults/basketservicefault) is returned if any of the following conditions occurs:

- The `sessionId` parameter is not a valid string representation of an UUID or does not represent an open session.

- At least one of the elements of the `itemIds` sequence parameter is not a valid string representation of an UUID.

- At least one of the elements of the `itemIds` sequence parameter does not identify an existing basket item.

- The Online Configurator failed to fetch some of the properties due to an internal error.

- If the options parameter is present and duplicate item Ids occure.

[^1]: the basket item, not the view item

[^2]: application feature `egr.eai.ws.basket.ReturnPriceInfo` is available
