Interface: PriceData
Comprehensive price information for a product configuration.
The PriceData interface provides complete pricing information for a product configuration, including the total price, currency, quantity breaks, and delivery information. This structure includes everything needed to display pricing to users and process orders.
PriceData combines multiple pricing components like unit price, one-time fees, and quantity discounts into a comprehensive pricing package that reflects the business rules and pricing strategy for the product.
Properties
currency
currency:
string
Currency code for the price values.
This property specifies the three-letter ISO currency code (e.g., "USD", "EUR", "GBP") that applies to all price values in this object. This ensures prices are properly interpreted in the correct currency.
Currency codes are essential for international businesses and multi-currency environments where prices might be displayed in different currencies.
deliveryTime?
optionaldeliveryTime:string
Estimated delivery timeframe for this product.
This optional property provides a human-readable indication of when the customer can expect to receive the product. This is number of days.
Delivery time information helps set customer expectations and can be an important factor in purchase decisions.
discount?
optionaldiscount:number
Percentage discount applied to this price.
This optional property indicates any percentage discount that has been applied to the price. This makes the discount explicitly visible rather than just showing the resulting price reduction.
Displaying discount percentages can be more motivating for customers than simply showing reduced prices.
itemMasters?
optionalitemMasters:ItemMaster[]
Item master data for inventory and fulfillment.
This optional property contains detailed product information from inventory management systems, including dimensions, delivery times, and stock codes. This bridges the configuration system with inventory and fulfillment systems.
Item master information ensures that the configured product can be properly identified, found, and shipped from inventory.
levels
levels:
PriceLevel[]
Quantity-based price breaks for this product.
This property contains an array of price levels, each defining a quantity range and the pricing that applies within that range. This enables volume-based pricing where larger quantities receive better per-unit prices.
Quantity breaks incentivize larger orders while ensuring appropriate pricing at every volume level.
marketCostPrices?
optionalmarketCostPrices:MarketCostPriceItem[]
Market and cost price information for this product.
This optional property provides additional pricing context like manufacturer suggested retail prices, cost prices, or market-specific pricing. This information is often used for internal analysis or to show comparative pricing.
Market cost prices can help customers understand the value proposition when shown alongside the actual selling price.
oneTimePrice?
optionaloneTimePrice:number
One-time price component that doesn't scale with quantity.
This optional property contains any fixed price amount that is charged once per order regardless of quantity. This includes setup charges, processing fees, or other costs that don't increase with quantity.
One-time prices are added to the total after the per-unit price is multiplied by quantity, allowing for accurate pricing at different quantities.
price
price:
number
Total calculated price for the current configuration and quantity.
This property contains the final calculated price value for the product based on its configuration, selected options, and current quantity. This combines both the per-unit price (multiplied by quantity) and any one-time price components.
This is typically the main price value displayed to customers in the interface.
totalWeight?
optionaltotalWeight:number
Total weight of the order for shipping calculations.
This optional property provides the calculated total weight of the order, which can be used for shipping cost estimates or logistics planning.
Weight information is particularly relevant for physical products where shipping costs are weight-dependent.
unitPrice?
optionalunitPrice:number
Price per individual unit at the current quantity.
This optional property contains the price for a single unit of the product at the current quantity level, taking into account any applicable quantity break discounts. This is the component that gets multiplied by quantity.
Unit prices help customers understand the component costs in their order, especially when multiple quantities are involved.
vatType?
optionalvatType:VatType
VAT or tax handling type for this price.
This optional property indicates how taxes are handled in the displayed prices, such as whether prices include VAT, exclude VAT, or have special tax status. This helps customers understand the tax implications of their purchase.
Tax type information is particularly important in regions with complex tax rules or where tax display requirements are regulated.