Class NewOrderDetail
This is the information needed to create a new order.
Inheritance
Namespace: DirectScale.Disco.Extension
Assembly: DirectScale.Disco.Extension.Abstractions.dll
Syntax
public class NewOrderDetail : Object
Remarks
All fields required unless otherwise noted.
Constructors
NewOrderDetail()
Defaults CurrencyCode to "USD"
Declaration
public NewOrderDetail()
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 associate placing the order.
Declaration
public int AssociateId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
See Also
AssociateType
This is the associate's type, which is used to determine pricing.
Declaration
public int AssociateType { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
See Also
Attention
Unused. Do not use.
Declaration
public string Attention { get; set; }
Property Value
Type | Description |
---|---|
System.String |
CommissionDate
Unused. Will be ignored by SubmitOrder(NewOrderDetail, NewPayment[]). Because this is a new order, the current time will be used. CommissionDate to change.
Declaration
public DateTime CommissionDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
CouponCodes
Coupon codes to apply to order.
Declaration
public string[] CouponCodes { get; set; }
Property Value
Type | Description |
---|---|
System.String[] |
Remarks
Optional.
See Also
CurrencyCode
The currency to use for the order.
Declaration
public string CurrencyCode { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
If Autoship is not null, it will use this same CurrencyCode.
See Also
Custom
Custom values that may be provided which tied to the order and available to use 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
InvoiceDate
Unused. Do not use.
Declaration
public DateTime InvoiceDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
LineItems
These are the details of the items being purchased.
Declaration
public LineItem[] LineItems { get; set; }
Property Value
Type | Description |
---|---|
LineItem[] |
See Also
OrderSource
The source of order being placed. When creating orders through the extension, the order source will default to OrderSource.CustomExtension
Declaration
public OrderSource OrderSource { get; set; }
Property Value
Type | Description |
---|---|
OrderSource |
See Also
OrderType
The type of order being placed.
Declaration
public OrderType OrderType { get; set; }
Property Value
Type | Description |
---|---|
OrderType |
See Also
PartyId
Sets the party id for the order.
Declaration
public int PartyId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
PriceGroupId
The price group for the order
Declaration
public int PriceGroupId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
ShipAddress
This is the address to ship the items to.
Declaration
public Address ShipAddress { get; set; }
Property Value
Type | Description |
---|---|
Address |
See Also
ShipByDate
Unused. Do not use.
Declaration
public DateTime ShipByDate { get; set; }
Property Value
Type | Description |
---|---|
System.DateTime |
ShipMethodId
The ship method selected for this order.
Declaration
public int ShipMethodId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
See Also
ShipPhone
Phone number provided for this order.
Declaration
public string ShipPhone { get; set; }
Property Value
Type | Description |
---|---|
System.String |
Remarks
Defaults to PrimaryPhone.
ShipTaxOverride
Used to manually set shipping or tax costs.
Declaration
public ShippingTaxOverride ShipTaxOverride { get; set; }
Property Value
Type | Description |
---|---|
ShippingTaxOverride |
Remarks
Optional. If null, shipping is calculated from ShipMethodId, and tax is calculated by the selected tax provider.
See Also
ShipToName
Name that should appear on shipped packages.
Declaration
public string ShipToName { get; set; }
Property Value
Type | Description |
---|---|
System.String |
SpecialInstructions
Sets special instructions or additional notes on the order. Can be used to search for order later on.
Declaration
public string SpecialInstructions { get; set; }
Property Value
Type | Description |
---|---|
System.String |
See Also
StoreId
The store that is being used for this order.
Declaration
public int StoreId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
See Also
WarehouseId
The warehouse these items will be shipped from.
Declaration
public int WarehouseId { get; set; }
Property Value
Type | Description |
---|---|
System.Int32 |
Remarks
Defaults to