Class OrderLine

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Represents information about an order line.

[Serializable]
public class OrderLine

Inheritance

object

OrderLine

Inherited Members

object.Equals(object, object)

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

OrderLine(Order)

public OrderLine(Order order)

Parameters

order Order

Fields

DisableRemoveFromCartRules

public bool DisableRemoveFromCartRules

Field Value

bool

Properties

AllowOverridePrices

Indicated whether Price is overridden and not calculated. Used to set explicit PriceInfo values.

public bool AllowOverridePrices { get; set; }

Property Value

bool

Attachment

Gets or sets the attachment.

public string Attachment { get; set; }

Property Value

string

Bom

Gets or sets a value indicating whether this OrderLine is BOM.

public bool Bom { get; set; }

Property Value

bool

BomItemId

Gets or sets the BOM item ID.

public string BomItemId { get; set; }

Property Value

string

BomOrderLines

Gets or sets the BOM order lines.

public OrderLineCollection BomOrderLines { get; set; }

Property Value

OrderLineCollection

Comment

Gets or sets the comment.

public string Comment { get; set; }

Property Value

string

CustomerComment

Gets or sets the customer comment.

public string CustomerComment { get; set; }

Property Value

string

Date

Gets or sets the date.

public DateTime Date { get; set; }

Property Value

DateTime

DiscountId

Gets or sets the discount ID.

public string DiscountId { get; set; }

Property Value

string

DiscountPercentage

Gets or sets the line discount (%).

public double DiscountPercentage { get; set; }

Property Value

double

lineDiscount

GiftCardCode

Gets or sets encoded gift card code, orderline based on.

public string GiftCardCode { get; set; }

Property Value

string

Id

Gets or sets the ID.

public string Id { get; set; }

Property Value

string

ListId

Gets or sets the list ID.

public int ListId { get; set; }

Property Value

int

Modified

Gets or sets when the order line was modified.

public DateTime Modified { get; set; }

Property Value

DateTime

Order

Gets or sets the order.

public Order Order { get; set; }

Property Value

Order

OrderId

Gets or sets the order ID.

public string OrderId { get; set; }

Property Value

string

OrderLineFieldValues

Gets or sets the collection of OrderLineFieldValue objects.

public OrderLineFieldValueCollection OrderLineFieldValues { get; set; }

Property Value

OrderLineFieldValueCollection

OrderLineType

Gets or sets the order line type.

public OrderLineType OrderLineType { get; set; }

Property Value

OrderLineType

PageId

Gets or sets the page ID.

public int PageId { get; set; }

Property Value

int

ParentLineId

Gets or sets the parent line ID.

public string ParentLineId { get; set; }

Property Value

string

Points

Returns number of points of OrderLine necessary for payment.

public double? Points { get; }

Property Value

double?

Price

Gets the total price of the orderline, quantity * unitprice.

public PriceInfo Price { get; }

Property Value

PriceInfo

Product

Gets or sets the product.

public Product Product { get; set; }

Property Value

Product

ProductId

Gets or sets the product ID.

public string ProductId { get; set; }

Property Value

string

ProductName

Gets or sets the product name.

public string ProductName { get; set; }

Property Value

string

ProductNumber

Gets or sets the product number.

public string ProductNumber { get; set; }

Property Value

string

ProductVariantId

Gets or sets the product variant ID.

public string ProductVariantId { get; set; }

Property Value

string

ProductVariantText

Gets or sets the product variant text.

public string ProductVariantText { get; set; }

Property Value

string

Quantity

Gets or sets the quantity.

public double Quantity { get; set; }

Property Value

double

Reference

Gets or sets the reference.

public string Reference { get; set; }

Property Value

string

ReverseChargeForVat

Gets or sets a value indicating whether the price for this OrderLine has reverse charge for VAT.

public bool ReverseChargeForVat { get; set; }

Property Value

bool

true if the price has reverse charge for VAT; otherwise, false.

RewardId

Gets or sets the loyalty reward id.

public int? RewardId { get; }

Property Value

int?

RewardPoints

Returns information about the points which will be rewarded to the user.

