Class Order

Namespace

Dynamicweb.Ecommerce.Orders

Assembly

Dynamicweb.Ecommerce.dll

Represents information about an order.

[Serializable]
public class Order : IWithPrice

Inheritance

object

Order

Implements

IWithPrice

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

Order()

Initializes a new instance of the Order class.

[Obsolete("Use constructor which takes currency, country and language")]
public Order()

Order(Currency, Country, Language)

Initializes a new instance of the Order class.

public Order(Currency currency, Country country, Language language)

Parameters

currency Currency

country Country

language Language

Order(IDataReader)

Initializes a new instance of the Order class.

[Obsolete("This method is no longer used.")]
public Order(IDataReader dataReader)

Parameters

dataReader IDataReader

The DataReader with the properties.

Properties

AddressValidatorResults

Gets the address validator results.

public List<AddressValidatorResult> AddressValidatorResults { get; set; }

Property Value

List<AddressValidatorResult>

AllowOverridePrices

Indicated whether Price is overridden and not calculated. Used to set explicit PriceInfo values.

public bool AllowOverridePrices { get; set; }

Property Value

bool

AutoId

Gets the Order Auto ID.

public int AutoId { get; }

Property Value

int

BoughtGiftCards

Gets the Order GiftCards if any are bought.

public IEnumerable<GiftCard> BoughtGiftCards { get; }

Property Value

IEnumerable<GiftCard>

Calculate

Gets a value indicating whether this Order is calculated (is in the cart state).

public bool Calculate { get; }

Property Value

bool

true if calculated; otherwise, false.

CaptureAmount

Gets or sets the captured amount.

public double CaptureAmount { get; set; }

Property Value

double

CaptureInfo

Gets or sets the capture info.

public OrderCaptureInfo CaptureInfo { get; set; }

Property Value

OrderCaptureInfo

CartV2StepIndex

Gets or sets the index of the current step(CartV2).

public int CartV2StepIndex { get; set; }

Property Value

int

CheckoutHandler

Gets the selected checkout handler (CartV2).

public CheckoutHandler CheckoutHandler { get; }

Property Value

CheckoutHandler

CheckoutPageId

Gets or sets the PageID where was checkout step.

public int CheckoutPageId { get; set; }

Property Value

int

Comment

Gets or sets the comment.

public string Comment { get; set; }

Property Value

string

Complete

Gets or sets a value indicating whether this Order is completed. Non-completed orders are displayed in red, meaning that the ordering process was interrupted prior to finishing the final step.

public bool Complete { get; set; }

Property Value

bool

true if complete; otherwise, false.

CompletedDate

Gets or sets the date when order was completed.

public DateTime? CompletedDate { get; set; }

Property Value

DateTime?

Currency

Gets the currency.

public Currency Currency { get; }

Property Value

Currency

CurrencyCode

Gets or sets the currency code.

public string CurrencyCode { get; set; }

Property Value

string

CurrencyName

Gets or sets the currency name.

public string CurrencyName { get; set; }

Property Value

string

CurrencyRate

Gets or sets the currency rate on the order creation date.

public double CurrencyRate { get; set; }

Property Value

double

CustomerAccepted

Gets or sets a value indicating whether customer has accepted order terms and conditions.

public bool CustomerAccepted { get; set; }

Property Value

bool

true if customer was accepted; otherwise, false.

CustomerAccessUserId

Gets or sets the customer access user ID.

public int CustomerAccessUserId { get; set; }

Property Value

int

CustomerAccessUserUserName

Gets or sets the customer access user name.

public string CustomerAccessUserUserName { get; set; }

Property Value

string

CustomerAddress

Gets or sets the customer address.

public string CustomerAddress { get; set; }

Property Value

string

CustomerAddress2

Gets or sets the customer address2.

public string CustomerAddress2 { get; set; }

Property Value

string

CustomerAddressId

Gets or sets the ID of the UserAddress

public int CustomerAddressId { get; set; }

Property Value

int

CustomerCell

Gets or sets the customer cell.

public string CustomerCell { get; set; }

Property Value

string

CustomerCity

Gets or sets the customer city.

public string CustomerCity { get; set; }

Property Value

string

CustomerComment

Gets or sets the customer comment.

public string CustomerComment { get; set; }

Property Value

string

CustomerCompany

Gets or sets the customer company.

public string CustomerCompany { get; set; }

Property Value

string

CustomerCountry

Gets or sets the customer country.

public string CustomerCountry { get; set; }

Property Value

string

CustomerCountryCode

Gets or sets the customer country code.

public string CustomerCountryCode { get; set; }

Property Value

string

CustomerEan

Gets or sets the customer EAN.

public string CustomerEan { get; set; }

Property Value

string

CustomerEmail

Gets or sets the customer email.

public string CustomerEmail { get; set; }

Property Value

string

CustomerFax

Gets or sets the customer fax.

public string CustomerFax { get; set; }

Property Value

string

CustomerFirstName

Gets or sets the customer first name.

public string CustomerFirstName { get; set; }

Property Value

string

CustomerHouseNumber

Gets or sets the customer house number.

public string CustomerHouseNumber { get; set; }

Property Value

string

CustomerInitials

Gets or sets the customer initials.

public string CustomerInitials { get; set; }

Property Value

string

CustomerMiddleName

Gets or sets the customer middle name.

public string CustomerMiddleName { get; set; }

Property Value

string

CustomerName

Gets or sets the customer name.

public string CustomerName { get; set; }

Property Value

string

CustomerNumber

Gets or sets the customer number.

public string CustomerNumber { get; set; }

Property Value

string

CustomerPhone

Gets or sets the customer phone.

public string CustomerPhone { get; set; }

Property Value

string

CustomerPrefix

Gets or sets the customer prefix.

public string CustomerPrefix { get; set; }

Property Value

string

CustomerRefId

Gets or sets the customer reference ID.

public string CustomerRefId { get; set; }

Property Value

string

CustomerRegion

Gets or sets the customer region.

public string CustomerRegion { get; set; }

Property Value

string

CustomerSurname

Gets or sets the customer surname.

public string CustomerSurname { get; set; }

Property Value

string

CustomerTitle

