Class Order
- Namespace
- Dynamicweb.Ecommerce.Orders
- Assembly
- Dynamicweb.Ecommerce.dll
Represents information about an order.
- Inheritance
-
Order
- Inherited Members
- Extension Methods
Constructors
Order(Currency, Country, Language)
Initializes a new instance of the Order class.
Parameters
Properties
AddressValidatorResults
Gets the address validator results.
Property Value
AllowOverridePaymentFee
Indicated whether payment fee is overridden and not calculated
Property Value
AllowOverridePrices
Indicated whether Price is overridden and not calculated. Used to set explicit PriceInfo values.
Property Value
AllowOverrideShippingFee
Indicated whether shipping fee is overridden and not calculated
Property Value
AutoId
Gets the Order Auto ID.
Property Value
Calculate
Gets a value indicating whether this Order is calculated (is in the cart state).
Property Value
- bool
true
if calculated; otherwise,false
.
CaptureAmount
Gets or sets the captured amount.
Property Value
CaptureInfo
Gets or sets the capture info.
Property Value
CheckoutPageId
Gets or sets the PageID where was checkout step.
Property Value
Comment
Gets or sets the comment.
Property Value
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.
Property Value
- bool
true
if complete; otherwise,false
.
CompletedDate
Gets or sets the date when order was completed.
Property Value
Currency
Gets the currency.
Property Value
CurrencyCode
Gets or sets the currency code.
Property Value
CurrencyName
Gets or sets the currency name.
Property Value
CurrencyRate
Gets or sets the currency rate on the order creation date.
Property Value
CustomerAccepted
Gets or sets a value indicating whether customer has accepted order terms and conditions.
Property Value
- bool
true
if customer was accepted; otherwise,false
.
CustomerAccessUserId
Gets or sets the customer access user ID.
Property Value
CustomerAccessUserUserName
Gets or sets the customer access user name.
Property Value
CustomerAddress
Gets or sets the customer address.
Property Value
CustomerAddress2
Gets or sets the customer address2.
Property Value
CustomerAddressId
Gets or sets the ID of the User
Property Value
CustomerCell
Gets or sets the customer cell.
Property Value
CustomerCity
Gets or sets the customer city.
Property Value
CustomerComment
Gets or sets the customer comment.
Property Value
CustomerCompany
Gets or sets the customer company.
Property Value
CustomerCountry
Gets or sets the customer country.
Property Value
CustomerCountryCode
Gets or sets the customer country code.
Property Value
CustomerEan
Gets or sets the customer EAN.
Property Value
CustomerEmail
Gets or sets the customer email.
Property Value
CustomerFax
Gets or sets the customer fax.
Property Value
CustomerFirstName
Gets or sets the customer first name.
Property Value
CustomerHouseNumber
Gets or sets the customer house number.
Property Value
CustomerInitials
Gets or sets the customer initials.
Property Value
CustomerMiddleName
Gets or sets the customer middle name.
Property Value
CustomerName
Gets or sets the customer name.
Property Value
CustomerNumber
Gets or sets the customer number.
Property Value
CustomerPhone
Gets or sets the customer phone.
Property Value
CustomerPrefix
Gets or sets the customer prefix.
Property Value
CustomerRefId
Gets or sets the customer reference ID.
Property Value
CustomerRegion
Gets or sets the customer region.
Property Value
CustomerSurname
Gets or sets the customer surname.
Property Value
CustomerTitle
Gets or sets the customer title.
Property Value
CustomerVatRegNumber
Gets or sets the customer VAT registration number.
Property Value
CustomerZip
Gets or sets the customer zip code.
Property Value
Date
Gets or sets the order creation date.
Property Value
Deleted
Gets or sets a value indicating whether this Order is deleted. When administrator delete the order it only marked as deleted.
Property Value
- bool
true
if deleted; otherwise,false
.
DeliveryAddress
Gets or sets the delivery address.
Property Value
DeliveryAddress2
Gets or sets the delivery address2.
Property Value
DeliveryAddressId
Gets or sets the ID of the User
Property Value
DeliveryCell
Gets or sets the delivery cell.
Property Value
DeliveryCity
Gets or sets the delivery city.
Property Value
DeliveryCompany
Gets or sets the delivery company.
Property Value
DeliveryCountry
Gets or sets the delivery country.
Property Value
DeliveryCountryCode
Gets or sets the delivery country code.
Property Value
DeliveryEmail
Gets or sets the delivery email.
Property Value
DeliveryFax
Gets or sets the delivery fax.
Property Value
DeliveryFirstName
Gets or sets the delivery first name.
Property Value
DeliveryHouseNumber
Gets or sets the delivery house number.
Property Value
DeliveryInitials
Gets or sets the delivery initials.
Property Value
DeliveryMiddleName
Gets or sets the delivery middle name.
Property Value
DeliveryName
Gets or sets the delivery name.
Property Value
DeliveryPhone
Gets or sets the delivery phone.
Property Value
DeliveryPrefix
Gets or sets the delivery prefix.
Property Value
DeliveryRegion
Gets or sets the delivery region.
Property Value
DeliverySurname
Gets or sets the delivery surname.
Property Value
DeliveryTitle
Gets or sets the delivery title.
Property Value
DeliveryZip
Gets or sets the delivery ZIP.
Property Value
DisableDiscountCalculation
Property Value
DiscountAmount
Gets or sets the discount amount that can be used for custom discounts on the order
Property Value
DiscountPercentage
Gets or sets the discount percentage that can be used for custom discounts on the order
Property Value
DisplayName
Gets or sets the order name
Property Value
DoSaveCardToken
Gets or sets the value indicating whether to save card.
Property Value
Errors
Gets or sets the errors.
Property Value
ExternalPaymentFee
Get or set the external payment fee.
Property Value
GatewayPaymentStatus
Gets or sets the gateway payment status(Paid, Rejected etc).
Property Value
GatewayResult
Gets or sets the result from the payment gateway.
Property Value
GatewayTransactionProblems
Gets the gateway transaction problems.
Property Value
GiftCardTransactionFailed
Gets or sets the Order GiftCard transactions failed status.
Property Value
HasSetUserDetails
Gets or sets a value indicating whether the customer data has been filled in.
Property Value
- bool
true
if this instance has set user details; otherwise,false
.
HasShippingDocument
Determines whether the shipping document values is empty or not.
Property Value
Id
Gets or sets the Order ID.
Property Value
InfoDirectProviderErrors
Gets the Info Direct service errors.
Property Value
IntegrationOrderId
Gets or sets the integration order ID.
Property Value
Ip
Gets or sets the customer's IP.
Property Value
IsCart
Gets or sets a value indicating whether order has "cart" status. The order will have "cart" status until customer confirms the payment.
Property Value
- bool
true
if this instance is cart; otherwise,false
.
IsExported
Determines whether order was exported.
Property Value
IsLedgerEntry
Gets or sets a value indicating whether this is a "ledger entry".
Property Value
- bool
true
if this instance is ledger entry; otherwise,false
.
IsPayable
Gets or sets a value indicating whether this order can be "payed".
Property Value
- bool
true
if this instance is payable; otherwise,false
.
IsPriceCalculatedByProvider
Gets or sets a value indicating whether prices are calculated by a provider.
Property Value
- bool
true
if prices are calculated by a provider; otherwise,false
.
IsProcessingCheckout
Internal property indicating whether an order is being checked out. An order that is being checked out does not do calculations.
Property Value
IsQuote
Gets or sets a value indicating whether this is an "order" or a "quote".
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".
Property Value
- bool
true
if this instance is recurring order; otherwise,false
.
IsShippingDocumentSupported
Determines whether the shipping document is supported.
Property Value
Language
Property Value
LanguageId
Gets or sets the order language ID.
Property Value
LedgerType
Gets or sets the ledger type.
Property Value
Modified
Gets or sets the date when order was modified.
Property Value
NewsletterSubscribe
Gets or sets a value indicating whether customer was subscribed for a newsletter.
Property Value
- bool
true
if newsletter was subscribed; otherwise,false
.
OrderContextId
Gets or sets the order context ID.
Property Value
OrderFieldValues
Gets or sets the custom order field values.
Property Value
OrderLines
Gets the collection of all order lines.
Property Value
OrderState
Gets the current order state, e.g. Completed, New, Important etc.
Property Value
ParentOrderId
Gets or sets the parent Order ID.
Property Value
PaymentCountrySelection
Gets or sets the country for shipping.
Property Value
PaymentFee
Gets the payment fee.
Property Value
PaymentMethod
Gets or sets the payment method name.
Property Value
PaymentMethodCode
Gets or sets the payment method Code.
Property Value
PaymentMethodDescription
Gets or sets the payment method description.
Property Value
PaymentMethodId
Gets or sets the payment method ID.
Property Value
PaymentMethodTermsCode
Gets or sets the payment method terms code.
Property Value
PaymentRecurringInfo
Gets or sets payment provider recurring order information(recurring identity, user profiles, any information needed for payment provider).
Property Value
PointsToUse
Gets or sets the amount of loyalty points to use for pay.
Property Value
Price
Gets the price, including payment and shipping fees.
Property Value
PriceBeforeFees
Gets the price without payment and shipping fees.
Property Value
- Price
Info The price before fees.
PriceCalculationDate
Gets or sets the price calculation date on order.
Property Value
ProductOrderLines
Gets an Order
Property Value
Remarks
Order lines with gift card product are not included
Products
Gets the collection of all ordered products.
Property Value
Remarks
Gift card products are not included
ReSendEmail
Gets or sets the resend email.
Property Value
ReceiptShowCount
Gets or sets the count of receipt was shown.
Property Value
RecurringOrderId
Gets or sets the Order recurring order ID.
Property Value
Reference
Gets or sets the reference.
Property Value
Referrer
Gets or sets the referrer.
Property Value
Requisition
Gets or sets the requisition.
Property Value
ReturnOperations
Gets or sets the order return operations as collection of Order
Property Value
Remarks
History of operations for payments with IFull
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.
Property Value
- bool
true
if VAT is in a reverse charge situation; otherwise,false
.
RewardTotalPoints
Points for reward.
Property Value
SalesDiscount
Gets or sets the sales discount.
Property Value
SavedCardDraftName
Gets or sets the name for saved card to be created.
Property Value
SavedCardId
Gets or sets the ID of saved card.
Property Value
SecondaryUserId
Gets or sets the identifier of the impersonating user.
Property Value
Secret
A secret sequence of characters to use e.g. for security. The secret is non-changeable for this order.
Property Value
ShippingCountrySelection
Gets or sets the shipping country.
Property Value
ShippingDate
Gets or sets the shipping date.
Property Value
ShippingDocumentValues
Gets the shipping document values.
Property Value
ShippingFee
Gets the shipping fee.
Property Value
ShippingMethod
Gets or sets the shipping method.
Property Value
ShippingMethodAgentCode
Gets or sets the shipping method agent code.
Property Value
ShippingMethodAgentServiceCode
Gets or sets the shipping method agent sercice code.
Property Value
ShippingMethodCode
Gets or sets the shipping method Code.
Property Value
ShippingMethodCountryCode
Gets or sets the shipping method country code.
Property Value
ShippingMethodDescription
Gets or sets the shipping method description.
Property Value
ShippingMethodId
Gets or sets the shipping method ID.
Property Value
ShippingProviderErrors
Gets the shipping provider errors.
Property Value
ShippingProviderValues
Gets the shipping provider values.
Property Value
ShippingProviderWarnings
Gets the shipping provider warnings.
Property Value
ShopId
Gets or sets the shop ID where the order was sold.
Property Value
ShopName
Gets or sets the shop name where the order was sold.
Property Value
StateId
Gets or sets the order state ID e.g. Completed, New, Important etc.
Property Value
TaxProviderErrors
Gets the tax provider errors.
Property Value
TaxTransactionNumber
Gets or sets the tax transaction number.
Property Value
TotalDiscount
Gets the total discount.
Property Value
TotalOrderDiscount
Gets the total discount.
Property Value
TotalPoints
Points for redeem.
Property Value
TotalPriceWithoutDiscounts
Gets the total price without discounts.
Property Value
TotalPriceWithoutDiscountsFeesAndTaxes
Gets the total price without discounts, fees and taxes.
Property Value
TotalPriceWithoutDiscountsOrTaxes
Gets the total price without discounts or taxes.
Property Value
TotalPriceWithoutFees
Gets the total price without discounts, fees and taxes.
Property Value
TotalPriceWithoutFeesAndTaxes
Gets the total price without fees and taxes.
Property Value
TotalPriceWithoutOrderDiscountsAndFees
Gets the total price without orderdiscounts and fees. This is the subtotal of all products with discounts, but without any order discounts
Property Value
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.
Property Value
TotalPriceWithoutTaxes
Gets the total price without taxes.
Property Value
TotalPriceWithoutVatFormatted
Gets the total price without VAT string in currency format.
Property Value
TotalProductDiscount
Gets the total discount.
Property Value
TotalTax
Property Value
TrackTrace
Gets the track trace. Track & Trace property allows determining current and previous locations of purchased items and other statuses of cargo in transit.
Property Value
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.
Property Value
TrackTraceName
Gets or sets the and track trace name.
Property Value
TrackTraceNumber
Gets or sets the track trace number (obsolete).
Property Value
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.
Property Value
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.
Property Value
TransactionAmount
Gets or sets the transaction amount.
Property Value
TransactionCardNumber
Gets or sets the payment card number.
Property Value
TransactionCardType
Gets or sets the payment card type.
Property Value
TransactionMailSend
Gets or sets a value indicating whether the mail with transaction state was sent to customer.
Property Value
TransactionNumber
Gets or sets the payment gateway transaction number.
Property Value
TransactionPayGatewayCode
Gets or sets the transaction payment gateway code.
Property Value
TransactionStatus
Gets or sets the payment gateway transaction status (succeeded, canceled, failed etc).
Property Value
TransactionToken
Get or set the payment transaction token.
Property Value
TransactionTokenCheckSum
Gets the token check sum.
Property Value
TransactionType
Gets or sets the transaction type.
Property Value
TransactionValue
Gets or sets the transaction value.
Property Value
Vat
Gets or sets the VAT.
Property Value
VatCountry
Property Value
VisitorSessionDate
Gets the created date of this experiment.
Property Value
VisitorSessionId
Gets or sets the ID of the visitor's session that corresponds to the visitor that this order is associated with.
Property Value
Volume
Gets the total volume of the ordered products.
Property Value
VoucherCode
Gets or sets the Order Voucher code used to activate voucher discount.
Property Value
VoucherUseType
Gets or sets the Order value indicates where Voucher code is used.
Property Value
Weight
Gets the total weight of the ordered products.
Property Value
Methods
GetBoughtGiftCards()
Gets the Order GiftCards if any are bought.
Returns
GetCheckoutHandler()
Gets the selected checkout handler (CartV2).
Returns
GetIsCartEditable()
Gets or sets a value indicating whether this order could be edited while it is in a cart.
Returns
- bool
true
if this instance is could be edited while it is in a cart; otherwise,false
.
GetParentOrderLineQuantityCount(OrderLineCollection)
Gets the parent order line quantity count. Does not count lines of the parent product parts.
Parameters
orderLines
OrderLine Collection Order lines
Returns
GetParentProductLineQuantityCount(OrderLineCollection)
Gets the parent product line quantity counts. Does not include lines with discounts and parent product parts.
Parameters
orderLines
OrderLine Collection Order lines
Returns
GetPriceContext()
Gets price context information for the order.
Returns
GetPriceProductSelections()
Gets product selections for the order.