Interface: CartItemWithPriceSettings
Extended cart item with price calculation context.
This interface extends the standard cart item with additional pricing context information needed to correctly calculate prices based on the current user, company, pricing programs, and template settings. This ensures that the right pricing rules and discount structures are applied.
Extends
Properties
cartId?
optionalcartId:string
Identifier of the cart this item belongs to.
References the cart that contains this item, enabling operations that need to associate items with their parent cart.
Inherited from
cartItemId
cartItemId:
string
Unique identifier for this specific cart item.
A system-generated ID that uniquely identifies this specific entry in the cart. This ID is used for operations like removing or updating the item.
Inherited from
companyId?
optionalcompanyId:string
Company identifier for company-specific pricing.
References the company on whose behalf the order is being placed, which may affect pricing due to negotiated rates, volume discounts, or special pricing agreements.
For B2B scenarios, this is crucial as different companies may have completely different pricing structures for the same products.
currency?
optionalcurrency:string
Currency code for the price values.
The three-letter ISO currency code (e.g., "USD", "EUR") that applies to the price values for this specific item. This ensures proper formatting and interpretation of the monetary values.
Inherited from
disabled?
optionaldisabled:boolean
Indicates if the product is no longer available.
When true, this product or its current configuration is no longer
available for purchase. Disabled items typically cannot have their
quantity increased and may display warnings to the customer.
Inherited from
image
image:
string
URL or path to the product image.
The location of the image that visually represents this product in its current configuration. This may be a static image or a dynamically generated visualization based on the selected options.
Inherited from
incrementalQty?
optionalincrementalQty:number
Quantity increment step for this product.
Defines the increment by which the quantity must change in the quantity selector. For example, a value of 5 means the quantity can only be adjusted in multiples of 5 (5, 10, 15, etc.).
This is useful for products that are only sold in specific package quantities or bundles.
Inherited from
isModular
isModular:
boolean
Indicates whether this is a complex modular product.
When true, this product is a modular assembly with multiple components
rather than a single configurable product. This affects pricing, visualization,
and order processing.
Inherited from
link?
optionallink:string
URL to the product configuration page.
The web address where this product was configured and added to the cart. This can be used to return to the configuration page for modifications or to view the complete product details.
Inherited from
mqq?
optionalmqq:number
Minimum quantity that can be ordered.
The smallest number of units that can be purchased in a single order. This enforces minimum order quantities for products where smaller orders aren't economically viable or don't meet packaging requirements.
Inherited from
note?
optionalnote:string
Additional customer remarks for this item.
Optional text field for item-specific comments, special requests, or instructions pertaining only to this particular product. This is different from cart-level notes that apply to the entire order.
Inherited from
price?
optionalprice:number
Calculated price for this line item.
The price for a single unit of this product in its current configuration. This value is multiplied by the quantity to calculate the line item total.
Inherited from
priceListGroup?
optionalpriceListGroup:string
Public price list identifier for non-company users.
For public (non-authenticated) users or when no company is specified, this determines which public price list should be used for calculations. This enables different public pricing for different market segments, campaigns, or sales channels.
priceType?
optionalpriceType:string
Pricing tier or category to apply.
Specifies which type of pricing to use for this item, such as retail, wholesale, or dealer cost. Different price types may use different calculation methods or base values.
Common price types include 'COST' (internal cost), 'RRP' (recommended retail price), and 'SALE' (discounted consumer price).
productId
productId:
string
Identifier of the base product.
References the product catalog entry that this cart item is based on. This links the cart item to the master product data including images, descriptions, and available options.
Inherited from
productName
productName:
string
Display name of the product.
The human-readable product name shown in cart listings, order summaries, and other interfaces. This should clearly identify the product for customers.
Inherited from
quantity
quantity:
number
Number of units of this product in the cart.
The count of how many identical instances of this product (with the same configuration) are being ordered. This affects the line item total and potentially enables quantity-based pricing.
Inherited from
removed?
optionalremoved:boolean
Indicates if the item has been removed from the cart.
When true, this item has been marked as removed but may still be
retained in the data for reference or potential restoration. Removed
items are typically hidden from cart displays and excluded from totals.
Inherited from
shortCode
shortCode:
string
Shortcode reference for the configuration or modular scene.
A compact reference code that can be used to quickly load this exact configuration in the configurator. For modular products, this references the complete scene layout.
Inherited from
sku
sku:
string
Stock Keeping Unit code for this configuration.
The unique identifier used for inventory management and order fulfillment that precisely identifies this product variant. The SKU encodes the product's exact configuration for warehouse and manufacturing purposes.
Inherited from
specification
specification:
Record<string,string>
Key-value pairs of the product's configuration details.
A map of configuration options selected for this product, where keys are option names and values are the selected choices. This records the specific customization made to the base product.
Inherited from
templateId?
optionaltemplateId:string
Embed template context identifier.
References the specific embed context where this item was added to the cart, which may affect pricing due to template-specific rules or promotions. Different embeds on different sites or for different campaigns may have their own pricing structures.
toRemove?
optionaltoRemove:boolean
Marks items scheduled for removal.
When true, this item is flagged for removal in the next update
operation but has not yet been physically removed from the cart data.
This is typically used in batch operations or deferred updates.
Inherited from
unitPrice?
optionalunitPrice:number
Price per unit for display purposes.
The price for each individual unit, which may include quantity breakpoints where the per-unit price decreases at higher quantities.
Inherited from
variantCode
variantCode:
string
Technical configuration code for the product.
The internal code that represents the complete set of selected options in a machine-readable format. This is used by the configurator to recreate the exact configuration and may differ from the customer-facing SKU.