Gets or sets the customer title.

public string CustomerTitle { get; set; }

Property Value

string

CustomerVatRegNumber

Gets or sets the customer VAT registration number.

public string CustomerVatRegNumber { get; set; }

Property Value

string

CustomerZip

Gets or sets the customer zip code.

public string CustomerZip { get; set; }

Property Value

string

Date

Gets or sets the order creation date.

public DateTime Date { get; set; }

Property Value

DateTime

DateCount

Gets or sets the date count.

public int DateCount { get; set; }

Property Value

int

Deleted

Gets or sets a value indicating whether this Order is deleted. When administrator delete the order it only marked as deleted.

public bool Deleted { get; set; }

Property Value

bool

true if deleted; otherwise, false.

DeliveryAddress

Gets or sets the delivery address.

public string DeliveryAddress { get; set; }

Property Value

string

DeliveryAddress2

Gets or sets the delivery address2.

public string DeliveryAddress2 { get; set; }

Property Value

string

DeliveryAddressId

Gets or sets the ID of the UserAddress

public int DeliveryAddressId { get; set; }

Property Value

int

DeliveryCell

Gets or sets the delivery cell.

public string DeliveryCell { get; set; }

Property Value

string

DeliveryCity

Gets or sets the delivery city.

public string DeliveryCity { get; set; }

Property Value

string

DeliveryCompany

Gets or sets the delivery company.

public string DeliveryCompany { get; set; }

Property Value

string

DeliveryCountry

Gets or sets the delivery country.

public string DeliveryCountry { get; set; }

Property Value

string

DeliveryCountryCode

Gets or sets the delivery country code.

public string DeliveryCountryCode { get; set; }

Property Value

string

DeliveryEmail

Gets or sets the delivery email.

public string DeliveryEmail { get; set; }

Property Value

string

DeliveryFax

Gets or sets the delivery fax.

public string DeliveryFax { get; set; }

Property Value

string

DeliveryFirstName

Gets or sets the delivery first name.

public string DeliveryFirstName { get; set; }

Property Value

string

DeliveryHouseNumber

Gets or sets the delivery house number.

public string DeliveryHouseNumber { get; set; }

Property Value

string

DeliveryInitials

Gets or sets the delivery initials.

public string DeliveryInitials { get; set; }

Property Value

string

DeliveryMiddleName

Gets or sets the delivery middle name.

public string DeliveryMiddleName { get; set; }

Property Value

string

DeliveryName

Gets or sets the delivery name.

public string DeliveryName { get; set; }

Property Value

string

DeliveryPhone

Gets or sets the delivery phone.

public string DeliveryPhone { get; set; }

Property Value

string

DeliveryPrefix

Gets or sets the delivery prefix.

public string DeliveryPrefix { get; set; }

Property Value

string

DeliveryRegion

Gets or sets the delivery region.

public string DeliveryRegion { get; set; }

Property Value

string

DeliverySurname

Gets or sets the delivery surname.

public string DeliverySurname { get; set; }

Property Value

string

DeliveryTitle

Gets or sets the delivery title.

public string DeliveryTitle { get; set; }

Property Value

string

DeliveryZip

Gets or sets the delivery ZIP.

public string DeliveryZip { get; set; }

Property Value

string

DisableDiscountCalculation

public bool DisableDiscountCalculation { get; set; }

Property Value

bool

DiscountAmount

Gets or sets the discount amount that can be used for custom discounts on the order

public double DiscountAmount { get; set; }

Property Value

double

DiscountPercentage

Gets or sets the discount percentage that can be used for custom discounts on the order

public double DiscountPercentage { get; set; }

Property Value

double

DisplayName

Gets or sets the order name

public string DisplayName { get; set; }

Property Value

string

DoSaveCardToken

Gets or sets the value indicating whether to save card.

public bool DoSaveCardToken { get; set; }

Property Value

bool

Errors

Gets or sets the errors.

public ArrayList Errors { get; set; }

Property Value

ArrayList

ExternalPaymentFee

Get or set the external payment fee.

public double ExternalPaymentFee { get; set; }

Property Value

double

FieldsXml

Gets or sets the fields XML.

public string FieldsXml { get; set; }

Property Value

string

FixedId

Gets the fixed ID.

public int FixedId { get; }

Property Value

int

Gateway

Gets the selected payment gateway (CartV1).

[Obsolete]
public GatewayProvider Gateway { get; }

Property Value

GatewayProvider

GatewayPaymentStatus

Gets or sets the gateway payment status(Paid, Rejected etc).

public string GatewayPaymentStatus { get; set; }

Property Value

string

GatewayResult

Gets or sets the result from the payment gateway.

public string GatewayResult { get; set; }

Property Value

string

GatewayTransactionProblems

Gets the gateway transaction problems.

public List<string> GatewayTransactionProblems { get; }

Property Value

List<string>

GatewayUniqueId

Gets or sets the gateway unique ID.

public string GatewayUniqueId { get; set; }

Property Value

string

GiftCardTransactionFailed

Gets or sets the Order GiftCard transactions failed status.

public bool GiftCardTransactionFailed { get; set; }

Property Value

bool

HasSetUserDetails

Gets or sets a value indicating whether the customer data has been filled in.

public bool HasSetUserDetails { get; set; }

Property Value

bool

true if this instance has set user details; otherwise, false.

HasShippingDocument

Determines whether the shipping document values is empty or not.

public bool HasShippingDocument { get; }

Property Value

bool

Icon

Gets the icon file name of the order payment method.

[Obsolete("Use Icon or IconOrderList property on the associated payment.")]
public string Icon { get; }

Property Value

string

Id

Gets or sets the Order ID.

public string Id { get; set; }

Property Value

string

IdWithIcon

Gets the ID with icon.

[Obsolete("No longer in use.")]
public string IdWithIcon { get; }

Property Value

string

InfoDirectProviderErrors

Gets the Info Direct service errors.

public List<string> InfoDirectProviderErrors { get; }

Property Value

List<string>

IntegrationOrderId

Gets or sets the integration order ID.

public string IntegrationOrderId { get; set; }

Property Value

string

Ip

Gets or sets the customer's IP.

public string Ip { get; set; }

