Class Order

Namespace

Rescope.Commerce.Core.Entities

Assembly

Rescope.Commerce.Core.dll

Orders are created by the BasketService.InitiatePayment after a basket has been completed.

[JsonObject(NamingStrategyType = typeof(CamelCaseNamingStrategy))]
public class Order : IEntity

Inheritance

object

Order

Implements

IEntity

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AdditionalData

public Dictionary<string, string> AdditionalData { get; set; }

Property Value

Dictionary<string, string>

BasketLineItems

[NotMapped]
public IEnumerable<OrderLineItem> BasketLineItems { get; }

Property Value

IEnumerable<OrderLineItem>

BillingAddress

public PostalAddress? BillingAddress { get; set; }

Property Value

PostalAddress

CancelUrl

public string? CancelUrl { get; set; }

Property Value

string

ConfirmUrl

public string? ConfirmUrl { get; set; }

Property Value

string

CreatedAt

public DateTime CreatedAt { get; set; }

Property Value

DateTime

Currency

public Currency Currency { get; }

Property Value

Currency

CurrencyId

public Guid CurrencyId { get; }

Property Value

Guid

CustomData

public string? CustomData { get; set; }

Property Value

string

DeliveryAddress

public PostalAddress? DeliveryAddress { get; set; }

Property Value

PostalAddress

Email

public string? Email { get; set; }

Property Value

string

Id

public Guid Id { get; }

Property Value

Guid

Notes

public string? Notes { get; set; }

Property Value

string

NotificationLogs

public IEnumerable<OrderNotificationLog> NotificationLogs { get; }

Property Value

IEnumerable<OrderNotificationLog>

OrderNumber

public string? OrderNumber { get; }

Property Value

string

OrderStatus

public OrderStatus OrderStatus { get; set; }

Property Value

OrderStatus

OutOfStock

public bool? OutOfStock { get; set; }

Property Value

bool?

PaymentLogs

public IEnumerable<OrderPaymentLog> PaymentLogs { get; }

Property Value

IEnumerable<OrderPaymentLog>

PaymentMethod

public PaymentMethod? PaymentMethod { get; set; }

Property Value

PaymentMethod

PaymentMethodId

public Guid? PaymentMethodId { get; set; }

Property Value

Guid?

PaymentReceived

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal PaymentReceived { get; }

Property Value

decimal

PaymentStatus

public PaymentStatus PaymentStatus { get; set; }

Property Value

PaymentStatus

Phone

public string? Phone { get; set; }

Property Value

string

ShippingLabelData

public string? ShippingLabelData { get; set; }

Property Value

string

ShippingMethod

public ShippingMethod? ShippingMethod { get; set; }

Property Value

ShippingMethod

ShippingMethodId

public Guid? ShippingMethodId { get; set; }

Property Value

Guid?

ShippingPrice

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal ShippingPrice { get; }

Property Value

decimal

ShippingPriceFormatted

public string ShippingPriceFormatted { get; }

Property Value

string

ShippingTax

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal ShippingTax { get; }

Property Value

decimal

ShippingTaxFormatted

public string ShippingTaxFormatted { get; }

Property Value

string

Store

public Store Store { get; }

Property Value

Store

StoreId

public Guid StoreId { get; }

Property Value

Guid

TotalLineItemsTax

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal TotalLineItemsTax { get; }

Property Value

decimal

TotalLineItemsTaxFormatted

public string TotalLineItemsTaxFormatted { get; }

Property Value

string

TotalPrice

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal TotalPrice { get; }

Property Value

decimal

TotalPriceFormatted

public string TotalPriceFormatted { get; }

Property Value

string

TotalShippingPrice

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal TotalShippingPrice { get; }

Property Value

decimal

TotalShippingPriceFormatted

public string TotalShippingPriceFormatted { get; }

Property Value

string

TotalTax

[Column(TypeName = "DECIMAL(19, 4)")]
public decimal TotalTax { get; }

Property Value

decimal

TotalTaxFormatted

public string TotalTaxFormatted { get; }

Property Value

string

TrackingNumber

public string? TrackingNumber { get; set; }

Property Value

string

UmbracoMemberKey

public Guid? UmbracoMemberKey { get; set; }

Property Value

Guid?

UpdatedAt

public DateTime? UpdatedAt { get; set; }

Property Value

DateTime?

Methods

FormatNumber(decimal)

Format a decimal using this order's selected currency

public string FormatNumber(decimal number)

Parameters

number decimal

Returns

string

GetIdHash()

public string GetIdHash()

Returns

string