Table of Contents

Class OrderInfo

Namespace
CMS.Commerce
Assembly
CMS.Commerce.dll

Data container class for OrderInfo.

[InfoCache(InfoCacheBy.ID)]
public class OrderInfo : AbstractInfo<OrderInfo, IInfoProvider<OrderInfo>>, IExtensible, IInfo, IAdvancedDataContainer, ICMSObject, IHierarchicalDataContainer, IDataContainer, ISimpleDataContainer, IVirtualHierarchicalObject, IHierarchicalObject, INameIndexable, IMacroObject, IInfoWithId, IInfoWithGuid
Inheritance
object
OrderInfo
Implements
Inherited Members
Extension Methods

Constructors

OrderInfo()

Creates an empty instance of the OrderInfo class.

public OrderInfo()

OrderInfo(DataRow)

Creates a new instance of the OrderInfo class from the given System.Data.DataRow.

public OrderInfo(DataRow dr)

Parameters

dr DataRow

Data row with the object data

Fields

OBJECT_TYPE

Object type.

public const string OBJECT_TYPE = "commerce.order"

Field Value

string

TYPEINFO

Type information.

public static readonly ObjectTypeInfo TYPEINFO

Field Value

ObjectTypeInfo

Properties

OrderCreatedWhen

The date and time when the order was created.

[DatabaseField]
public virtual DateTime OrderCreatedWhen { get; set; }

Property Value

DateTime

OrderCustomerID

Customer ID.

[DatabaseField]
public virtual int OrderCustomerID { get; set; }

Property Value

int

OrderGUID

Order GUID.

[DatabaseField]
public virtual Guid OrderGUID { get; set; }

Property Value

Guid

OrderGrandTotal

The final amount to be paid: OrderTotalPrice minus any additional custom discounts (e.g., gift card promotions).

[DatabaseField]
public virtual decimal OrderGrandTotal { get; set; }

Property Value

decimal

Remarks

In the default price calculation implementation, this value equals OrderTotalPrice, which already includes shipping and tax. Additional discounts (e.g., gift card promotions) may be applied after the price calculation, reducing this value.

OrderID

Order ID.

[DatabaseField]
public virtual int OrderID { get; set; }

Property Value

int

OrderModifiedWhen

The date and time when the order was last modified.

[DatabaseField]
public virtual DateTime OrderModifiedWhen { get; set; }

Property Value

DateTime

OrderNumber

Order number. A unique, human-readable identifier for the order.

[DatabaseField]
public virtual string OrderNumber { get; set; }

Property Value

string

OrderOrderStatusID

Order status ID.

[DatabaseField]
public virtual int OrderOrderStatusID { get; set; }

Property Value

int

OrderPaymentMethodDisplayName

Order payment method display name.

[DatabaseField]
public virtual string OrderPaymentMethodDisplayName { get; set; }

Property Value

string

Remarks

The payment method display name is stored in the order object to preserve the display name at the time the order is created, in case the payment method is later deleted.

OrderPaymentMethodID

Payment method ID.

[DatabaseField]
public virtual int OrderPaymentMethodID { get; set; }

Property Value

int

OrderShippingMethodDisplayName

Order shipping method display name.

[DatabaseField]
public virtual string OrderShippingMethodDisplayName { get; set; }

Property Value

string

Remarks

The shipping method display name is stored in the order object to preserve the display name at the time the order is created, in case the shipping method is later deleted.

OrderShippingMethodID

Shipping method ID.

[DatabaseField]
public virtual int OrderShippingMethodID { get; set; }

Property Value

int

OrderShippingMethodPrice

The price of the shipping method.

[DatabaseField]
public virtual decimal OrderShippingMethodPrice { get; set; }

Property Value

decimal

Remarks

The shipping method price is stored in the order object to preserve the price at the time the order is created, in case the shipping method is later deleted.

OrderTotalPrice

The total price of all order items after all catalog promotions (product-level discounts) and order promotions (order-level discounts) have been applied.

[DatabaseField]
public virtual decimal OrderTotalPrice { get; set; }

Property Value

decimal

Remarks

In the default price calculation implementation, this value includes shipping and tax (if tax is not included in item prices, see PricesIncludeTax option). The value is calculated as: sum of all item subtotals after all discounts + shipping + tax (if tax is not included in prices, see PricesIncludeTax option).

OrderTotalShipping

Total shipping cost for the order.

[DatabaseField]
public virtual decimal OrderTotalShipping { get; set; }

Property Value

decimal

OrderTotalTax

The total tax amount for the order.

[DatabaseField]
public virtual decimal OrderTotalTax { get; set; }

Property Value

decimal

Methods

DeleteObject()

Deletes the object using appropriate provider.

protected override void DeleteObject()

SetObject()

Updates the object using appropriate provider.

protected override void SetObject()