Property Value

string

IsCaptureSupported

Return "true" if the payment method of this order supports remote capture feature. Capturing an order allows to withdraw or cancel payment directly while order placement. In this case, user does not need to log in the gateway administration system to be able to cancel the order.

public bool IsCaptureSupported { get; }

Property Value

bool

IsCart

Gets or sets a value indicating whether order has "cart" status. The order will have "cart" status until customer confirms the payment.

public bool IsCart { get; set; }

Property Value

bool

true if this instance is cart; otherwise, false.

IsCartEditable

Gets or sets a value indicating whether this order could be edited while it is in a cart.

public bool IsCartEditable { get; }

Property Value

bool

true if this instance is could be edited while it is in a cart; otherwise, false.

IsExported

Determines whether order was exported.

public bool IsExported { get; set; }

Property Value

bool

IsLedgerEntry

Gets or sets a value indicating whether this is a "ledger entry".

public bool IsLedgerEntry { get; set; }

Property Value

bool

true if this instance is ledger entry; otherwise, false.

IsPartialCaptureSupported

Return "true" if the payment method of this order supports remote capture feature. Capturing an order allows to withdraw or cancel payment directly while order placement. In this case, user does not need to log in the gateway administration system to be able to cancel the order.

public bool IsPartialCaptureSupported { get; }

Property Value

bool

IsPayable

Gets or sets a value indicating whether this order can be "payed".

public bool IsPayable { get; set; }

Property Value

bool

true if this instance is payable; otherwise, false.

IsPaymentSet

Gets a value indicating whether the payment method is set.

[Obsolete("Does not work.")]
public bool IsPaymentSet { get; }

Property Value

bool

true if this instance is payment set; otherwise, false.

IsPriceCalculatedByProvider

Gets or sets a value indicating whether prices are calculated by a provider.

public bool IsPriceCalculatedByProvider { get; set; }

Property Value

bool

true if prices are calculated by a provider; otherwise, false.

IsQuote

Gets or sets a value indicating whether this is an "order" or a "quote".

public bool IsQuote { get; set; }

Property Value

bool

true if this instance is quote; otherwise, false.

IsRecurringOrderTemplate

Gets or sets a value indicating whether this is an "order" or a "Recurring order template".

public bool IsRecurringOrderTemplate { get; set; }

Property Value

bool

true if this instance is recurring order; otherwise, false.

IsShippingDocumentSupported

Determines whether the shipping document is supported.

public bool IsShippingDocumentSupported { get; }

Property Value

bool

Language

public Language Language { get; }

Property Value

Language

LanguageId

Gets or sets the order language ID.

public string LanguageId { get; set; }

Property Value

string

LedgerType

Gets or sets the ledger type.

public string LedgerType { get; set; }

Property Value

string

Modified

Gets or sets the date when order was modified.

public DateTime Modified { get; set; }

Property Value

DateTime

NewsletterSubscribe

Gets or sets a value indicating whether customer was subscribed for a newsletter.

public bool NewsletterSubscribe { get; set; }

Property Value

bool

true if newsletter was subscribed; otherwise, false.

OrderContextId

Gets or sets the order context ID.

public string OrderContextId { get; set; }

Property Value

string

OrderField

Gets the order field.

[Obsolete("Use OrderFields instead.")]
public OrderField OrderField { get; }

Property Value

OrderField

OrderFields

Gets the custom order fields.

public OrderFieldCollection OrderFields { get; }

Property Value

OrderFieldCollection

OrderFieldValues

Gets or sets the custom order field values.

public OrderFieldValueCollection OrderFieldValues { get; set; }

Property Value

OrderFieldValueCollection

OrderLines

Gets the collection of all order lines.

public OrderLineCollection OrderLines { get; }

Property Value

OrderLineCollection

OrderState

Gets the current order state, e.g. Completed, New, Important etc.

public OrderState OrderState { get; }

Property Value

OrderState

OrderStates

Gets the order states collection with the current order state.

[Obsolete("Use OrderState instead")]
public OrderStateCollection OrderStates { get; }

Property Value

OrderStateCollection

ParentOrderId

Gets or sets the parent Order ID.

public string ParentOrderId { get; set; }

Property Value

string

PaymentCountrySelection

Gets or sets the country for shipping.

public CountrySelectionForMethod PaymentCountrySelection { get; set; }

Property Value

CountrySelectionForMethod

PaymentFee

Gets the payment fee.

public PriceInfo PaymentFee { get; }

Property Value

PriceInfo

PaymentMethod

Gets or sets the payment method name.

public string PaymentMethod { get; set; }

Property Value

string

PaymentMethodCode

Gets or sets the payment method Code.

public string PaymentMethodCode { get; set; }

Property Value

string

PaymentMethodDescription

Gets or sets the payment method description.

public string PaymentMethodDescription { get; set; }

Property Value

string

PaymentMethodId

Gets or sets the payment method ID.

public string PaymentMethodId { get; set; }

Property Value

string

PaymentMethodTermsCode

Gets or sets the payment method terms code.

public string PaymentMethodTermsCode { get; set; }

Property Value

string

PaymentRecurringInfo

Gets or sets payment provider recurring order information(recurring identity, user profiles, any information needed for payment provider).

public string PaymentRecurringInfo { get; set; }

Property Value

string

PointsToUse

Gets or sets the amount of loyalty points to use for pay.

public double PointsToUse { get; set; }

Property Value

double

Price

Gets the price, including payment and shipping fees.

public PriceInfo Price { get; }

Property Value

PriceInfo

PriceBeforeFees

Gets the price without payment and shipping fees.

public PriceInfo PriceBeforeFees { get; }

Property Value

PriceInfo

The price before fees.

PriceCalculationDate

Gets or sets the price calculation date on order.

public DateTime? PriceCalculationDate { get; set; }

Property Value

DateTime?

ProductOrderLines

Gets an OrderLineCollection containing all OrderLine objects where OrderLine.Product is not null.

public OrderLineCollection ProductOrderLines { get; }

Property Value

OrderLineCollection

Remarks

Order lines with gift card product are not included

Products

Gets the collection of all ordered products.

public ProductCollection Products { get; }

Property Value

