---
title: "BasketItem"
slug: "api/basket/types/basketitem"
sidebar:
  order: 229
---

<a id="ref-1e1fbe880650"></a>
<a id="ref-7fc5dee296ab"></a>
<a id="ref-aae876620300"></a>

## Synopsis

<a id="ref-1ad09ab0c314"></a>

```text
struct BasketItem {
    BItemId itemId;
    BasketItemType itemType;
    DisplayText label;
    BItemId[]       subItemIds;
    BItemId mainArticleId;
    BItemId[]       subArticleIds;
    BItemId[]       setArticlePartIds;
    BItemId setArticleId;
    Base64URL geometryId;
    string positionNumber;
    BItemId[]           basketItemIds;
    BasketItem[]        basketItems;
}
```

See also: [BItemId](/pCon/configuratorOnline/specs/api/basket/types/bitemid#ref-bccb6c926e5b), [BasketItemType](/pCon/configuratorOnline/specs/api/basket/types/basketitemtype#ref-5d3667cadff0), [`DisplayText`](/pCon/configuratorOnline/specs/api/basket/types/displaytext-basket#ref-b19f0939e15a)

Instances of `BasketItem` are returned by the `getAllItems` operation (§[getAllItems](/pCon/configuratorOnline/specs/api/basket/operations/getallitems#ref-83a76f1dbaff)) to provide basic (mainly structural) information about the basket item. The structure has the following fields:

**itemId**

This field holds the UUID identifying the item.

**itemType**

This field holds the type of this item. See §[BasketItemType](/pCon/configuratorOnline/specs/api/basket/types/basketitemtype#ref-5d3667cadff0) for a description of possible item types.

**label**

Depending on the type of the item, this field either holds the label of a folder or the short text of an article. The label of the top folder is empty because the root folder itself is not meant to be displayed by the application.

**subItemIds**

This field is an possibly empty list containing the identifiers of all child items of this item. This is the same list as returned by the [`getSubItemIds`](/pCon/configuratorOnline/specs/api/basket/operations/getsubitemids) operation when invoked for the item identifier stored in the `itemId` field.

**mainArticleId**

If this item is a sub-article in a hierarchy of composite articles, including the trivial case of a single composite article, this field holds the identifier of the topmost aggregate or partial planning. In all other cases this fields holds the NIL-UUID.

The field `mainArticleId` is not returned if the instance of `BasketItem` represents a view item.

**subArticleIds**

In case of a composite article (aggregate, partial planning), this field holds the possibly empty list of IDs of direct sub-article items.

No sub-article item IDs are returned if the instance of `BasketItem` represents a view item.

**`setArticleId`**

This field is present in return values of operations [`getAllItems`](/pCon/configuratorOnline/specs/api/basket/operations/getallitems) and [`pasteContainer`](/pCon/configuratorOnline/specs/api/basket/operations/pastecontainer) if option `setArticleIds` of these operations is `true`. If the basket item is part of a set-article, the attribute contains the ID of the set-article. Otherwise it contains the NIL-UUID.

No set-article item IDs are returned if the instance of `BasketItem` represents a view item.

**`setArticlePartIds`**

This field is used in return values of operations [`getAllItems`](/pCon/configuratorOnline/specs/api/basket/operations/getallitems) and [`pasteContainer`](/pCon/configuratorOnline/specs/api/basket/operations/pastecontainer) if option `setArticleIds` of these operations is `true` and the basket item is a set-article item. The field contains the basket item IDs of directly referenced parts of the set-article (sub-article items of composite articles are not listed, only the main article).

No set-article part IDs are returned if the instance of `BasketItem` represents a view item.

**`GeometryId`**

This field is used in return values of operations [`getAllItems`](/pCon/configuratorOnline/specs/api/basket/operations/getallitems) and [`pasteContainer`](/pCon/configuratorOnline/specs/api/basket/operations/pastecontainer) if option `geometryIds` of these operations is `true`, the corresponding basket item represents an OFML article item, and the geometry ID is stored in the basket item[^1]. If present, the field contains the non-empty Base64URL-encoded geometry ID.

The geometry ID returned as part of type `BasketItem` is equal to the geometry ID returned by operation [`getItemProperties`](/pCon/configuratorOnline/specs/api/basket/operations/getitemproperties). It is supposed to be used to correlate basket items and geometry nodes in GFJ files.

No geometry IDs are returned if the instance of `BasketItem` represents a view item.

**<a id="ref-e7a9c8484c7c"></a>positionNumber**

This field is present if and only if operation [`getAllItems`](/pCon/configuratorOnline/specs/api/basket/operations/getallitems) has been invoked for view items and option `positionNumbers` is effectively `true`. The position number of the view’s top folder is an empty string. The position number of all other items consists of a dot-separated list of unsigned decimal numbers.

**basketItemIds**

Basket item IDs are returned only if operation [`getAllItems`](/pCon/configuratorOnline/specs/api/basket/operations/getallitems) has been invoked for view items and option `basketItems` is effectively `false`.

Each view item references one or more basket items[^2]. This field is used to return the basket item IDs of all basket items referenced by the view item.

In most cases, a single view item references a single basket item. There are some cases, however, where a view item may reference multiple basket items:

- - - merged article items (display mode `Sorted` with merge mode other than `None`)

The order of basket item IDs returned for merged article items is unspecified.

- - - sub-article items folded into their main article item (display mode `Sorted` with merge mode `Compact`)

The list of basket item IDs consists of the item ID of the main article item followed by the item IDs of sub-article items. The order of sub-article item IDs is unspecified.

- - - parts of collapsed set-articles

The list of basket item IDs consists of the item ID of the set-article item followed by the item IDs of set-article parts. The order of set-article part IDs is unspecified. IDs of basket folder parts are not returned if the view expands basket folder items.

**basketItems**

If operation [`getAllItems`](/pCon/configuratorOnline/specs/api/basket/operations/getallitems) is invoked for view items and option `basketItems` is `true` then this field is used to return one instance of `BasketItem` for each basket item referenced by the view item. See description of field `basketItemIds` for information about the set of referenced basket items.

`Options` `setArticleIds` and `geometryIds` may be used to control the content of these nested instances of `BasketItem`.

Note that the composite article hierarchy defined by the main- and sub-article identifiers is not related in any way to the visible item hierarchy defined by the top folder and sub-item identifiers. For one thing it is not uncommon for meta types to be configured in such a way that sub-articles of meta types appear as siblings of the meta type in the order hierarchy. For another thing a future version of the Online Configurator may allow more or less unrestricted reordering of the hierarchy of basket items.

[^1]: This should usually be the case unless the basket item has been read from a BSK/OBX stream produced by an application that does not support geometry IDs.

[^2]: In theory, there may be view items that do not reference basket items, but so far no such view items have been implemented.
