Class Order

Inheritance
System.Object
Order
Namespace: DirectScale.Disco.Extension
Assembly: DirectScale.Disco.Extension.Abstractions.dll
Syntax
public class Order : Object

Constructors

Order()

Declaration
public Order()

Properties

AffiliateId

The associateId of the affiliate for the order in the application.

Declaration
public Nullable<int> AffiliateId { get; set; }
Property Value
Type Description
System.Nullable<System.Int32>

AssociateId

The AssociateId of the associate that placed the order.

Declaration
public int AssociateId { get; set; }
Property Value
Type Description
System.Int32

BackofficeId

The BackOfficeId of the associate that placed the order.

Declaration
public string BackofficeId { get; set; }
Property Value
Type Description
System.String

BillAddress

This is actually the shipping address. Billing address is passed in when the order is created, and not saved.

Declaration
public Address BillAddress { get; set; }
Property Value
Type Description
Address
See Also

BillPhone

Phone number provided for this order.

Declaration
public string BillPhone { get; set; }
Property Value
Type Description
System.String

CanRerun

Indicates if the order has been declined or rejected and is okay to re-try payment.

Declaration
public bool CanRerun { get; }
Property Value
Type Description
System.Boolean

CommissionDate

This is the date the commission engine uses to determine which period this order occurred in. Usually this will be the same as InvoiceDate.

Declaration
public DateTime CommissionDate { get; set; }
Property Value
Type Description
System.DateTime
See Also
IsLocked(System.DateTime)

Custom

These custom fields are provided as a convenient way to store custom supplimentary data about this order. This data is never used by base code, but can be read and written to from client code.

Declaration
public CustomFields Custom { get; set; }
Property Value
Type Description
CustomFields
Remarks

These custom values will be written to ORD_CustomFields and will be the same as Custom. These are separate from other custom fields which can be tied to associates, autoships, and inventory items.

See Also

Email

The EmailAddress of the associate that placed the order.

Declaration
public string Email { get; set; }
Property Value
Type Description
System.String

InvoiceDate

The date the order was paid.

Declaration
public DateTime InvoiceDate { get; set; }
Property Value
Type Description
System.DateTime
See Also

IsMoveable

Unused. Do not use. Use IsMoveOrderPermitted(Order) instead.

Declaration
public MoveOrderPermission IsMoveable { get; set; }
Property Value
Type Description
MoveOrderPermission
See Also

IsPaid

Indicates if the order has been paid in full.

Declaration
public bool IsPaid { get; set; }
Property Value
Type Description
System.Boolean
Remarks

Should always be true if Status equals Paid

IsShipped

Indicates if all of the Packages for this order have been shipped.

Declaration
public bool IsShipped { get; set; }
Property Value
Type Description
System.Boolean

LastModifiedDate

The DateTime of the last time this record was modified.

Declaration
public DateTime LastModifiedDate { get; set; }
Property Value
Type Description
System.DateTime

LineItems

All of the items in this order.

Declaration
public List<OrderLineItem> LineItems { get; set; }
Property Value
Type Description
System.Collections.Generic.List<OrderLineItem>

LocalInvoiceNumber

The invoice number of this order placed in BillAddress country.

Declaration
public int LocalInvoiceNumber { get; set; }
Property Value
Type Description
System.Int32

Name

The Name of the associate that placed the order.

Declaration
public string Name { get; set; }
Property Value
Type Description
System.String

OrderCoupons

All of the coupons applied to the order.

Declaration
public List<OrderCoupon> OrderCoupons { get; set; }
Property Value
Type Description
System.Collections.Generic.List<OrderCoupon>

OrderDate

The Date the order was placed.

Declaration
public DateTime OrderDate { get; set; }
Property Value
Type Description
System.DateTime
See Also

OrderNumber

The order's main identification number.

Declaration
public int OrderNumber { get; set; }
Property Value
Type Description
System.Int32
Remarks

This is the order's DB recordnumber.

OrderSource

Indicates where this order was created from.

Declaration
public OrderSource OrderSource { get; set; }
Property Value
Type Description
OrderSource

OrderType

Indicates where the order was initiated from.

Declaration
public OrderType OrderType { get; set; }
Property Value
Type Description
OrderType

Packages

All of the packages being shipped.

Declaration
public List<OrderPackage> Packages { get; set; }
Property Value
Type Description
System.Collections.Generic.List<OrderPackage>

PartyId

Declaration
public int PartyId { get; set; }
Property Value
Type Description
System.Int32

Payments

All of the payment methods applied to this order.

Declaration
public List<OrderPayment> Payments { get; set; }
Property Value
Type Description
System.Collections.Generic.List<OrderPayment>
Remarks

Often there is only one. One examle of when there could be multiple is if the associate pays some of the order with reward points.

PriceGroupId

The order's price group

Declaration
public int PriceGroupId { get; set; }
Property Value
Type Description
System.Int32

SpecialInstructions

Special instructions or additional notes for the order.

Declaration
public string SpecialInstructions { get; set; }
Property Value
Type Description
System.String
Remarks

Orders can be searched for with this field by GetOrdersByAssociateId(Int32, String)

Status

Indicates the status of the order.

Declaration
public string Status { get; set; }
Property Value
Type Description
System.String
See Also

TotalBonus

Total bonus from this order.

Declaration
public double TotalBonus { get; set; }
Property Value
Type Description
System.Double
Remarks

The sum of DirectScale.Disco.Extension.Order._lineItems's Bonus.

TotalCost

Subtotal cost of the order.

Declaration
public double TotalCost { get; set; }
Property Value
Type Description
System.Double
Remarks

The sum of DirectScale.Disco.Extension.Order._lineItems's Costs.

TotalCV

Commission Volume generated from this order.

Declaration
public double TotalCV { get; set; }
Property Value
Type Description
System.Double
Remarks

The sum of DirectScale.Disco.Extension.Order._lineItems's CV.

TotalQV

Qualified Volume generated from this order.

Declaration
public double TotalQV { get; set; }
Property Value
Type Description
System.Double
Remarks

The sum of DirectScale.Disco.Extension.Order._lineItems's QV.

TotalRewardPoints

Total Reward Points generated from this order.

Declaration
public double TotalRewardPoints { get; set; }
Property Value
Type Description
System.Double
Remarks

The sum of DirectScale.Disco.Extension.Order._lineItems's RewardPoints.

Totals

Detailed break down of charges.

Declaration
public List<OrderTotal> Totals { get; set; }
Property Value
Type Description
System.Collections.Generic.List<OrderTotal>
Remarks

Usually this will only contain one element, in some cases an assocaite can split the payment and pay with multiple currencies and each currency will have it's own OrderTotal

See Also

USDSubTotal

A helper to get all Totals's SubTotals converted to USD.

Declaration
public double USDSubTotal { get; }
Property Value
Type Description
System.Double

USDTotal

A helper to get all Totals's Totals converted to USD.

Declaration
public double USDTotal { get; }
Property Value
Type Description
System.Double

Void

If this is true, this order is essentially deleted, and will be ignored by most processes.

Declaration
public bool Void { get; set; }
Property Value
Type Description
System.Boolean

Methods

SetUSDTotals(Double, Double)

Internal use only.

Declaration
public void SetUSDTotals(double subTotal, double total)
Parameters
Type Name Description
System.Double subTotal
System.Double total