Interface: ModularElement
Represents a product element in a modular configuration, with complete details.
The ModularElement interface provides comprehensive information about a product that has been added to a modular scene, including its identity, configuration, pricing, and selected options. This is a data-rich representation used for displaying product details, calculating prices, and generating reports.
Unlike the ProductElement interface which focuses on scene placement and connections, ModularElement focuses on business data like pricing, options, and product information.
Properties
configurationCode
configurationCode:
string
Configuration code representing all selected options.
This code encapsulates all the option selections and customizations applied to this specific product instance. It's a serialized representation of the product's current configuration state.
The configuration code can be used to recreate this exact product configuration in the future or to look up pricing and availability.
description?
optionaldescription?:Nullable<string>
Plain text description of the product.
This optional property contains a human-readable description of the product, explaining its features, benefits, and characteristics. This helps users understand the product's purpose and value.
Product descriptions are important for customer education and often appear in detailed view modes and documentation.
dimensions?
optionaldimensions?:Nullable<ModelDimensions>
Physical dimensions of this product in its current configuration.
This optional property contains the width, height, and depth of the product
as determined by the active configuration. Values are expressed in the unit
system configured for the product. May be null if dimensions are not
available for this product.
Dimensions are useful for space planning, order summaries, and integration with external systems that require physical size information.
image?
optionalimage?:string
Absolute URL to the product thumbnail image.
This optional property provides a direct URL to an image representing this product. This is used for integration with external systems that need a simple image URL rather than complex thumbnail settings.
Direct image URLs simplify integration with order management systems, websites, and other platforms that display product imagery.
itemKey
itemKey:
string
Unique item key combining product ID and configuration.
This key uniquely identifies this product with its specific configuration. It's a combination of the product ID and configuration code that creates a unique identifier for this exact product variant.
The itemKey is useful for tracking unique product configurations across orders, even when the same product appears multiple times with different options.
itemPrice?
optionalitemPrice?:number
Per-unit price for this product.
This optional property contains the price for a single unit of this product at the current quantity level, after any applicable quantity break discounts have been applied. This is the price component that gets multiplied by the quantity.
Unit pricing helps customers understand the component costs in orders with multiple units of the same product.
levels?
optionallevels?:PriceLevel[]
Quantity break pricing tiers for this product.
This optional property defines different pricing tiers based on order quantity. Each level specifies a quantity range with its own per-unit price and one-time price component, potentially offering better pricing for larger quantities.
Quantity breaks encourage volume purchases by making the per-unit price more attractive at higher quantities, while clearly showing the discount structure to customers.
oneTimeAmount?
optionaloneTimeAmount?:number
One-time price component of the product price.
This optional property indicates what portion of the product price is a one-time fee rather than a per-unit cost. This corresponds to the pricePart value in the applicable price level and doesn't scale with quantity.
One-time amounts cover fixed costs like setup, processing, or special handling that occur once regardless of order quantity.
options
options:
SimpleOption[]
List of options selected for this product.
This property contains detailed information about all the options that have been selected for this product instance. Each option includes information about the block, name, and value of the selection.
The options list provides a complete picture of how this product has been customized and is essential for order processing and manufacturing.
price
price:
number
Total price for this product.
This property contains the calculated price for this product based on its configuration, quantity, and applicable quantity breaks. It combines both the per-unit price component (multiplied by quantity) and any one-time price components.
The price represents the complete value of this product in the current configuration and quantity.
productId
productId:
string
ID of the product type.
This property identifies the type of product this element represents. Multiple elements on the scene can share the same productId if they are instances of the same product type.
productName
productName:
string
Display name of the product.
This is the human-readable name of the product as it should be displayed in interfaces, summaries, and reports. This name should be clear and recognizable to users.
The product name is crucial for user interfaces, order summaries, and any customer-facing documentation about the configuration.
qty
qty:
number
Quantity of this product in the configuration.
This property indicates how many units of this product are included in the current configuration. For modular products, this is typically the count of identical instances on the scene.
The quantity affects which price level applies from the available quantity breaks, potentially changing both the per-unit and total price.
sku?
optionalsku?:string
Stock Keeping Unit code for this product configuration.
This optional property contains the SKU code that uniquely identifies this specific product configuration in inventory and order management systems. The SKU combines product identity with configuration options.
SKUs are crucial for order fulfillment, inventory tracking, and integration with enterprise management systems.
standardImage?
optionalstandardImage?:ProductThumb
Default thumbnail image for the product.
This property defines how the product's standard thumbnail should be displayed, including whether it's a static image or dynamically generated from the 3D model.
Product thumbnails are essential for visual identification in summaries, line items, and reports.
unitComparePrice?
optionalunitComparePrice?:number
Compare (promo) price per unit for this product.
When set, indicates the original or reference unit price before any promotional discount was applied. Used to display a crossed-out price alongside the current selling price.
variantCode
variantCode:
string
Product configuration variant code.
This code identifies the specific variant of the product, which may be different from the full configuration code. The variant code often represents the product's structural variant, while the configuration code includes all option selections.
Variant codes are often used in SKU generation and inventory systems.