eCommerce Order Management

The fulfillment aspect of eCommerce involves:

Prerequisites: To process orders, the Distributed Transaction Coordinator (DTC) Windows service must be running. It is started by default when you install Ektron.

Orders

Orders

The orders screen provides information about all orders in your eCommerce system. To access it, go to Workarea > Settings > Commerce > Fulfillment > Orders.

Initially, orders are sorted by submission date and time, with the most recent at the top.

Selecting orders by criteria

Selecting Orders by Criteria

You can select orders by any of the following criteria.

  • entry date range
  • customer
  • catalog entry

To use any filter, choose Reporting (see below) then the appropriate filter option:

  • Most Recent—This is the the default select and sort order: all orders with the most recent on top.
  • By Date(s)—If you choose to view orders By Date(s) and want to view orders for today, enter tomorrow as the ending date.
  • By Customer
  • By Product
  • By ID
Order statuses

Order Statuses

NOTE: The following table assumes you use the default workflow installed with eCommerce. If you customize the workflow, the following table may be inaccurate. See Also: Customizing Workflows

Status

Description

How to Set

Received

Order has been submitted.

Customer submits order

Fraud

Your organization has determined that the order is fraudulent.

View Order Screen > Action Menu > Mark as Fraud

Shipped

Order has been shipped. This status can be the workflow’s end point. You do not need to use the Completed status.

View Order Screen > Action Menu > Ship Order

or

View Order Screen > Action Menu > Enter/Edit Tracking Number > CheckMark as Shipped checkbox and save

Completed

All order activities are finalized. No events can occur to a Completed order.

View Order Screen > Action Menu > Process Order

Cancelled

Order has been canceled.

View Order Screen > Action Menu > Cancel Order

InProcess

Automatically assigned when order is submitted.

Order placed but not yet captured

The View Order screen

The View Order Screen

To view the details of any order, click it. When you do, the View Order screen appears.

If the Workflow tab does not display a flowchart, verify that the server’s Distributed Transaction Coordinator (DTC) Windows service is running. It is started by default when you install Ektron, but if it stops for some reason, the Workflow does not appear on this screen.

Capturing orders

Capturing Orders

It's important to distinguish between authorization and capture in relation to orders:

  • Authorization occurs while a customer is using the Checkout server controls. It submits a customer’s payment information to a payment gateway, bank, or PayPal, and returns either an approval with an authorization number (transaction ID) or a decline along with an explanation.
  • Capture is the process of submitting encrypted order information (including the transaction ID) to a payment gateway account, bank, or PayPal. At this time, the account is charged for the order amount.

Take into account the following:

After an order has been captured, you receive confirmation from the paying agency that the money has been deposited to your account and is available. At this time, you use the Mark as Settled option to inform the eCommerce feature that payment has been received. This changes the order status to Complete.

Payment Method

Tangible item

Intangible Item

PayPal or credit card

When goods are shipped

When customer submits order

Check

When check clears

See Also: Payment Options

Capturing an order

Capturing an Order

  1. From the Workarea, choose Settings > Commerce > Fulfillment > Orders.
  2. Click the order that you want to capture.
  3. Click the Payment tab.
  4. Click the payment to display. The View Payment screen appears, showing information about the transaction captured when the customer (site visitor) submitted his payment information.
  5. Choose Action > Capture. You are asked to confirm the action.
  6. Click OK.
Canceling an order

Canceling an Order

Click Action > Cancel Order to stop all processing on the order. If you do, the order’s status changes to Canceled.

Deleting an order

Deleting an Order

To delete any order, select it from the Orders screen then click Delete ().

After deleting an order, you cannot recover its information.

Entering a tracking order

Entering a Tracking Number

When an order is shipped, the shipping provider typically provides a tracking number to help locate the shipment within the delivery chain. Use the Enter Tracking Number option to enter this part of the order information.

After entering the tracking number, you can indicate whether the order has shipped.

Viewing the tracking number

Viewing the Tracking Number

You can display an order’s tracking number on the View Order screen by clicking the Address tab and looking under the Shipping Address.

Marking an order as fraudulent

Marking the Order as Fraudulent

Use this option if your organization determines that the order is fraudulent. These orders cannot be processed any further.

Marking the order as shipped

Marking the Order as Shipped

When you enter an order's tracking number, the screen lets you mark it as shipped. See Also: Entering a Tracking Number

If you did not mark the item as shipped at that time, a Ship Order option appears on the Action menu. To denote that such an order has shipped:

NOTE: If that order has not yet been captured, it will be captured as part of the shipping of the order.

  1. From the Workarea, choose Settings > Commerce > Fulfillment > Orders.
  2. Click the order that is being shipped.
  3. Choose Action > Ship Order.
Entering order notes

Entering Order Notes

After selecting an order, you are allowed to submit a note about it. You can use the note to record information about the item, the buyer, shipping irregularities, and so on.

Only one note can be saved per order. If you edit and save a note, the previous note text is permanently removed.

Order workflow

Order Workflow

Ektron uses Microsoft’s Windows Workflow Foundation to create and implement order process workflows to handle the ordering process. The workflow can be as simple or complex as your business requires.

For example, you have a simple workflow that sends one email to the customer when an order is received, and another to your shipping department. Or, you could have a more complex workflow that:

  • sends an email to the customer when the order is received
  • checks to see whether the item is a tangible product or a virtual product. Then, continues down the workflow path that’s appropriate for the item.
  • handles shipping notifications and updates the account throughout the shipping process
  • handles the order if it is canceled
  • handles the order if it is determined to be fraudulent
  • marks the order as complete once all activities are finished

For more information on workflows, see Customizing Workflows.

OrderList server control

OrderList Server Control