ProductCollection

Remarks

Gift card products are not included

ReceiptShowCount

Gets or sets the count of receipt was shown.

public int ReceiptShowCount { get; set; }

Property Value

int

RecurringOrderId

Gets or sets the Order recurring order ID.

public int RecurringOrderId { get; set; }

Property Value

int

Reference

Gets or sets the reference.

public string Reference { get; set; }

Property Value

string

Referrer

Gets or sets the referrer.

public string Referrer { get; set; }

Property Value

string

Requisition

Gets or sets the requisition.

public string Requisition { get; set; }

Property Value

string

ReSendEmail

Gets or sets the resend email.

public string ReSendEmail { get; set; }

Property Value

string

ReturnOperations

Gets or sets the order return operations as collection of OrderReturnInfo.

public IEnumerable<OrderReturnInfo> ReturnOperations { get; set; }

Property Value

IEnumerable<OrderReturnInfo>

Remarks

History of operations for payments with IFullReturn, IPartialReturn interfaces implemented.

ReverseChargeForVat

Gets or sets a value indicating whether VAT is in a reverse charge situation. In this case, VAT is not present in the product price for the affected VAT groups. This is standard VAT law in EU for B2B, where the buyer must handle the VAT rather than the reseller.

public bool ReverseChargeForVat { get; set; }

Property Value

bool

true if VAT is in a reverse charge situation; otherwise, false.

RewardTotalPoints

Points for reward.

public double? RewardTotalPoints { get; }

Property Value

double?

SalesDiscount

Gets or sets the sales discount.

public double SalesDiscount { get; set; }

Property Value

double

SavedCardDraftName

Gets or sets the name for saved card to be created.

public string SavedCardDraftName { get; set; }

Property Value

string

SavedCardId

Gets or sets the ID of saved card.

public int SavedCardId { get; set; }

Property Value

int

SecondaryUserId

Gets or sets the impersonated access user ID.

public int SecondaryUserId { get; set; }

Property Value

int

SecondaryUserName

Gets the impersonated access user Name.

public string SecondaryUserName { get; }

Property Value

string

Secret

A secret sequence of characters to use e.g. for security. The secret is non-changeable for this order.

public string Secret { get; }

Property Value

string

ShippingCountrySelection

Gets or sets the shipping country.

public CountrySelectionForMethod ShippingCountrySelection { get; set; }

Property Value

CountrySelectionForMethod

ShippingDate

Gets or sets the shipping date.

public DateTime? ShippingDate { get; set; }

Property Value

DateTime?

ShippingDocumentValues

Gets the shipping document values.

public Dictionary<string, object> ShippingDocumentValues { get; }

Property Value

Dictionary<string, object>

ShippingFee

Gets the shipping fee.

public PriceInfo ShippingFee { get; }

Property Value

PriceInfo

ShippingMethod

Gets or sets the shipping method.

public string ShippingMethod { get; set; }

Property Value

string

ShippingMethodAgentCode

Gets or sets the shipping method agent code.

public string ShippingMethodAgentCode { get; set; }

Property Value

string

ShippingMethodAgentServiceCode

Gets or sets the shipping method agent sercice code.

public string ShippingMethodAgentServiceCode { get; set; }

Property Value

string

ShippingMethodCode

Gets or sets the shipping method Code.

public string ShippingMethodCode { get; set; }

Property Value

string

ShippingMethodCountryCode

Gets or sets the shipping method country code.

public string ShippingMethodCountryCode { get; set; }

Property Value

string

ShippingMethodDescription

Gets or sets the shipping method description.

public string ShippingMethodDescription { get; set; }

Property Value

string

ShippingMethodId

Gets or sets the shipping method ID.

public string ShippingMethodId { get; set; }

Property Value

string

ShippingProviderErrors

Gets the shipping provider errors.

public List<string> ShippingProviderErrors { get; }

Property Value

List<string>

ShippingProviderValues

Gets the shipping provider values.

public Dictionary<string, object> ShippingProviderValues { get; }

Property Value

Dictionary<string, object>

ShippingProviderWarnings

Gets the shipping provider warnings.

public List<string> ShippingProviderWarnings { get; }

Property Value

List<string>

ShopId

Gets or sets the shop ID where the order was sold.

public string ShopId { get; set; }

Property Value

string

ShopName

Gets or sets the shop name where the order was sold.

public string ShopName { get; set; }

Property Value

string

Shops

Gets the shop where the order was sold.

public IEnumerable<Shop> Shops { get; }

Property Value

IEnumerable<Shop>

StateId

Gets or sets the order state ID e.g. Completed, New, Important etc.

public string StateId { get; set; }

Property Value

string

StepHistory

Gets or sets the order step history.

public string StepHistory { get; set; }

Property Value

string

StepNum

Gets or sets the current step number (CartV1).

public int StepNum { get; set; }

Property Value

int

TaxProviderErrors

Gets the tax provider errors.

public List<string> TaxProviderErrors { get; }

Property Value

List<string>

TaxTransactionNumber

Gets or sets the tax transaction number.

public string TaxTransactionNumber { get; set; }

Property Value

string

TotalDiscount

Gets the total discount.

public PriceInfo TotalDiscount { get; }

Property Value

PriceInfo

TotalOrderDiscount

Gets the total discount.

public PriceInfo TotalOrderDiscount { get; }

Property Value

PriceInfo

TotalPoints

Points for redeem.

public double? TotalPoints { get; }

Property Value

double?

TotalPrice

Gets the total price including VAT.

public double TotalPrice { get; }

Property Value

double

TotalPriceFormatted

Gets the total price string in currency format.

public string TotalPriceFormatted { get; }

Property Value

string

TotalPriceWithoutDiscounts

Gets the total price without discounts.

public PriceInfo TotalPriceWithoutDiscounts { get; }

Property Value

PriceInfo

TotalPriceWithoutDiscountsFeesAndTaxes

Gets the total price without discounts, fees and taxes.

public PriceInfo TotalPriceWithoutDiscountsFeesAndTaxes { get; }

Property Value

PriceInfo

TotalPriceWithoutDiscountsOrTaxes

Gets the total price without discounts or taxes.

