Namespace CMS.Commerce
Classes
- AddressDto
Represents a structured address used in price calculation requests.
- CatalogPromotionCandidate
Represents a promotion candidate that can be used for the specified product.
- CatalogPromotionRuleBase<TPromotionRuleProperties, TProductIdentifier, TPriceCalculationRequest, TPriceCalculationResult>
Abstract base class for a catalog promotion rule. New catalog promotion rules should inherit from this class. To use inbuilt properties, inherit from
CatalogPromotionRule.
- CustomerAddressInfo
Data container class for CustomerAddressInfo.
- CustomerInfo
Data container class for CustomerInfo.
- EmailBuilderOrderContext
Represents the context of a commerce order available in email builder components.
- OrderAddressInfo
Data container class for OrderAddressInfo.
- OrderAddressType
Data container for OrderAddressType to represent value of OrderAddressType.
- OrderData
Shopping cart data to create order from.
- OrderDataBase<TOrderItem, TAddressDto>
Shopping cart data to create order from.
- OrderItemInfo
Data container class for OrderItemInfo.
- OrderNotificationSendException
Exception that indicates a failure occurred while sending a notification.
- OrderPromotionCandidate
Represents a promotion candidate that can be used for the whole order.
- OrderPromotionInfo
Data container class for OrderPromotionInfo.
- OrderPromotionRuleBase<TPromotionRuleProperties, TPriceCalculationRequest, TPriceCalculationResult>
Abstract base class for an order promotion rule. New order promotion rules should inherit from this class. To use inbuilt properties, inherit from
OrderPromotionRule.
- OrderStatusInfo
Data container class for OrderStatusInfo.
- PaymentMethodInfo
Data container class for PaymentMethodInfo.
- PriceCalculationData<TPriceCalculationRequest, TPriceCalculationResult>
Holds data required to perform shopping cart calculation.
- PriceCalculationMode
Mode of price calculation that should be used.
- PriceCalculationPromotionCandidate<TPromotionCandidate>
Represents a promotion candidate.
- PriceCalculationRequest
Input data necessary to perform a price calculation.
- PriceCalculationRequestBase<TPriceCalculationRequestItem, TAddressDto>
Represents the data required for an order price calculation request.
- PriceCalculationRequestItem
Item to be processed in a price calculation.
- PriceCalculationRequestItemBase<TProductIdentifier>
Represents a product in a price calculation request.
- PriceCalculationResult
Result data from completed price calculations.
- PriceCalculationResultBase<TPriceCalculationResultItem>
Represents the result of calculating prices for an order, including itemized prices, totals, taxes, and shipping.
- PriceCalculationResultItem
Result data item from completed calculations.
- PriceCalculationResultItemBase<TProductIdentifier, TProductData>
Represents the result of calculating prices for a single item in an order.
- PriceCalculationResultItemPromotionData
Represents item promotion data for a price calculation related to a specific cart item.
- PriceCalculationResultPromotionData
Represents promotion data for a price calculation related to a whole order.
- PriceCalculationRoundingContext
Class representing the context for price calculation rounding.
- PriceFormatContext
Represents the context for formatting prices.
- ProductData
Represents detailed information about a product relevant to pricing calculations.
- ProductIdentifier
Represents a unique identifier for a product in the cart. Used to associate calculation logic with a specific cart item and with items in calculation requests and results.
- ProductQuantityFormatContext
Represents the context for product quantity formatter.
- PromotionInfo
Data container class for PromotionInfo.
- PromotionModel
Promotion model.
- PromotionRuleBase<TPromotionRuleProperties, TPriceCalculationRequest, TPriceCalculationResult>
Abstract base class for a promotion rule definition.
- RegisterPromotionRuleAttribute<TPromotionRule>
Registers a promotion rule.
- ShippingMethodInfo
Data container class for ShippingMethodInfo.
- ShoppingCartInfo
Data container class for ShoppingCartInfo.
- TaxOptions
Represents configuration options related to tax calculations. This class is used to specify whether prices include tax in tax-related calculations.
Interfaces
- ICatalogPromotionPriceCalculationStep<TCalculationRequest, TCalculationResult>
Represents a calculation step responsible for calculating all applied catalog promotions during the price calculation process.
- ICustomerAddressInfoMapper<TAddressDto>
Customer address info mapper to populate info or DTO object with additional data.
- ICustomerInfoMapper<TOrderData>
Customer info mapper to populate CustomerInfo with custom order data.
- IEmailBuilderOrderContextAccessor
Provides access to the current commerce order context in email builder components.
- ILineSubtotalsPriceCalculationStep<TPriceCalculationRequest, TPriceCalculationResult>
Represents a calculation step responsible for calculating the line subtotal prices of all items during the price calculation process.
- ILineTotalPriceCalculationStep<TPriceCalculationRequest, TPriceCalculationResult>
Represents a calculation step responsible for calculating the total line price of all items during the price calculation process.
- IOrderAddressInfoMapper<TAddressDto>
Order address info mapper.
- IOrderCreationService<TOrderData, TPriceCalculationRequest, TPriceCalculationResult, TAddressDto>
Order creation service for creating and saving new orders.
- IOrderData
Shopping cart data to create order from.
- IOrderGrandTotalPriceCalculationStep<TPriceCalculationRequest, TPriceCalculationResult>
Represents a calculation step responsible for calculating the grand total price of the price calculation process.
- IOrderInfoMapper<TOrderData, TPriceCalculationResult>
Order info mapper.
- IOrderItemInfoMapper<TOrderData, TPriceCalculationResult>
Order item info mapper.
- IOrderItem<TProductIdentifier>
Represents item of shopping cart, product catalogue or invoice.
- IOrderNotificationService
Service for sending order notifications.
- IOrderPromotionPriceCalculationStep<TCalculationRequest, TCalculationResult>
Represents a calculation step responsible for calculating all applied order promotions during the price calculation process.
- IOrderPromotionRule<TPriceCalculationRequest, TPriceCalculationResult>
Interface for an order promotion rule. New order promotion rules should implement this interface.
- IOrderTotalPriceCalculationStep<TPriceCalculationRequest, TPriceCalculationResult>
Represents a calculation step responsible for calculating the total price of the price calculation process.
- IPriceCalculationData<TPriceCalculationRequest, TPriceCalculationResult>
Represents a container for both the calculation request (input) and calculation result (output) used in the calculation process.
- IPriceCalculationPromotionCandidate<TPromotionCandidate>
Promotion candidate info created during price calculation.
- IPriceCalculationRequest
Represents the contract for a price calculation request, encapsulating all information necessary to perform order price calculations. This interface is not intended for custom implementation. Use PriceCalculationRequest or PriceCalculationRequestBase<TPriceCalculationRequestItem, TAddressDto> for extensibility.
- IPriceCalculationRequestItem<TProductIdentifier>
Defines the contract for an item included in a price calculation request. Each item represents a product and its quantity for which pricing is to be calculated.
- IPriceCalculationRequestMapper<TPriceCalculationRequest, TOrderData>
Configuration for price calculation request object to receive all custom data.
- IPriceCalculationResult
Represents the result of calculating prices for an order, including itemized prices, totals, taxes, and shipping.
- IPriceCalculationResultItem<TProductIdentifier, TProductData>
Represents the result of calculating prices for a single item in an order. This interface is not intended for custom implementation. Use PriceCalculationResultItem or PriceCalculationResultItemBase<TProductIdentifier, TProductData> for extensibility.
- IPriceCalculationRoundingService
Price calculation rounding service.
- IPriceCalculationService<TPriceCalculationRequest, TPriceCalculationResult>
Represents a service for calculating prices using a sequence of calculation steps.
- IPriceCalculationStep<TPriceCalculationRequest, TPriceCalculationResult>
Represents a single calculation step in the price calculation pipeline.
- IPriceCalculationStepsProvider<TPriceCalculationRequest, TPriceCalculationResult>
Represents a provider that supplies a list of price calculation steps. Implement and register a class that implements this interface to define a custom sequence of price calculation steps for the price calculation pipeline.
- IPriceFormatter
Interface for price formatting.
- IProductDataLoaderPriceCalculationStep<TPriceCalculationRequest, TPriceCalculationResult>
Represents calculation step for loading product data for later calculations. Prepare all the data in the calculation result object that will be needed for all the following calculation steps.
- IProductDataRetriever<TProductIdentifier, TProductData>
Defines a contract for retrieving product data for price calculations based on product identifiers.
This generic interface can be implemented for different product identifier and product data types. Its responsibilities include:
- Building and executing queries against the database using product identifiers.
- Mapping raw product data into strongly typed
TProductDataobjects. - Returning results as a read-only dictionary keyed by
TProductIdentifier.
- IProductQuantityFormatter
Interface for product quantity formatting.
- IPromotionCandidate
Represents interface for promotion candidate.
- IPromotionRule
Interface for promotion rule.
- IPromotionRuleProperties
Represents the properties of a promotion rule.
- IPromotionRule<TPriceCalculationRequest, TPriceCalculationResult>
Represents a rule that determines whether a promotion can be applied.
- IShippingPriceCalculationStep<TPriceCalculationRequest, TPriceCalculationResult>
Represents a calculation step responsible for determining the shipping price during the price calculation process.
- ITaxPriceCalculationStep<TPriceCalculationRequest, TPriceCalculationResult>
Represents a calculation step responsible for calculating all applied taxes during the price calculation process.
Enums
- PromotionType
Represents the type of a promotion.