public PointInfo RewardPoints { get; }

Property Value

PointInfo

RewardValue

Gets or sets the order line reward points.

public double? RewardValue { get; }

Property Value

double?

StockLocationId

Gets or sets the stock location.

public long StockLocationId { get; set; }

Property Value

long

TotalDiscount

Gets the discount value.

public PriceInfo TotalDiscount { get; }

Property Value

PriceInfo

TotalPriceWithProductDiscounts

Returns the price with the product discounts applied to it.

public PriceInfo TotalPriceWithProductDiscounts { get; }

Property Value

PriceInfo

TotalPriceWithProductDiscountsWithoutVAT

Return the price with the product discounts applied to it without VAT.

public PriceInfo TotalPriceWithProductDiscountsWithoutVAT { get; }

Property Value

PriceInfo

UnitDiscount

Returns the unit discount.

public PriceInfo UnitDiscount { get; }

Property Value

PriceInfo

UnitId

Gets or sets the unit ID.

public string UnitId { get; set; }

Property Value

string

UnitPoints

Returns points cost of product unit.

public double? UnitPoints { get; }

Property Value

double?

UnitPrice

Gets or sets the unit price.

public PriceInfo UnitPrice { get; set; }

Property Value

PriceInfo

UnitPriceBeforeDiscount

Gets or sets the price per unit without discounts.

public double UnitPriceBeforeDiscount { get; }

Property Value

double

UnitPriceDiscountPercentage

The discount percentage from the UnitPrice, used for remembering what it was when the orderline was created, as the DiscountPercentage can overrule this discount percentage in the Dynamicweb.Ecommerce.Orders.OrderLine.CalculateTotalDiscount() after the order is created.

public double UnitPriceDiscountPercentage { get; set; }

Property Value

double

UnitPriceInfoBeforeDiscount

public PriceInfo UnitPriceInfoBeforeDiscount { get; }

Property Value

PriceInfo

UnitPriceWithProductDiscount

Returns the unit price with the product discount applied to it.

public PriceInfo UnitPriceWithProductDiscount { get; }

Property Value

PriceInfo

UnitRewardPoints

Returns information about the points which will be rewarded to the user for one unit of product.

public PointInfo UnitRewardPoints { get; }

Property Value

PointInfo

UnitRewardValue

Gets or sets unit reward points.

public double? UnitRewardValue { get; }

Property Value

double?

Volume

Gets the volume.

public double Volume { get; }

Property Value

double

Weight

Gets the weight.

public double Weight { get; }

Property Value

double

Methods

CalculateProductDiscountPercentage()

public PriceInfo CalculateProductDiscountPercentage()

Returns

PriceInfo

Clone()

Clones this instance.

public OrderLine Clone()

Returns

OrderLine

The copy of the OrderLine.

Equals(object)

Determines whether the specified object is equal to the current object.

public override bool Equals(object obj)

Parameters

obj object

The object to compare with the current object.

Returns

bool

true if the specified object is equal to the current object; otherwise, false.

GetHashCode()

Serves as the default hash function.

public override int GetHashCode()

Returns

int

A hash code for the current object.

GetOrderLineFieldValue(string)

Gets the OrderLineFieldValue object.

public OrderLineFieldValue GetOrderLineFieldValue(string orderLineFieldSystemName)

Parameters

orderLineFieldSystemName string

System name of order line field

Returns

OrderLineFieldValue

GetPriceContext()

Gets price context information for the current order line.

public PriceContext GetPriceContext()

Returns

PriceContext

HasType(OrderLineType)

Determines whether this OrderLine has the given OrderLineType.

public bool HasType(OrderLineType orderLineType)

Parameters

orderLineType OrderLineType

The OrderLineType to compare this OrderLine to.

Returns

bool

HasType(IEnumerable<OrderLineType>)

Determines whether this OrderLine has the given OrderLineTypes.

public bool HasType(IEnumerable<OrderLineType> orderLineTypes)

Parameters

orderLineTypes IEnumerable<OrderLineType>

The list of OrderLineTypes to compare this OrderLine to.

Returns

bool