public PriceInfo TotalPriceWithoutDiscountsOrTaxes { get; }

Property Value

PriceInfo

TotalPriceWithoutFees

Gets the total price without discounts, fees and taxes.

public PriceInfo TotalPriceWithoutFees { get; }

Property Value

PriceInfo

TotalPriceWithoutFeesAndTaxes

Gets the total price without fees and taxes.

public PriceInfo TotalPriceWithoutFeesAndTaxes { get; }

Property Value

PriceInfo

TotalPriceWithoutOrderDiscountsAndFees

Gets the total price without orderdiscounts and fees. This is the subtotal of all products with discounts, but without any order discounts

public PriceInfo TotalPriceWithoutOrderDiscountsAndFees { get; }

Property Value

PriceInfo

TotalPriceWithoutOrderDiscountsAndFeesAndTaxes

Gets the total price without order discounts, fees and taxes. This is the subtotal of all products with discounts, but without any order discounts, fees and taxes.

public PriceInfo TotalPriceWithoutOrderDiscountsAndFeesAndTaxes { get; }

Property Value

PriceInfo

TotalPriceWithoutTaxes

Gets the total price without taxes.

public PriceInfo TotalPriceWithoutTaxes { get; }

Property Value

PriceInfo

TotalPriceWithoutVatFormatted

Gets the total price without VAT string in currency format.

public string TotalPriceWithoutVatFormatted { get; }

Property Value

string

TotalProductDiscount

Gets the total discount.

public PriceInfo TotalProductDiscount { get; }

Property Value

PriceInfo

TotalTax

public PriceInfo TotalTax { get; }

Property Value

PriceInfo

TrackTrace

Gets the track trace. Track & Trace property allows determining current and previous locations of purchased items and other statuses of cargo in transit.

public TrackAndTrace TrackTrace { get; }

Property Value

TrackAndTrace

TrackTraceId

Gets or sets the track trace ID. Track & Trace property allows determining the current and previous locations of purchased items and other statuses of cargo in transit.

public int TrackTraceId { get; set; }

Property Value

int

TrackTraceName

Gets or sets the and track trace name.

public string TrackTraceName { get; set; }

Property Value

string

TrackTraceNumber

Gets or sets the track trace number (obsolete).

public string TrackTraceNumber { get; set; }

Property Value

string

TrackTraceParameters

Gets or sets the track trace parameters. Track & Trace property allows determining the current and previous locations of purchased items and other statuses of cargo in transit.

public string TrackTraceParameters { get; set; }

Property Value

string

TrackTraceUrl

Gets or sets the track trace URL. Track & Trace property allows determining the current and previous locations of purchased items and other statuses of cargo in transit.

public string TrackTraceUrl { get; }

Property Value

string

TransactionAmount

Gets or sets the transaction amount.

public double TransactionAmount { get; set; }

Property Value

double

TransactionCardNumber

Gets or sets the payment card number.

public string TransactionCardNumber { get; set; }

Property Value

string

TransactionCardType

Gets or sets the payment card type.

public string TransactionCardType { get; set; }

Property Value

string

TransactionMailSend

Gets or sets a value indicating whether the mail with transaction state was sent to customer.

public bool TransactionMailSend { get; set; }

Property Value

bool

TransactionNumber

Gets or sets the payment gateway transaction number.

public string TransactionNumber { get; set; }

Property Value

string

TransactionPayGatewayCode

Gets or sets the transaction payment gateway code.

public string TransactionPayGatewayCode { get; set; }

Property Value

string

TransactionStatus

Gets or sets the payment gateway transaction status (succeeded, canceled, failed etc).

public string TransactionStatus { get; set; }

Property Value

string

TransactionToken

Get or set the payment transaction token.

public string TransactionToken { get; set; }

Property Value

string

TransactionTokenCheckSum

Gets the token check sum.

public string TransactionTokenCheckSum { get; }

Property Value

string

TransactionType

Gets or sets the transaction type.

public string TransactionType { get; set; }

Property Value

string

TransactionValue

Gets or sets the transaction value.

public string TransactionValue { get; set; }

Property Value

string

Vat

Gets or sets the VAT.

public double Vat { get; set; }

Property Value

double

VatCountry

public Country VatCountry { get; set; }

Property Value

Country

VisitorSessionDate

Gets the created date of this experiment.

public DateTime VisitorSessionDate { get; }

Property Value

DateTime

VisitorSessionId

Gets or sets the ID of the visitor's session that corresponds to the visitor that this order is associated with.

public string VisitorSessionId { get; set; }

Property Value

string

Volume

Gets the total volume of the ordered products.

public double Volume { get; }

Property Value

double

VoucherCode

Gets or sets the Order Voucher code used to activate voucher discount.

public string VoucherCode { get; set; }

Property Value

string

VoucherUseType

Gets or sets the Order value indicates where Voucher code is used.

public VoucherUseCategoryType VoucherUseType { get; set; }

Property Value

VoucherUseCategoryType

Weight

Gets the total weight of the ordered products.

public double Weight { get; }

Property Value

double

Methods

CalculateDiscounts()

Calculates the discounts for this Order. If RecalculateDiscountsNeeded is false or if Calculate is false, discounts will not be calculated.

[Obsolete("Use Ecommerce.Services.Orders.CalculateDiscounts instead")]
public void CalculateDiscounts()

Capture()

Performs capture on this order and stores the resulting OrderCaptureInfo on the order.

[Obsolete("Use Ecommerce.Services.Orders.Capture instead.")]
public OrderCaptureInfo Capture()

Returns

OrderCaptureInfo

Return the generated OrderCaptureInfo or null if capture is not supported.

Capture(long, bool)

Performs capture on this order and stores the resulting OrderCaptureInfo on the order.

[Obsolete("Use Ecommerce.Services.Orders.Capture instead.")]
public OrderCaptureInfo Capture(long amount, bool final)

Parameters

amount long

The amount that is multiplied by 100.

final bool

The capture is final.

Returns

OrderCaptureInfo

Return the generated OrderCaptureInfo or null if capture is not supported.

ClearCachedPrices()

Clears the cached prices.

[Obsolete("Use Ecommerce.Services.Orders.ClearCachedPrices instead.")]
public void ClearCachedPrices()

