OrderReadOnly
A Vendr read only Order entity
public class OrderReadOnly : StoreAggregateBase<OrderReadOnly, Order, OrderState>,
IHasReadableOrderLines, IHasReadableProperties
Inheritance
- class StoreAggregateBase<TReadOnlySelf,TWritableSelf,TState>
- interface IHasReadableOrderLines
- interface IHasReadableProperties
Namespace
Properties
CartNumber
Gets the Cart Number of the order
public string CartNumber { get; }
CopiedFromOrderId
Gets the ID of a parent order this order was copied from
public Guid? CopiedFromOrderId { get; }
CreateDate
Gets the DateTime the order was created
public DateTime CreateDate { get; }
CurrencyId
Gets the ID of the Currency
of the order
public Guid CurrencyId { get; }
CustomerInfo
Gets the OrderCustomerInfo
of the order
public OrderCustomerInfo CustomerInfo { get; }
DiscountCodes
Gets a list of discount codes applied to the order
public IReadOnlyCollection<AppliedDiscountCode> DiscountCodes { get; }
Discounts
Gets a list of discounts applies to the order
public IReadOnlyCollection<FulfilledDiscount> Discounts { get; }
FinalizedDate
Gets the DateTime the order was finalized
public DateTime? FinalizedDate { get; }
GiftCards
Gets a list of gift cards applied to the order
public IReadOnlyCollection<AppliedGiftCard> GiftCards { get; }
IsFinalized
Gets a boolean flag indicating whether the order is finalized
public virtual bool IsFinalized { get; }
IsFinalizing
Gets a boolean flag indicating whether the order is currently being finalized
public virtual bool IsFinalizing { get; }
IsProcessing
Gets a boolean flag indicating whether the order is currently being processed by a payment gateway
public virtual bool IsProcessing { get; }
LanguageIsoCode
Gets the ISO Code of the Language of the order
public string LanguageIsoCode { get; }
OrderLines
Gets the order lines of the order
public IReadOnlyCollection<OrderLineReadOnly> OrderLines { get; }
OrderNumber
Gets the order Number of the order
public string OrderNumber { get; }
OrderStatusCode
Gets the OrderStatusCode
of the OrderStatus
of the order
public OrderStatusCode OrderStatusCode { get; }
OrderStatusId
Gets the ID of the OrderStatus
of the order
public Guid OrderStatusId { get; }
PaymentInfo
Gets the OrderPaymentInfo
of the order
public OrderPaymentInfo PaymentInfo { get; }
Properties
Gets the properties collection of the order
public IReadOnlyDictionary<string, PropertyValue> Properties { get; }
ShippingInfo
Gets the OrderShippingInfo
of the order
public OrderShippingInfo ShippingInfo { get; }
SubtotalPrice
Gets the subtotal price of the order
public ReadOnlyOrderSubtotalPrice SubtotalPrice { get; }
TaxClassId
Gets the ID of the TaxClass
of the order
public Guid TaxClassId { get; }
TaxRate
Gets the TaxRate
of the order
public TaxRate TaxRate { get; }
TotalPrice
Gets the total price of the order
public ReadOnlyOrderTotalPrice TotalPrice { get; }
TotalQuantity
Gets the total quantity of all order line items in the order
public decimal TotalQuantity { get; }
TransactionInfo
Gets the OrderTransactionInfo
of the order
public OrderTransactionInfo TransactionInfo { get; }
UpdateDate
Gets the DateTime the order was last updated
public DateTime UpdateDate { get; }
Methods
GetBundle
Gets a bundle order line by bundle ID
public OrderLineReadOnly GetBundle(string bundleId)
Parameters
Parameter | Description |
---|---|
bundleId |
The bundle ID of the order line to fetch |
Returns
An OrderLineReadOnly
entity for the order line
GetOrderLine
Get an order line by ID
public OrderLineReadOnly GetOrderLine(Guid orderLineId)
Parameters
Parameter | Description |
---|---|
orderLineId |
The ID of the order line to fetch |
Returns
An OrderLineReadOnly
entity for the order line