Dynamicweb 8 Documentation
Order Class Members
Properties  Methods 


Dynamicweb.eCommerce.Orders Namespace : Order Class

The following tables list the members exposed by Order.

Public Constructors
 NameDescription
Public ConstructorOrder ConstructorOverloaded.   
Top
Public Properties
 NameDescription
Public PropertyAddressValidatorResultsGets the address validator results.  
Public PropertyAllowOverridePricesIndicated whether Price is overridden and not calculated. Used to set explicit PriceInfo values.  
Public PropertyCalculateGets a value indicating whether this Order is calculated (is in the cart state).  
Public PropertyCaptureInfoGets or sets the capture info.  
Public PropertyCartV2StepIndexGets or sets the index of the current step(CartV2).  
Public PropertyCheckoutHandlerGets the selected checkout handler (CartV2).  
Public PropertyCommentGets or sets the comment.  
Public PropertyCompleteGets 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 PropertyCompletedDateGets or sets the date when order was completed.  
Public PropertyCurrencyGets the currency.  
Public PropertyCurrencyCodeGets or sets the currency code.  
Public PropertyCurrencyNameGets or sets the currency name.  
Public PropertyCurrencyRateGets or sets the currency rate on the order creation date.  
Public PropertyCustomerAcceptedGets or sets a value indicating whether customer has accepted order terms and conditions.  
Public PropertyCustomerAccessUserIDGets or sets the customer access user ID.  
Public PropertyCustomerAccessUserUserNameGets or sets the the customer access user name.  
Public PropertyCustomerAddressGets or sets the customer address.  
Public PropertyCustomerAddress2Gets or sets the customer address2.  
Public PropertyCustomerCellGets or sets the customer cell.  
Public PropertyCustomerCityGets or sets the customer city.  
Public PropertyCustomerCommentGets or sets the customer comment.  
Public PropertyCustomerCompanyGets or sets the customer company.  
Public PropertyCustomerCountryGets or sets the customer country.  
Public PropertyCustomerCountryCodeGets or sets the customer country code.  
Public PropertyCustomerEANGets or sets the customer EAN.  
Public PropertyCustomerEmailGets or sets the customer email.  
Public PropertyCustomerFaxGets or sets the customer fax.  
Public PropertyCustomerInitialsGets or sets the customer initials.  
Public PropertyCustomerNameGets or sets the customer name.  
Public PropertyCustomerNumberGets or sets the customer number.  
Public PropertyCustomerPhoneGets or sets the customer phone.  
Public PropertyCustomerPrefixGets or sets the customer prefix.  
Public PropertyCustomerRefIDGets or sets the customer reference ID.  
Public PropertyCustomerRegionGets or sets the customer region.  
Public PropertyCustomerSurnameGets or sets the customer surname.  
Public PropertyCustomerVatRegNumberGets or sets the customer VAT registration number.  
Public PropertyCustomerZipGets or sets the customer zip code.  
Public PropertyDateGets or sets the order creation date.  
Public PropertyDateCountGets or sets the date count.  
Public PropertyDebuggingInfosGets the information about debugging. This information helps you to monitor order status and see order processing steps in the order flow.  
Public PropertyDeletedGets or sets a value indicating whether this Order is deleted. When administrator delete the order it only marked as deleted.  
Public PropertyDeliveryAddressGets or sets the delivery address.  
Public PropertyDeliveryAddress2Gets or sets the delivery address2.  
Public PropertyDeliveryCellGets or sets the delivery cell.  
Public PropertyDeliveryCityGets or sets the delivery city.  
Public PropertyDeliveryCompanyGets or sets the delivery company.  
Public PropertyDeliveryCountryGets or sets the delivery country.  
Public PropertyDeliveryCountryCodeGets or sets the delivery country code.  
Public PropertyDeliveryEmailGets or sets the delivery email.  
Public PropertyDeliveryFaxGets or sets the delivery fax.  
Public PropertyDeliveryInitialsGets or sets the delivery initials.  
Public PropertyDeliveryNameGets or sets the delivery name.  
Public PropertyDeliveryPhoneGets or sets the delivery phone.  
Public PropertyDeliveryPrefixGets or sets the delivery prefix.  
Public PropertyDeliveryRegionGets or sets the delivery region.  
Public PropertyDeliverySurnameGets or sets the delivery surname.  
Public PropertyDeliveryZipGets or sets the delivery ZIP.  
Public PropertyErrorsGets or sets the errors.  
Public PropertyFieldsXMLGets or sets the fields XML.  
Public PropertyFixedIDGets the fixed ID.  
Public PropertyGatewayGets the selected payment gateway (CartV1).  
Public PropertyGatewayPaymentStatusGets or sets the gateway payment status(Paid, Rejected etc).  
Public PropertyGatewayResultGets or sets the result from the payment gateway.  
Public PropertyGatewayTransactionProblemsGets the gateway transaction problems.  
Public PropertyGatewayUniqueIDGets or sets the gateway unique ID.  
Public PropertyHasSetUserDetailsGets or sets a value indicating whether the customer data has been filled in.  
Public PropertyHasShippingDocument  
Public PropertyIconGets the icon file name of the order payment method.  
Public PropertyIDGets or sets the Order ID.  
Public PropertyIDWithIconGets the ID with icon.  
Public PropertyIntegrationOrderID  
Public PropertyIPGets or sets the customer's IP.  
Public PropertyIsCaptureSupportedReturn "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 PropertyIsCartGets or sets a value indicating whether order has "cart" status. The order will have "cart" status until customer confirms the payment.  
Public PropertyIsPaymentSetGets a value indicating whether the payment method is setted.  
Public PropertyIsShippingDocumentSupported  
Public PropertyLanguageIDGets or sets the order language ID.  
Public PropertyModifiedGets or sets the date when order was modified.  
Public PropertyNewsletterSubscribeGets or sets a value indicating whether customer was subscribed for a newsletter.  
Public PropertyOrderFieldGets the order field.  
Public PropertyOrderFieldsGets the custom order fields. It is possible to easily create custom order fields in the {Management center -> eCommerce-> Orders -> Order fields}  
Public PropertyOrderFieldValuesGets or sets the custom order field values. It is possible to easily create custom order fields in the {Management center -> eCommerce -> Orders -> Order fields}.  
Public PropertyOrderLinesGets the collection of all order lines.  
Public PropertyOrderStateGets the current order state, e.g. Completed, New, Important etc.  
Public PropertyOrderStatesGets the order states collection with the current order state.  
Public PropertyParentOrderLineCountGets the parent order line count. Does not count lines of the parent product parts.  
Public PropertyParentOrderLineQuantityCountGets the parent order line quantity count. Does not count lines of the parent product parts.  
Public PropertyParentProductLineQuantityCountGets the parent product line quantity counts. Does not include lines with discounts and parent product parts.  
Public PropertyPaymentCountrySelectionGets or sets the country for shipping.  
Public PropertyPaymentFeeGets the payment fee.  
Public PropertyPaymentMethodGets or sets the payment method name.  
Public PropertyPaymentMethodDescriptionGets or sets the payment method description.  
Public PropertyPaymentMethodIDGets or sets the payment method ID.  
Public PropertyPriceGets the price, including payment and shipping fees.  
Public PropertyPriceBeforeFeesGets the price without payment and shipping fees.  
Public PropertyProductOrderLinesGets an OrderLineCollection containing all OrderLine objects where OrderLine.Product is not null.  
Public PropertyProductsGets the collection of all ordered products.  
Public PropertyReferrerGets or sets the referrer.  
Public PropertyRequisition  
Public PropertyReSendEmailGets or sets the resend email.  
Public PropertySalesDiscountGets or sets the sales discount.  
Public PropertySecretA secret sequence of characters to use e.g. for security. The secret is non-changable for this order  
Public PropertyShippingCountrySelectionGets or sets the shipping country.  
Public PropertyShippingDocumentValues  
Public PropertyShippingFeeGets the shipping fee.  
Public PropertyShippingMethodGets or sets the shipping method.  
Public PropertyShippingMethodCountryCodeGets or sets the shipping method country code.  
Public PropertyShippingMethodDescriptionGets or sets the shipping method description.  
Public PropertyShippingMethodIDGets or sets the shipping method ID.  
Public PropertyShippingProviderErrorsGets the shipping provider errors.  
Public PropertyShippingProviderValues  
Public PropertyShippingProviderWarningsGets the shipping provider warnings.  
Public PropertyShopIDGets or sets the shop ID where the order was sold.  
Public PropertyShopNameGets or sets the shop name where the order was sold.  
Public PropertyShopsGets the shop where the order was sold.  
Public PropertyStateIDGets or sets the order state ID e.g. Completed, New, Important etc.  
Public PropertyStepHistoryGets or sets the order step history.  
Public PropertyStepNumGets or sets the current step number (CartV1).  
Public PropertyTaxProviderErrorsGets the tax provider errors.  
Public PropertyTotalPriceGets the total price including VAT.  
Public PropertyTotalPriceFormattedGets the total price string in currency format.  
Public PropertyTotalPriceWithoutDiscountsGets the total price without discounts.  
Public PropertyTotalPriceWithoutDiscountsOrTaxesGets the total price without discounts or taxes.  
Public PropertyTotalPriceWithoutTaxesGets the total price without taxes.  
Public PropertyTotalPriceWithoutVATFormattedGets the total price without VAT string in currency format.  
Public PropertyTrackTraceGets the track trace. Track & Trace property allows determining current and previous locations of purchased items and other statuses of cargo in transit.  
Public PropertyTrackTraceIDGets 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 PropertyTrackTraceNameGets or sets the and track trace name.  
Public PropertyTrackTraceNumberGets or sets the track trace number (obsolete).  
Public PropertyTrackTraceParametersGets 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 PropertyTrackTraceURLGets 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 PropertyTransactionAmountGets or sets the transaction amount.  
Public PropertyTransactionMailSendGets or sets a value indicating whether the mail with transaction state was sent to customer.  
Public PropertyTransactionNumberGets or sets the payment gateway transaction number.  
Public PropertyTransactionPayGatewayCodeGets or sets the transaction payment gateway code.  
Public PropertyTransactionStatusGets or sets the payment gateway transaction status (successed, cancelled, failed etc).  
Public PropertyTransactionTypeGets or sets the transaction type.  
Public PropertyTransactionValueGets or sets the transaction value.  
Public PropertyVATGets or sets the VAT.  
Public PropertyVisitorSessionIDGets or sets the ID of the visitor's session that corresponds to the visitor that this order is associated with.  
Public PropertyVolumeGets the total volume of the ordered products.  
Public PropertyVoucherCodeGets or sets the Order Voucher code used to activate voucer discount.  
Public PropertyWeightGets the total weight of the ordered products.  
Top
Public Methods
 NameDescription