CreateOrderLine(Product)

Adds a new OrderLine to the OrderLineCollection of this Order based on the given Product. A quantity of '1' is used. The Products DefaultUnit is used.

[Obsolete("Use Ecommerce.Services.Orders.CreateOrderLine instead.")]
public OrderLine CreateOrderLine(Product product)

Parameters

product Product

The product.

Returns

OrderLine

The OrderLine that was added to the Order.

CreateOrderLine(Product, double)

Adds a new OrderLine to the OrderLineCollection of this Order based on the given Product. The Products DefaultUnit is used.

[Obsolete("Use Ecommerce.Services.Orders.CreateOrderLine instead.")]
public OrderLine CreateOrderLine(Product product, double quantity)

Parameters

product Product

The product.

quantity double

The quantity.

Returns

OrderLine

The OrderLine that was added to the Order.

CreateOrderLine(Product, double, StockUnit)

Adds a new OrderLine to the OrderLineCollection of this Order based on the given Product.

[Obsolete("Use Ecommerce.Services.Orders.CreateOrderLine instead.")]
public OrderLine CreateOrderLine(Product product, double quantity, StockUnit unit)

Parameters

product Product

The product.

quantity double

The quantity.

unit StockUnit

The unit.

Returns

OrderLine

The OrderLine that was added to the Order.

CreateOrderLine(Product, double, StockUnit, PriceInfo)

Adds a new OrderLine to the OrderLineCollection of this Order based on the given Product.

[Obsolete("Use Ecommerce.Services.OrderLines.Create instead.")]
public OrderLine CreateOrderLine(Product product, double quantity, StockUnit unit, PriceInfo unitPrice)

Parameters

product Product

The product.

quantity double

The quantity.

unit StockUnit

The unit.

unitPrice PriceInfo

The unit price of the product. Use this if unit price should be different from the price of the product.

Returns

OrderLine

The OrderLine that was added to the Order.

CreateOrderLine(string, double, PriceInfo, OrderLineType)

Adds a new OrderLine to the OrderLineCollection of this Order with the given OrderLineType and the given text.

[Obsolete("Use Ecommerce.Services.Orders.CreateOrderLine instead.")]
public OrderLine CreateOrderLine(string text, double quantity, PriceInfo unitPrice, OrderLineType type)

Parameters

text string

The text.

quantity double

The quantity.

unitPrice PriceInfo

The unit price.

type OrderLineType

The type.

Returns

OrderLine

The OrderLine that was added to the Order.

CreateOrderLine(string, double, PriceInfo, OrderLineType, string)

Adds a new OrderLine to the OrderLineCollection of this Order with the given OrderLineType and the given text.

[Obsolete("Use Ecommerce.Services.Orders.CreateOrderLine instead.")]
public OrderLine CreateOrderLine(string text, double quantity, PriceInfo unitPrice, OrderLineType type, string parentOrderLineId)

Parameters

text string

The text.

quantity double

The quantity.

unitPrice PriceInfo

The unit price.

type OrderLineType

The type.

parentOrderLineId string

The parent order line identifier.

Returns

OrderLine

The OrderLine that was added to the Order.

CreateOrderLine(string, double, PriceInfo, OrderLineType, string, string)

Adds a new OrderLine to the OrderLineCollection of this Order with the given OrderLineType and the given text.

[Obsolete("Use Ecommerce.Services.OrderLines.Create instead.")]
public OrderLine CreateOrderLine(string text, double quantity, PriceInfo unitPrice, OrderLineType type, string parentOrderLineId, string discountId)

Parameters

text string

The text.

quantity double

The quantity.

unitPrice PriceInfo

The unit price.

type OrderLineType

The type.

parentOrderLineId string

The parent order line identifier.

discountId string

The discount identifier.

Returns

OrderLine

The OrderLine that was added to the Order.

Delete()

Deletes this instance.

[Obsolete("Use Ecommerce.Services.Orders.Delete instead.")]
public void Delete()

Delete(string)

Deletes the order.

[Obsolete("Use Ecommerce.Services.Orders.Delete instead.")]
public static void Delete(string id)

Parameters

id string

The order ID.

DowngradeToCart()

Converts the order back to cart

[Obsolete("Use Ecommerce.Services.Orders.DowngradeToCart instead.")]
public void DowngradeToCart()

ForcePriceRecalculation()

Forces the recalculation of the Price.

[Obsolete("Use Ecommerce.Services.Orders.ForcePriceRecalculation instead.")]
public void ForcePriceRecalculation()

get_ParentOrderLineCount(OrderLineCollection)

Gets the parent order line count. Does not count lines of the parent product parts.

[Obsolete("Use GetParentOrderLineCount instead")]
public int get_ParentOrderLineCount(OrderLineCollection OrderLines)

Parameters

OrderLines OrderLineCollection

Returns

int

get_ParentOrderLineQuantityCount(OrderLineCollection)

Gets the parent order line quantity count. Does not count lines of the parent product parts.

[Obsolete("Use GetParentOrderLineQuantityCount instead")]
public double get_ParentOrderLineQuantityCount(OrderLineCollection OrderLines)

Parameters

OrderLines OrderLineCollection

Returns

double

get_ParentProductLineQuantityCount(OrderLineCollection)

Gets the parent product line quantity counts. Does not include lines with discounts and parent product parts.

[Obsolete("Use ParentProductLineQuantityCount instead")]
public double get_ParentProductLineQuantityCount(OrderLineCollection orderLines)

Parameters

orderLines OrderLineCollection

Returns

double

GetAllOrderVersionsById(string)

Gets all versions for the order.

[Obsolete("Use Ecommerce.Services.Orders.GetAllVersions instead.")]
public static OrderCollection GetAllOrderVersionsById(string id)

Parameters

id string

The order ID.

Returns

OrderCollection

The OrderCollection.

GetCartFormName()

Gets the name of the cart form.

[Obsolete("Use Ecommerce.Services.Orders.GetCartFormName instead.")]
public string GetCartFormName()

Returns

string

"CartForm_[ID]"

GetEmptyOrderDataSet()

Gets an empty DataSet with the schema from the database.

