---
title: "BasketItemAttrId"
slug: "api/basket/types/basketitemattrid"
sidebar:
  order: 315
---

<a id="ref-78061d0a6893"></a>
<a id="ref-b9d00a4a6a03"></a>
<a id="ref-3a393a2dd6f0"></a>

## Synopsis

```text
enum BasketItemAttrId {
    Undefined,
    UserDefined,
    Manufacturer,
    Series,
    ArticleNumber,
    Description,
    Quantity,
    SinglePurchasePrice,
    TotalPurchasePrice,
    SingleSalesPrice,
    TotalSalesPrice,
    SingleNetPrice,
    TotalNetPrice,
    SingleGrossPrice,
    TotalGrossPrice,
    Position,
    CatalogImage,
    GeneratedImage,
    ArticleImage
}
```

This enumeration type defines an identifier for predefined columns. The value `Undefined` should never occur. The value `UserDefined` is used for user-defined columns. All other IDs identify a predefined column.

For each predefined column ID, each basket has exactly one column. Fields of predefined columns can be read, but not written. Predefined columns have a well known column ID.

**`Manufacturer`**

Column ID: 69ec3fa0-795a-11d6-9c21-00e029099a4b

This column contains the commercial manufacturer ID, if available, or an empty string.

**`Series`**

Column ID: 6d302258-795a-11d6-9c21-00e029099a4b

This column contains the series ID, if available, or an empty string.

**`ArticleNumber`**

Column ID: 71803794-795a-11d6-9c21-00e029099a4b

This column contains the base article number, if available, 0or an empty string.

**`Description`**

Column ID: 745802e4-795a-11d6-9c21-00e029099a4b

This column contains the short description of article items or the label of the item for all other item types. The short description of article items is determined based on the currently configured list of effective product data languages.

**`Quantity`**

Column ID: 76eda34c-795a-11d6-9c21-00e029099a4b

For items with a valid quantity (article items with a finite quantity) this column contains the quantity formatted as a decimal number with at least two and at most three fraction digits. Otherwise it contains an empty string.

Three fraction digits are used if the exact value of the quantity cannot be expressed using only two fraction digits.

Decimal separator, grouping separator and grouping size are determined based on the session's current locale.

**`SinglePurchasePrice`**

Column ID: 7d21a60a-795a-11d6-9c21-00e029099a4b

For article items, this column contains the purchase price. Otherwise, it contains an empty string.

See below for information about formatting of prices.

The purchase price of an OFML article item is usually the purchase price provided by the OFML product database. If, however, the article item was part of a project produced by some other application (like P-BK), an explicitly specified gross purchase price may be used instead.

**`TotalPurchasePrice`**

Column ID: 7fe484fc-795a-11d6-9c21-00e029099a4b

For article items, this column contain the product of purchase price and quantity.

**`SingleSalesPrice`**

Column ID: 82efa014-795a-11d6-9c21-00e029099a4b

For article items, this column contains the sales price. Otherwise, ti contains an empty string.

See below for information about formatting of prices.

The sales price of an OFML article is the sales price provided by the OFML product database.

**`SingleNetPrice`**

Column ID: 8831eeec-795a-11d6-9c21-00e029099a4b

**`SingleGrossPrice`**

Column ID: 8dcf0592-795a-11d6-9c21-00e029099a4b

The current implementation uses the value of the single sales price column as the value of these columns. This may be changed in future versions of EAIWS.

**`TotalSalesPrice`**

Column ID: 8541eb1a-795a-11d6-9c21-00e029099a4b

For article items, this column contains the product of sales price and quantity.

**`TotalNetPrice`**

Column ID: 8b51fbe4-795a-11d6-9c21-00e029099a4b

**`TotalGrossPrice`**

Column ID: 90895bc0-795a-11d6-9c21-00e029099a4b

The current implementation uses the value of the total sales price column as the value of these columns. This may be changed in future versions of EAIWS.

**`Position`**

Column ID: 81d12edc-853a-11d6-9c21-00e029099a4b

With the current implementation this column always contains an empty string. This is because position numbers for items are provided by the basket views, not the basket itself. Basket views, however, are not supported yet.

**`CatalogImage`**

Column ID: 9c9ea8ea-20ce-11d7-9c21-00e029099a4b

In case of OFML article items, this column contains an image URI for an image from an XCF or OAS catalog if such an image has been found for this article. Otherwise, it contains an empty string.

Unless resolved, the URI will usually be a file URL, although there is no guarantee this won't change in future versions of EAIWS.

**`GeneratedImage`**

Column ID: 6a66160c-da62-11d8-b9d6-00e081513ada

In case of OFML article items, this column contains an image URI for an image dynamically rendered for the current configuration of this article item unless rendering of images has been suppressed or disabled. Otherwise, it contains an empty string.

The images contained in this column are the sames images as returned with an empty tag by the getImages (§[getImages](/pCon/configuratorOnline/specs/api/basket/operations/getimages#ref-6287d0797acb)) operation. However, other than the getImages (§[getImages](/pCon/configuratorOnline/specs/api/basket/operations/getimages#ref-6287d0797acb)) `operation`, callers of operation `getItemFields` (§ [getItemFields](/pCon/configuratorOnline/specs/api/basket/operations/getitemfields#ref-7adad846bd68)) can control if generated images should be fetched from the global cache if not already referenced by the item, or, if not found in the global cache, should be generated. See also GetItemFieldsOptions (§ [GetItemFieldOptions](/pCon/configuratorOnline/specs/api/basket/types/getitemfieldoptions#ref-124575fdcda0)) for more information.

If an image needs to be generated, the rendering settings used are the same as those used by the getGeneratedImage (§[getGeneratedImage](/pCon/configuratorOnline/specs/api/basket/operations/getgeneratedimage#ref-01360c8648c1)) operation when invoked with no options. Other than P-BK and derived applications, the current implementation makes no attempt to reuse the settings from the last image generated (for a different configuration) for this position.

**`ArticleImage`**

Column ID: 73bd68f4-da62-11d8-b9d6-00e081513ada

For OFML, OCD and user article items, this column contains the value of the `GeneratedImage` column, if not empty, and the value of the `CatalogImage` column otherwise. For all other basket items, it contains an empty string.

Formatting of prices:

Finite prices are formatted as a fixed point decimal number followed by a SPACE (U+0020) and the ISO 4217 currency code. As a special case, if the amount is zero, the SPACE and currency code may be missing.

The amount is formatted using either the default number of fraction digits of the currency, or one more fraction digit if the amount cannot be expressed exactly with the default number of fraction digits.

Decimal separator, grouping separator and grouping size are determined based on the session's current locale.

The formatting of infinite and invalid prices is highly locale-dependent and subject to change.
