Introduction

An order is a request to purchase a product or service from a shop. Orders are created when a visitor adds products to the shopping cart and then completes the checkout process.

Once an order has been placed it appears in the order list – Ecommerce > Orders (Figure 1.1), from which it is processed and moved through an order flow. 

An order flow consists of a set of order states which correspond to a particular state in the order handling process, e.g. received, printed, packed, shipped, and completed, or something in that vein.

Figure 1.1 An order list

The order list consists of three things:

  • A list of the most recent orders placed on the solution (1)
  • A set of filters for, well, filtering the order list (2)
  • A set of tools in the ribbon bar (3)

Orders in the list may be colored black (completed) or red (incomplete). An order is considered incomplete if it was interrupted during the last order step. The color of the order is therefore not related to the capture state. A clock-icon next to the order ID means that it was generated as part of a recurring order series. You can right-click the list columns and add or remove columns as you see fit.

The filter section (Figure 1.2) makes it easy to filter and search the order list when you’re looking for something specific.

Figure 1.2 Order list filters

You can filter on:

  • Date
  • Order state (see Order Flows)
  • Order progress
  • Capture state
  • Transfer status – whether the order has been exported to an external system, only relevant for integrated solutions

You can also search the order list – searching for an ID is the quickest option, searching all fields the slowest

Filters are applied and reset from the ribbon bar (Figure 1.3).

Figure 1.3 Applying or resetting filters

Database

These are the database tables relevant for Orders and related features:

EcomOrders

Contains orders. Incomplete orders are indicated by an idea containing CART. On checkout carts are converted to orders and given a new id (containing ORDER).

