Class SerializableOrderForm
This type/member supports the EPiServer infrastructure and is not intended to be used directly from your code.
This class represents an order form in the new cart system. It works with the new database model for cart.
Inheritance
Inherited Members
Namespace: EPiServer.Commerce.Order.Internal
Assembly: EPiServer.Business.Commerce.dll
Version: 12.17.2Syntax
public class SerializableOrderForm : IOrderForm, IExtendedProperties
Constructors
SerializableOrderForm()
Creates an instance of SerializableOrderForm.
Declaration
public SerializableOrderForm()
SerializableOrderForm(ICollection<SerializableShipment>, ICollection<SerializablePayment>)
Creates an instance of SerializableOrderForm. This constructor is required for the JSON deserializer to be able to identify concrete classes to use when deserializing the interface properties.
Declaration
public SerializableOrderForm(ICollection<SerializableShipment> shipments, ICollection<SerializablePayment> payments)
Parameters
Type | Name | Description |
---|---|---|
System.Collections.Generic.ICollection<SerializableShipment> | shipments | The shipment collection. |
System.Collections.Generic.ICollection<SerializablePayment> | payments | The payment collection. |
Properties
AuthorizedPaymentTotal
Gets or sets the amount that has is on hold, waiting for being captured.
Declaration
public decimal AuthorizedPaymentTotal { get; set; }
Property Value
Type | Description |
---|---|
System.Decimal |
CapturedPaymentTotal
Gets or sets the amount that has been transfered.
Declaration
public decimal CapturedPaymentTotal { get; set; }
Property Value
Type | Description |
---|---|
System.Decimal |
CouponCodes
Gets the supplied coupon codes.
Declaration
public ICollection<string> CouponCodes { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<System.String> |
HandlingTotal
Gets or sets the handling total.
Declaration
public decimal HandlingTotal { get; set; }
Property Value
Type | Description |
---|---|
System.Decimal |
Name
Gets or sets the name.
Declaration
public string Name { get; set; }
Property Value
Type | Description |
---|---|
System.String |
OrderFormId
Gets or sets the unique identity for the order form.
Declaration
public int OrderFormId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Payments
Gets the payments on the order form.
Declaration
public ICollection<IPayment> Payments { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<IPayment> |
Promotions
Gets the promotions.
Declaration
public IList<PromotionInformation> Promotions { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.IList<PromotionInformation> |
Properties
Gets or sets the property bag for dealing with custom meta fields.
Declaration
public Hashtable Properties { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Hashtable |
Shipments
Gets the shipments on the order form.
Declaration
public ICollection<IShipment> Shipments { get; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.ICollection<IShipment> |
Explicit Interface Implementations
IOrderForm.PricesIncludeTax
Gets the setting of including tax in price from the order group.
Declaration
bool IOrderForm.PricesIncludeTax { get; }
Returns
Type | Description |
---|---|
System.Boolean |
Remarks
It does not need to be included in serialization.