Public MethodCapturePerforms capture on this order and stores the resulting OrderCaptureInfo on the order  
Public MethodCheckOrderChecks the order.  
Public MethodClearCachedPricesClears the cached prices.  
Public MethodCloneClones this instance.  
Public MethodConnectToUsersEmailConnects to users email.  
Public MethodCopyCopies this instance and saves it in the DB. This method is similar to Clone method.  
Public MethodCreateOrderLineOverloaded. Adds a new OrderLine to the OrderLineCollection of this Order based on the given Dynamicweb.eCommerce.Products.Product.  
Public MethodDeleteOverloaded. Deletes this instance.  
Public MethodDowngradeToCartConverts the order back to cart  
Public MethodForcePriceRecalculationForces the recalculation of the Price.  
Public MethodGetCartFormNameGets the name of the cart form.  
Public Methodstatic (Shared in Visual Basic)GetEmptyOrderDataSetGets an empty DataSet with the schema from the database.  
Public Methodstatic (Shared in Visual Basic)GetOrderByIDOverloaded. Gets the order by ID.  
Public MethodGetOrderDataReaderGets the DataReader with order.  
Public Methodstatic (Shared in Visual Basic)GetOrderDataSetByOrderIDGets the DataSet object with orders.  
Public Methodstatic (Shared in Visual Basic)GetOrdersOverloaded. Gets the orders.  
Public MethodGetPropertyTypeGets the property type.  
Public MethodGetPropertyValueGets the property value.  
Public Methodstatic (Shared in Visual Basic)GetTotalPurchasesByCustomerIDGet total purchases price by customer Id  
Public MethodRemoveNoneActiveProductsRemoves 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.  
Public MethodSaveOverloaded. Saves this instance.  
Public MethodSaveDebuggingInfosSaves the debugging information.  
Public MethodSendToOverloaded. Sends the mail to the specified adress.  
Public MethodUpdateCartToOrderUpdates the order.  
Public MethodUpdateExistOrderFromCartToOrderUpdates the existing order from cart to order.  
Public MethodUpdateGatewayResultOverloaded. Updates the gateway result.  
Public MethodUpdateStepInfoUpdates the step information.  
Public MethodUpdateVATOverloaded. Updates the VAT.  
Top
See Also

Reference

Order Class
Dynamicweb.eCommerce.Orders Namespace

Send Feedback