Field name Data type Length
OrderId nvarchar 50
OrderShopId nvarchar 255
OrderDate datetime 8
OrderModified datetime 8
OrderComplete bit 1
OrderDeleted bit 1
OrderStateId nvarchar 50
OrderVAT float 8
OrderIP nvarchar 255
OrderReferrer nvarchar 255
OrderTransactionValue nchar 2
OrderTransactionType nvarchar 50
OrderTransactionStatus nvarchar 50
OrderTransactionAmount float 8
OrderTransactionPayGatewayCode nvarchar 4
OrderTrackTraceNumber nvarchar 50
OrderShippingMethod nvarchar 255
OrderShippingMethodFee float 8
OrderPaymentMethod nvarchar 255
OrderPaymentMethodFee float 8
OrderSalesDiscount float 8
OrderCurrencyName nvarchar 50
OrderCurrencyRate float 8
OrderCurrencyCode nvarchar 3
OrderCart bit 1
OrderFieldsXML nvarchar Max
OrderReSendEmail nvarchar 255
OrderCustomerNumber nvarchar 255
OrderCustomerCompany nvarchar 255
OrderCustomerName nvarchar 255
OrderCustomerAddress nvarchar 255
OrderCustomerAddress2 nvarchar 255
OrderCustomerZip nvarchar 50
OrderCustomerCity nvarchar 255
OrderCustomerCountry nvarchar 50
OrderCustomerRegion nvarchar 50
OrderCustomerPhone nvarchar 50
OrderCustomerFax nvarchar 50
OrderCustomerEmail nvarchar 255
OrderCustomerCell nvarchar 50
OrderCustomerRefId nvarchar 255
OrderCustomerEAN nvarchar 255
OrderCustomerVatRegNumber nvarchar 50
OrderDeliveryCompany nvarchar 255
OrderDeliveryName nvarchar 255
OrderDeliveryAddress nvarchar 255
OrderDeliveryAddress2 nvarchar 255
OrderDeliveryZip nvarchar 50
OrderDeliveryCity nvarchar 255
OrderDeliveryCountry nvarchar 50
OrderDeliveryRegion nvarchar 50
OrderDeliveryPhone nvarchar 50
OrderDeliveryFax nvarchar 50
OrderDeliveryEmail nvarchar 255
OrderDeliveryCell nvarchar 50
OrderTotalPrice float 8
OrderComment nvarchar Max
OrderCustomerComment nvarchar Max
OrderWeight float 8
OrderVolume float 8
OrderPriceWithVAT float 8
OrderPriceWithoutVAT float 8
OrderPriceVAT float 8
OrderPriceVATPercent float 8
OrderShippingFeeWithVAT float 8
OrderShippingFeeWithoutVAT float 8
OrderShippingFeeVAT float 8
OrderShippingFeeVATPercent float 8
OrderPaymentFeeWithVAT float 8
OrderPaymentFeeWithoutVAT float 8
OrderPaymentFeeVAT float 8
OrderPaymentFeeVATPercent float 8
OrderPriceBeforeFeesWithVAT float 8
OrderPriceBeforeFeesWithoutVAT float 8
OrderPriceBeforeFeesVAT float 8
OrderPriceBeforeFeesVATPercent float 8
OrderCustomerAccessUserId int 4
OrderCustomerAccessUserUserName nvarchar 255
OrderShippingMethodId nvarchar 50
OrderPaymentMethodId nvarchar 50
OrderGatewayResult nvarchar Max
OrderStepNum int 4
OrderTransactionNumber nvarchar 255
OrderCustomerCountryCode nvarchar 50
OrderDeliveryCountryCode nvarchar 50
OrderStepHistory nvarchar Max
OrderLanguageId nvarchar 50
OrderTransactionMailSend bit 1
OrderShippingMethodDescription nvarchar Max
OrderPaymentMethodDescription nvarchar Max
OrderCustomerNewsletterSubcribe bit 1
OrderGatewayPaymentStatus nvarchar 255
OrderGatewayTransactionProblems nvarchar Max
OrderGatewayUniqueId nvarchar 255
OrderCaptureInfo nvarchar Max
OrderCartV2StepIndex int 4
OrderSecret nvarchar 255
OrderShippingCountrySelection nvarchar 255
OrderPaymentCountrySelection nvarchar 255
OrderCustomerAccepted bit 1
OrderDebuggingInfo nvarchar Max
OrderHasSetUserDetails bit 1
OrderTrackAndTraceId int 4
OrderTrackAndTraceParameters nvarchar Max
OrderIntegrationOrderId nvarchar Max
OrderRequisition nvarchar 255
OrderAXOrderId nvarchar Max
OrderVisitorSessionId nvarchar 255
OrderIsExported bit 1
OrderVoucherCode nvarchar 36
OrderCustomerSurname nvarchar 255
OrderCustomerInitials nvarchar 50
OrderCustomerPrefix nvarchar 50
OrderDeliverySurname nvarchar 255
OrderDeliveryInitials nvarchar 50
OrderDeliveryPrefix nvarchar 50
OrderShippingDocumentData nvarchar Max
OrderShippingProviderData nvarchar Max
OrderCompletedDate datetime 8
OrderSecondaryUserId int 4
OrderReceiptShowCount int 4
OrderCaptureAmount float 8
OrderTransactionCardType nvarchar 100
OrderExternalPaymentFee float 8
OrderAutoId int 4
OrderPriceCalculationDate datetime 8
OrderTotalPoints float 8
OrderTotalRewardPoints float 8
OrderTotalDiscountWithVAT float 8
OrderTotalDiscountWithoutVAT float 8
OrderTotalDiscountVAT float 8
OrderTotalDiscountVATPercent float 8
OrderIsQuote bit 1
OrderTransactionCardNumber nvarchar 50
OrderCustomerTitle nvarchar 255
OrderCustomerFirstName nvarchar 255
OrderCustomerMiddleName nvarchar 255
OrderCustomerHouseNumber nvarchar 255
OrderDeliveryTitle nvarchar 255
OrderDeliveryFirstName nvarchar 255
OrderDeliveryMiddleName nvarchar 255
OrderDeliveryHouseNumber nvarchar 255
OrderCheckoutPageID int 4
OrderVisitorSessionDate datetime 8
OrderPriceCalculatedByProvider bit 1
OrderTaxTransactionNumber nvarchar 50
OrderVoucherUseType int 4
OrderContextID nvarchar 50
OrderGiftcardTransactionFailed bit 1
OrderShippingFeeRuleName nvarchar 255
OrderRecurringOrderId int 4
OrderPaymentRecurringInfo nvarchar Max
OrderSavedCardID int 4
OrderIsRecurringOrderTemplate bit 1
OrderTransactionToken nvarchar Max
OrderTransactionTokenCheckSum nvarchar 128
OrderIsLedgerEntry bit 1
OrderIsPayable bit 1
OrderReturnOperations nvarchar Max

EcomOrderDebuggingInfo

Debug log for order flows. Links to order (EcomOrders) via OrderDebuggingInfoOrderID.

Field name Data type Length
OrderDebuggingInfoId int 4
OrderDebuggingInfoOrderId nvarchar 50
OrderDebuggingInfoSource nvarchar 255
OrderDebuggingInfoTime datetime 8
OrderDebuggingInfoMessage nvarchar Max
OrderDebuggingInfoType int 4
OrderDebuggingInfoOrderAutoId int 4

