Class OrderLine
- Namespace
- Dynamicweb.Ecommerce.Orders
- Assembly
- Dynamicweb.Ecommerce.dll
Represents information about an order line.
[Serializable]
public class OrderLine
- Inheritance
-
OrderLine
- Inherited Members
Constructors
OrderLine(Order)
public OrderLine(Order order)
Parameters
order
Order
Fields
DisableRemoveFromCartRules
public bool DisableRemoveFromCartRules
Field Value
Properties
AllowOverridePrices
Indicated whether Price is overridden and not calculated. Used to set explicit PriceInfo values.
public bool AllowOverridePrices { get; set; }
Property Value
Attachment
Gets or sets the attachment.
public string Attachment { get; set; }
Property Value
Bom
Gets or sets a value indicating whether this OrderLine is BOM.
public bool Bom { get; set; }
Property Value
BomItemId
Gets or sets the BOM item ID.
public string BomItemId { get; set; }
Property Value
BomOrderLines
Gets or sets the BOM order lines.
public OrderLineCollection BomOrderLines { get; set; }
Property Value
Comment
Gets or sets the comment.
public string Comment { get; set; }
Property Value
Date
Gets or sets the date.
public DateTime Date { get; set; }
Property Value
DiscountId
Gets or sets the discount ID.
public string DiscountId { get; set; }
Property Value
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
Id
Gets or sets the ID.
public string Id { get; set; }
Property Value
ListId
Gets or sets the list ID.
public int ListId { get; set; }
Property Value
Modified
Gets or sets when the order line was modified.
public DateTime Modified { get; set; }
Property Value
Order
Gets or sets the order.
public Order Order { get; set; }
Property Value
OrderId
Gets or sets the order ID.
public string OrderId { get; set; }
Property Value
OrderLineFieldValues
Gets or sets the collection of OrderLineFieldValue objects.
public OrderLineFieldValueCollection OrderLineFieldValues { get; set; }
Property Value
OrderLineType
Gets or sets the order line type.
public OrderLineType OrderLineType { get; set; }
Property Value
PageId
Gets or sets the page ID.
public int PageId { get; set; }
Property Value
ParentLineId
Gets or sets the parent line ID.
public string ParentLineId { get; set; }
Property Value
Points
Returns number of points of OrderLine necessary for payment.
public double? Points { get; }
Property Value
Price
Gets the total price of the orderline, quantity * unitprice.
public PriceInfo Price { get; }
Property Value
Product
Gets or sets the product.
public Product Product { get; set; }
Property Value
ProductId
Gets or sets the product ID.
public string ProductId { get; set; }
Property Value
ProductName
Gets or sets the product name.
public string ProductName { get; set; }
Property Value
ProductNumber
Gets or sets the product number.
public string ProductNumber { get; set; }
Property Value
ProductVariantId
Gets or sets the product variant ID.
public string ProductVariantId { get; set; }
Property Value
ProductVariantText
Gets or sets the product variant text.
public string ProductVariantText { get; set; }
Property Value
Quantity
Gets or sets the quantity.
public double Quantity { get; set; }
Property Value
Reference
Gets or sets the reference.
public string Reference { get; set; }
Property Value
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
RewardValue
Gets or sets the order line reward points.
public double? RewardValue { get; }
Property Value
StockLocationId
Gets or sets the stock location.
public long StockLocationId { get; set; }
Property Value
TotalDiscount
Gets the discount value.
public PriceInfo TotalDiscount { get; }
Property Value
TotalPriceWithProductDiscounts
Returns the price with the product discounts applied to it.
public PriceInfo TotalPriceWithProductDiscounts { get; }
Property Value
UnitDiscount
Returns the unit discount.
public PriceInfo UnitDiscount { get; }
Property Value
UnitId
Gets or sets the unit ID.
public string UnitId { get; set; }
Property Value
UnitPoints
Returns points cost of product unit.
public double? UnitPoints { get; }
Property Value
UnitPrice
Gets or sets the unit price.
public PriceInfo UnitPrice { get; set; }
Property Value
UnitPriceBeforeDiscount
Gets or sets the price per unit without discounts.
public double UnitPriceBeforeDiscount { get; }
Property Value
UnitPriceInfoBeforeDiscount
public PriceInfo UnitPriceInfoBeforeDiscount { get; }
Property Value
UnitPriceWithProductDiscount
Returns the unit price with the product discount applied to it.
public PriceInfo UnitPriceWithProductDiscount { get; }
Property Value
UnitRewardPoints
Returns information about the points which will be rewarded to the user for one unit of product.
public PointInfo UnitRewardPoints { get; }
Property Value
UnitRewardValue
Gets or sets unit reward points.
public double? UnitRewardValue { get; }
Property Value
Volume
Gets the volume.
public double Volume { get; }
Property Value
Weight
Gets the weight.
public double Weight { get; }
Property Value
Methods
Clone()
Clones this instance.
public OrderLine Clone()
Returns
Equals(object)
Determines whether the specified object is equal to the current object.
public override bool Equals(object obj)
Parameters
obj
objectThe object to compare with the current object.
Returns
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
stringSystem name of order line field
Returns
GetPriceContext()
Gets price context information for the current order line.
public PriceContext GetPriceContext()
Returns
HasType(OrderLineType)
Determines whether this OrderLine has the given OrderLineType.
public bool HasType(OrderLineType orderLineType)
Parameters
orderLineType
OrderLineTypeThe OrderLineType to compare this OrderLine to.
Returns
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.