The OrderList server control lets customers view a list of processed orders. Customers typically reach this server control by clicking a link on your site, such as the View Order History link.

Customers also can reach this control through a link at the end of the Checkout process. The link appears when the Checkout server control’s TemplateOrderHistory property contains the path to the template containing the OrderList server control. See Also: Checkout Server Control.

Viewing a customer's orders list

Viewing a Customer’s Orders List

When customers arrive at this server control, they see the View All Orders portion of the server control.

This part of the server control displays a list of submitted orders. Customers can view each order's date, confirmation number, and status. When the number of orders exceeds the number defined in the MaxResults property, the list is paged and a user can navigate among pages with the links provided.

A customer can click the confirmation number to view the Order Details screen.

To navigate back to the list of all orders, customers click View All Orders.

Viewing an order's details

Viewing an Order’s Details

  • Status—The status of the order. See Also: Order Statuses
  • Order Date—The date the order was submitted. This is the date an order went through the checkout process.
  • Order Number—The order's ID number.
  • Ship To:—Information needed to ship the order to customer.
    • Person to whom the product is being shipped
    • Company Name (optional)
    • Street Address
    • City and State or Region
    • Country
    • Zip Code
    • Tracking Number—this field appears if a tracking number has been entered in the View Order screen in the Workarea.
  • Bill To:—Displays information about who is being billed for the order.
    • Person paying for the order
    • Credit Card information—For security purposes, only the last 4 digits appear.
    • Company Name (optional)
    • Street Address
    • City and State or Region
    • Country
    • Zip Code
  • Description—A list of products in the order. When the path to the product server control is entered in the TemplateProduct property, the product’s title becomes a hyperlink.
  • Quantity—The total number of each product.
  • Sale Price—The per unit price of each product.
  • Total—The total amount paid for each product ordered. This is the Unit Price multiplied by the Quantity.
  • Subtotal—The sum of all the order’s line products before additional charges or discounts, such as tax, shipping and coupons.
  • Coupon Total—The total amount discounted, based on all applied coupons.
  • Tax—The tax amount applied to this order. See Also: Calculating an Order’s Tax Amount
  • Shipping—The amount charged to ship the order to the recipient. See Also: eCommerce Shipping Screens
  • Total—The sum of all charges, including all line items, tax, shipping and handling.
Flow of the OrderList server control

Flow of the OrderList Server Control

The following image depicts the flow of the OrderList Server Control.

OrderList server control properties

OrderList Server Control Properties

The following are Ektron-specific server control properties. You can find information about native .NET properties such as font, height, width and border style in Visual Studio® help.

  • Authenticated (String)

    Indicates if you are logged into the CMS Explorer and can use it to browse to content, collections, and so on. See Also: Browsing Your Ektron Site Using CMS Explorer.

  • CacheInterval (Double)

    The number of seconds that the server control’s data is cached. The default is 0 (zero). For example, if you want to cache the data for 5 minutes, set to 300. See Also: Caching with Server Controls.

  • DoInitFill (Boolean)

    By default, Fill occurs during the Page_Init event. Set to false if you want to postpone the fill-action until later. In this case, Fill is automatically called during the Page Render event. You might do this if you need to set or change a property on the control in code-behind and have it render with your changes shown.

  • CustomXml (Code-behind Only) (String)

    Lets you inject custom XML into the generated XML before being processed by the XSLT. Enter a string of XML that you want to make available to the XSLT as follows:

    <root><customXml>custom-xml-inserted-here</customXml></root>

    See Also: Displaying Custom XML in Ektron’s Server Controls.

  • DefaultUserId (Long)

    The default ID of the user for which to display a list of orders.

  • DisplayXslt (String)

    If desired, enter a relative or absolute path to an Xslt that determines the display of the page. By default, the control uses OrderList.xsl. This file is located in siteroot\Workarea\Xslt\Commerce

    IMPORTANT: If you specify an external file, do not store this file in the Workarea folder. If you store this file in the Workarea folder, the file will be lost when you upgrade.

  • DynamicProductParameter (String)

    The QueryString parameter name which is used to pass the product ID to the product details page. For example, if your QueryString parameter for products is ID, enter that in this property. Then, when customers click a product in their order list, this parameter is passed with the product’s ID to the product details page.

  • DynamicOrderParameter (String)

    Sets the QueryString parameter name which is used to pass an order ID dynamically. By default, this parameter is OID.

  • GuestOrderView (Boolean)

    Set to true to allow guest account visitors to view their orders. If you do, a visitor can go to the View Orders screen, enter an order number and an email address, then view all submitted orders. See Also: Guest Account Registration and Viewing a Customer’s Orders List

  • Hide (Boolean)

    Hides or displays the output of the control in design time and run time.

    • True—Hide the control output.
    • False—Display the control output.
  • Language (Integer)

    Set a language for viewing content; shows results in design-time (in Visual Studio) and at run-time (in a browser).

  • MaxResults (Integer)

    Specify the number of orders to show per page when a customer views their order history. If the number of orders exceeds the quantity defined in this property, the list is paged and the customer uses the paging navigation to move through the list.

  • PageSize (Integer)

    The maximum number of orders to show per page.

  • Stylesheet (String)

    Specify the path to a style sheet for use with this server control. The location can be relative or absolute. Leave blank to use the default style sheet.

  • SuppressWrapperTags (Boolean)

    Suppresses the output of the span/div tags around the control.

    • True—Suppress wrap tags.
    • False (default)—Allow wrap tags.
  • TemplateProduct (String)

    The URL path of the template that allows a customer to view the details of a product in an order. When a path is entered, the product’s title becomes a link that lets customers navigate to the template containing details of the product; for example, the template containing a Product server control.