EcomOrderField

Contains order field definitions from Settings -> Ecom -> Orders -> Order fields.

Field name Data type Length
OrderFieldId nvarchar 255
OrderFieldName nvarchar 255
OrderFieldSystemName nvarchar 255
OrderFieldTemplateName nvarchar 255
OrderFieldTypeId int 4
OrderFieldTypeName nvarchar 255
OrderFieldLocked bit 1
OrderFieldSort int 4
OrderFieldAutoId int 4

EcomOrderLineFields

Contains order line field definitions from Settings -> Ecom -> Orders -> Order line fields.

Field name Data type Length
OrderLineFieldSystemName nvarchar 255
OrderLineFieldName nvarchar 255
OrderLineFieldLength int 4
OrderLineFieldAutoId int 4
EcomOrderLineFieldsSorting int 4

EcomOrderLineFieldGroupRelation

Contains information about which orderline fields are associated to products in a specific group.

Field name Data type Length
OrderLineFieldGroupRelationSystemName nvarchar 255
OrderLineFieldGroupRelationGroupId nvarchar 255
OrderLineFieldGroupRelationAutoId int 4
OrderLineFieldGroupRelationShopID nvarchar 255

EcomOrderLines

Contains orderlines from orders (EcomOrders) linked via (OrderLineOrderId).

Field name Data type Length
OrderLineId nvarchar 50
OrderLineOrderId nvarchar 50
OrderLineParentLineId nvarchar 50
OrderLineBOM bit 1
OrderLineDate datetime 8
OrderLineModified datetime 8
OrderLineProductNumber nvarchar 255
OrderLineProductId nvarchar 30
OrderLineProductVariantId nvarchar 255
OrderLineProductName nvarchar 255
OrderLineProductVariantText nvarchar 255
OrderLineUnitPrice float 8
OrderLineVatPercent float 8
OrderLineVatPrice float 8
OrderLineQuantity float 8
OrderLineType nvarchar 255
OrderLineReference nvarchar 255
OrderLineBOMItemId nvarchar 50
OrderLineUnitId nvarchar 50
OrderLineWeight float 8
OrderLineVolume float 8
OrderLinePriceWithVAT float 8
OrderLinePriceWithoutVAT float 8
OrderLinePriceVAT float 8
OrderLinePriceVATPercent float 8
OrderLineUnitPriceWithVAT float 8
OrderLineUnitPriceWithoutVAT float 8
OrderLineUnitPriceVAT float 8
OrderLineUnitPriceVATPercent float 8
OrderLinePageId int 4
OrderLineDiscountId nvarchar 50
OrderLineFieldValues nvarchar Max
OrderLineAttachment nvarchar Max
OrderLineAutoId int 4
OrderLineWishListId int 4
OrderLinePriceCalculationReference nvarchar 255
OrderLineUnitPriceCalculationReference nvarchar 255
OrderLineUnitPoints float 8
OrderLineUnitRewardPoints float 8
OrderLinePoints float 8
OrderLineRewardPoints float 8
OrderLineRewardId int 4
OrderLineReverseChargeForVat bit 1
OrderLineTotalDiscountWithVAT float 8
OrderLineTotalDiscountWithoutVAT float 8
OrderLineTotalDiscountVAT float 8
OrderLineTotalDiscountVATPercent float 8
OrderLineGiftCardCode nvarchar Max

EcomTrackAndTrace

Contains setup data for track and trace as defined in Settings -> Ecommerce -> Orders -> Track and trace.

Field name Data type Length
TrackAndTraceId int 4
TrackAndTraceName nvarchar 255
TrackAndTraceURL nvarchar Max
TrackAndTraceParameters nvarchar Max

In this section you will learn about:

  • Automatically exporting completed orders

Dynamicweb can be set up to automatically generate and export and XML file containing the order details every time an order is completed.

To do so, go to Settings > Integration and click the Export Orders node to open the tool (Figure 11.1).

Figure 11.1 The Export Orders tool

To use the export order tool you must:

  • Check Enable Order exports to XML to activate the tool
  • Specify an output folder
  • Optionally select an XSL file to transform the XML output – by default, the output format is identical to the format used by the XML Provider in the Data Integration app

You can also set up email notifications, in which case the recipients will be mailed the order xml in an email (it will still be generated in the output folder as well).