[Obsolete]
public static DataSet GetEmptyOrderDataSet()

Returns

DataSet

GetOrderById(string)

Gets the order by ID.

[Obsolete("Use Ecommerce.Services.Orders.GetById instead.")]
public static Order GetOrderById(string id)

Parameters

id string

The id.

Returns

Order

GetOrderById(string, bool)

Gets the order by ID.

[Obsolete("Use Ecommerce.Services.Orders.GetById instead.")]
public static Order GetOrderById(string id, bool useItemsCache)

Parameters

id string

The id.

useItemsCache bool

if set to true use Context.Current.Items cache to store the Order.

Returns

Order

GetOrderDataReader(string)

Gets the DataReader with order.

[Obsolete]
public IDataReader GetOrderDataReader(string orderId)

Parameters

orderId string

The order ID.

Returns

IDataReader

GetOrderDataSetByOrderId(string)

Gets the DataSet object with orders.

[Obsolete]
public static DataSet GetOrderDataSetByOrderId(string orderId)

Parameters

orderId string

The order ID.

Returns

DataSet

GetOrderFromHistoryById(string, int)

Gets the order from history by Id.

[Obsolete("Use Ecommerce.Services.Orders.GetOrderFromHistory instead.")]
public static Tuple<Order, DateTime> GetOrderFromHistoryById(string orderId, int versionId)

Parameters

orderId string

The id.

versionId int

The order version id.

Returns

Tuple<Order, DateTime>

GetOrders(string)

Gets the orders.

[Obsolete("Please use the OrderService to get order instances.")]
public static OrderCollection GetOrders(string query)

Parameters

query string

The SQL.

Returns

OrderCollection

GetOrders(string, bool)

Gets the orders.

[Obsolete("Please use the OrderService to get order instances.")]
public static OrderCollection GetOrders(string query, bool preLoadOrderLines)

Parameters

query string

The SQL query.

preLoadOrderLines bool

if set to true get order lines from DB and attach to orders.

Returns

OrderCollection

GetOrders(string, string, string, string, bool, string)

Gets the orders.

[Obsolete("Use Ecommerce.Services.Orders.FindOrders instead.")]
public static OrderCollection GetOrders(string keyword, string stateId, string startdate, string enddate, bool showCart, string shopId)

Parameters

keyword string

The keyword.

stateId string

The state ID. DB field name is OrderStateID.

startdate string

The start date. DB field name is OrderDate.

enddate string

The end date. DB field name is OrderDate.

showCart bool

if set to true show cart. DB field name is OrderCart.

shopId string

The shop ID. DB field name is OrderShopID.

Returns

OrderCollection

GetParentOrderLineCount(OrderLineCollection)

Gets the parent order line count. Does not count lines of the parent product parts.

public int GetParentOrderLineCount(OrderLineCollection orderLines)

Parameters

orderLines OrderLineCollection

Returns

int

GetParentOrderLineQuantityCount(OrderLineCollection)

Gets the parent order line quantity count. Does not count lines of the parent product parts.

public double GetParentOrderLineQuantityCount(OrderLineCollection orderLines)

Parameters

orderLines OrderLineCollection

Returns

double

GetParentProductLineQuantityCount(OrderLineCollection)

Gets the parent product line quantity counts. Does not include lines with discounts and parent product parts.

public double GetParentProductLineQuantityCount(OrderLineCollection orderLines)

Parameters

orderLines OrderLineCollection

Order lines

Returns

double

GetPriceContext()

Gets price context information for the order.

public PriceContext GetPriceContext()

Returns

PriceContext

GetPriceProductSelections()

Gets product selections for the order.

public IEnumerable<PriceProductSelection> GetPriceProductSelections()

Returns

IEnumerable<PriceProductSelection>

GetPropertyType(string)

Gets the property type.

[Obsolete("Use Ecommerce.Services.Orders.GetPropertyType instead.")]
public string GetPropertyType(string propertyName)

Parameters

propertyName string

Name of the property.

Returns

string

The property type.

GetPropertyValue(string)

Gets the property value.

[Obsolete("Use Ecommerce.Services.Orders.GetPropertyValue instead.")]
public object GetPropertyValue(string propertyName)

Parameters

propertyName string

Name of the property.

Returns

object

The property value.

GetTotalPurchasesByCustomerId(int, DateTime, Currency)

Get total purchases price by customer ID.

[Obsolete("Use Ecommerce.Services.Orders.GetTotalPurchasesByCustomerId instead.")]
public static PriceInfo GetTotalPurchasesByCustomerId(int customerId, DateTime fromDate, Currency priceCurrency)

Parameters

customerId int

The customer ID.

fromDate DateTime

The from date.

priceCurrency Currency

The price currency.

Returns

PriceInfo

The instance of the PriceInfo class.

IsVatCountrySetByUser()

public bool IsVatCountrySetByUser()

Returns

bool

OrderLineBuilder(OrderLineBuilderConfig)

Builds an OrderLine based on the given OrderLineBuilderConfig.

[Obsolete("Use Ecommerce.Services.OrderLines.OrderLineBuilder instead.")]
public OrderLine OrderLineBuilder(OrderLineBuilderConfig builderConfiguration)

Parameters

builderConfiguration OrderLineBuilderConfig

The builder configuration.

Returns

OrderLine

The OrderLine.

PreparePrices()

public void PreparePrices()

RemoveNoneActiveProducts()

Removes all orderlines that is of type Product and that no longer exist in the database. Also removes products according to the control panel settings: Active, on stock, price is zero.

[Obsolete("Use Ecommerce.Services.Orders.RemoveNoneActiveProducts instead.")]
public void RemoveNoneActiveProducts()

Save()

Saves this instance.

[Obsolete("Use Ecommerce.Services.Orders.Save instead.")]
public void Save()

Save(string)

Saves the instance into DB.

[Obsolete("Use Ecommerce.Services.Orders.Save instead.")]
public void Save(string orderId)

Parameters

orderId string

The order ID.

Save(string, bool)

Saves the instance into DB.

[Obsolete("Use Ecommerce.Services.Orders.Save instead.")]
public void Save(string orderId, bool saveOldVersion)

Parameters

orderId string

