ArticleData
Synopsis
struct ArticleData {
string manufacturerId;
string seriesId;
string baseArticleNumber;
string variantCode;
string shortText;
string longText;
string featureText;
ArticleDescriptionMode descriptionMode;
string propertyTitle;
PropertyClass[] propertyClasses;
Property[] properties;
URL catalogImage;
URL catalogIcon;
string currency;
decimal* pdPurchasePrice;
decimal* pdSalesPrice;
PriceComponent[] pdPurchasePriceComponents;
PriceComponent[] pdSalesPriceComponents;
string purchaseCurrency,
string salesCurrency,
boolean priceDateSupported,
boolean priceDateEditable,
date priceDate
PreConfigurationData? preConfigurationData; // optional element
}
See also: ArticleDescriptionMode, PropertyClass, Property, URL, PriceComponent, date (unresolved source reference)
The ArticleData structure contains most product information available for a particular article. The following fields are defined:
manufacturerId
This field contains the commercial manufacturer ID of the article.
seriesId
This field contains the commercial series ID of the article.
baseArticleNumber
This field contains the base article number of the article.
variantCode
This field contains the variant code of the article. Naturally, the variant code depends on the current configuration of the article.
For ordinary OCD articles, manufacturer ID, series ID, base article number and variant code are sufficient to identify an article and its current configuration.
shortText
This field contains the short article text – usually a single line describing the article. The language of the text depends on the configuration of the current session and the languages available in the product data.
longText
This field contains the long article text – often consisting of more than a single line. The language of the text depends on the configuration of the current session and the languages available in the product data.
featureText
This field contains a description of the article features / properties. It depends on the current configuration of the article. The language of the text depends on the configuration of the current session and the languages available in the product data.
DescriptionMode
The field will always be present in instances of ArticleProperties returned from the server to the client. It is optional because the client does not need to set this field when it passes an instance of ArticleProperties to the server. In fact, setting this field has no effect1.
propertyTitle
Field propertyTitle is present/non-null if and only if OFML method getPropTitle() returns a non-empty property title, in which case it holds the return value of getPropTitle(). The property title is the headline for the property editor. In the OFML data this can be controlled with the options Article4PropTitle and ArtText4PropTitle (see Applications Note “AN-2006-01 : Control Data Tables”2).
propertyClasses
This field contains a possibly empty sequence of all property classes (§PropertyClass) of the article. It may contain property classes not used by any property stored in the properties field.
The primary display order of properties in a property editor is defined by the order of property classes as stored in this field. Within a single property class, the secondary display order is defined by the order of properties as stored in the properties field.
If a property editor groups properties below a property class, it should not display property classes with no associated visible properties, as the list of property classes may include classes that are used by internal properties only.
Note that the mapping from symbolic property class name to property class description may differ from position to position, and may change even for a given position after a change to the position’s configuration. Therefore, it is not recommended to cache the mapping from property class names to property class description.
properties
This field contains a possibly empty sequence of the properties (§Property) of the article. The sequence contains all user visible properties (configurable and read only properties to be displayed by a property editor) as well as purely graphical properties (properties affecting only the graphical representation of the article, like geometry and material).
Naturally, the content of the sequence depends on the current configuration. This does not only apply to the content of the Property structures, but also to the set of properties as identified by their class and name. However, the order of properties is guaranteed not to change3.
catalogImage
If, during insertion of the article into the basket structure, information about the catalog containing the article has been provided4, and if the Online Configurator has been able to find an image for this article in the catalog, then this field contains an URL referencing this image. Otherwise, this field contains an empty string.
Although, in theory, the value of this field depends on the current configuration, catalogs usually do not contain entries for configuration-dependent images and thus the value of this field usually does not change for a particular article.
catalogIcon
This element is present if and only if option fetchCatalogIcon is true.
currency
This field contains the ISO 4217 currency code (but no pseudo-currency code) of the article’s purchase and sales prices as reported by the values of the pdPurchasePrice, pdSalesPrice, pdPurchasePriceComponents and pdSalesPriceComponents fields.
If neither a purchase nor a sales price could be determined for (the current configuration of) the article, this field contains an empty string.
The actual currency depends on the configuration of the current session and the currencies available in the product data.
pdPurchasePrice
This field contains the purchase price for the current configuration of the article as determined by the product data. If no purchase price could be determined, the field is not available. The field will not be provided if the currencies of purchase price and sales price are different and the value of the purchase price is non-zero.
pdSalesPrice
This field contains the sales price for the current configuration of the article as determined by the product data. If no sales price could be determined, the field is not available.
pdPurchasePriceComponents
This field contains the individual components of the article’s purchase price. If not empty, the sum of the listed price components is equal to the value of the pdPurchasePrice field.
Even with a non-zero purchase price the list of price components may be empty if, for whatever reason, the Online Configurator was not able to produce a proper list of purchase price components.
pdSalesPriceComponents
This field contains the individual components of the article’s sales price. If not empty, the sum of the listed price components is equal to the value of the pdSalesPrice field.
Even with a non-zero sales price the list of price components may be empty if, for whatever reason, the Online Configurator was not able to produce a proper list of purchase price components.
preConfigurationData
Returned for basket main article items while they are in pre-configuration. Contains the dialog’s actionId; see PreConfigurationData and oapFinishPreConfiguration.
Footnotes
-
Operation
setItemPropertiesignores an article description mode specified by the client. ↩ -
If a particular configuration of an article contains properties A and B, with property A preceding property B, then in any other configuration of the article containing both the properties A and B, property A precedes property B. ↩
-
The
catalogIdand/orcatalogPackageIdfields of theInsertInfostructure have been set to valid values. ↩