The order ID.

saveOldVersion bool

Sets indicator whether to save old order version.

SaveGatewayResult()

Save the gateway result.

[Obsolete("Use Ecommerce.Services.Orders.SaveGatewayResult instead.")]
public void SaveGatewayResult()

SaveOrderComplete(bool)

Save order complete state.

[Obsolete("Use Ecommerce.Services.Orders.Complete instead.")]
public void SaveOrderComplete(bool setComplete)

Parameters

setComplete bool

if set to true [set complete].

SendTo(ref PageView, List<string>, string, ref Template)

Sends the mail to the specified list of addresses.

[Obsolete("Use Ecommerce.Services.Orders.SendEmail instead.")]
public bool SendTo(ref PageView pageView, List<string> toMailAddresses, string fromMailAddress, ref Template mailTemplate)

Parameters

pageView PageView

The page view.

toMailAddresses List<string>

To mail addresses list.

fromMailAddress string

From mail address.

mailTemplate Template

The mail template.

Returns

bool

true if send was succesful; otherwise false.

SendTo(ref PageView, string, List<string>, string, string, ref Template)

Sends the mail to the specified addresses.

[Obsolete("Use Ecommerce.Services.Orders.SendEmail instead.")]
public bool SendTo(ref PageView pageView, string subject, List<string> toMailAddresses, string fromMailAddress, string fromMailName, ref Template mailTemplate)

Parameters

pageView PageView

The page view.

subject string

Mail subject.

toMailAddresses List<string>

To mail addresses list.

fromMailAddress string

From mail address.

fromMailName string

From mail sender name.

mailTemplate Template

The mail template.

Returns

bool

true if send was succesful; otherwise false.

SendTo(ref PageView, string, string, ref Template)

Sends the mail to the specified address.

[Obsolete("Use Ecommerce.Services.Orders.SendEmail instead.")]
public bool SendTo(ref PageView pageView, string toMailAddress, string fromMailAddress, ref Template mailTemplate)

Parameters

pageView PageView

The page view.

toMailAddress string

To mail address.

fromMailAddress string

From mail address.

mailTemplate Template

The mail template.

Returns

bool

true if send was succesful; otherwise false.

SendTo(ref PageView, string, string, string, ref Template)

Sends the mail to the specified address.

[Obsolete("Use Ecommerce.Services.Orders.SendEmail instead.")]
public static bool SendTo(ref PageView pageView, string orderId, string toMailAddress, string fromMailAddress, ref Template mailTemplate)

Parameters

pageView PageView

The page view.

orderId string

The order ID.

toMailAddress string

To mail address.

fromMailAddress string

From mail address.

mailTemplate Template

The mail template.

Returns

bool

true if send was succesful; otherwise false.

SendTo(ref PageView, string, string, string, string, ref Template)

Sends the mail to the specified address.

[Obsolete("Use Ecommerce.Services.Orders.SendEmail instead.")]
public bool SendTo(ref PageView pageView, string subject, string toMailAddress, string fromMailAddress, string fromMailName, ref Template mailTemplate)

Parameters

pageView PageView

The page view.

subject string

Mail subject.

toMailAddress string

To mail address.

fromMailAddress string

From mail address.

fromMailName string

From mail sender name.

mailTemplate Template

The mail template.

Returns

bool

true if send was succesful; otherwise false.

SetToken(string)

Sets token related to the order.

[Obsolete]
public void SetToken(string token)

Parameters

token string

The payment transaction token.

UpdateCartToOrder()

Updates the order.

[Obsolete("Use Ecommerce.Services.Orders.UpdateCartToOrder instead.")]
public void UpdateCartToOrder()

UpdateCartToQuote()

Updates the order.

[Obsolete("Use Ecommerce.Services.Orders.UpdateCartToQuote instead.")]
public void UpdateCartToQuote()

UpdateExistOrderFromCartToOrder()

Updates the existing order from cart to order.

[Obsolete("Use Ecommerce.Services.Orders.UpdateCartToQuote instead.")]
public void UpdateExistOrderFromCartToOrder()

UpdateGatewayResult()

Updates the gateway result.

[Obsolete("Use Ecommerce.Services.Orders.UpdateGatewayResult instead.")]
public void UpdateGatewayResult()

UpdateGatewayResult(bool)

Updates the gateway result.

[Obsolete("Use Ecommerce.Services.Orders.UpdateGatewayResult instead.")]
public void UpdateGatewayResult(bool setComplete)

Parameters

setComplete bool

if set to true [set complete].

UpdateStepInfo()

Updates the step information.

[Obsolete("Use Ecommerce.Services.Orders.UpdateStepInfo instead.")]
public void UpdateStepInfo()

UpdateVat(double)

Updates the VAT.

[Obsolete("Use Ecommerce.Services.Orders.UpdateVat instead.")]
public void UpdateVat(double vat)

Parameters

vat double

The VAT. DB fields names are OrderVAT and OrderPriceVAT.

UpdateVat(double, double)

Updates the VAT.

[Obsolete("Use Ecommerce.Services.Orders.UpdateVat instead.")]
public void UpdateVat(double vat, double vatpercent)

Parameters

vat double

The VAT. DB fields names are OrderVAT and OrderPriceVAT.

vatpercent double

The VAT percent. DB field name is OrderPriceVATPercent.

ValidatePricesInDatabase()

Validates the prices in database. If AllowOverridePrices is set to true, this method also returns true.

[Obsolete("Use Ecommerce.Services.Orders.ValidatePricesInDatabase instead.")]
public bool ValidatePricesInDatabase()

Returns

bool

true if prices validate; false otherwise.

ValidatePricesInDatabase(ref double, ref double, ref double)

Validates the prices in database. If AllowOverridePrices is set to true, this method also returns true.

[Obsolete("Use Ecommerce.Services.Orders.ValidatePricesInDatabase instead.")]
public bool ValidatePricesInDatabase(ref double orderPrice, ref double orderlinePrice, ref double priceDifference)

Parameters

orderPrice double

returns order price if prices invalid

orderlinePrice double

returns order lines price if prices invalid

priceDifference double

returns price difference if prices invalid

Returns

bool

true if prices validate; false otherwise.