Important

You are browsing the documentation for version 1.6 of OroCommerce, OroCRM and OroPlatform, which is no longer maintained. Read version 5.1 (the latest LTS version) of the Oro documentation to get up-to-date information.

See our Release Process documentation for more information on the currently supported and upcoming releases.

Available in OroCRM Available in OroCommerce

Checkout Workflow

Overview

The Checkout workflow represents a standard checkout procedure in the eCommerce environment. It is a system workflow that defines the sequence of steps and transitions that a user can go through when creating an order in the storefront.

To reach the workflow:

  1. Navigate to System > Workflows in the main menu.
  2. Click Checkout to open the flow.

On the Checkout workflow page, you can perform the following actions:

  • Deactivate the workflow - click Deactivate to deactivate the workflow.
  • Activate the workflow - click Activate to activate the workflow.
../../../../../../_images/CheckoutViewPageBackoffice.png

On the page of all workflows, you can perform the following actions for the Checkout workflow:

  • View the workflow:
  • Deactivate / Activate the workflow: /
../../../../../../_images/CheckoutGridBackoffice.png

Steps and Transitions

The following table illustrates the steps and transitions that the Checkout workflow consists of:

../../../../../../_images/CheckoutWfTable.png

Sample Flow

As an illustration, we are going to proceed through the steps of the Checkout workflow to see how it works.

Several items have been added to a shopping list in the OroCommerce storefront. To proceed to the checkout, click Create Order on the bottom right of the shopping list page.

Shopping list with option to create order and proceed to checkout

Note

The Create Order button is available if the following conditions are met:

  • At least one shipping method is available
  • At least one payment method is available
  • There is at least one product with a price in the shopping list
  • Items to be purchased are available in the inventory in the back-office

A warning message is shown if for some reason you are unable to start the checkout process.

Step 1: Billing Information

The checkout is now open. The next step is to enter billing information for the order by selecting an existing address from the address book, or creating a new one.

Checking Ship to this address allows you to use the provided billing address as shipping.

Clicking Continue redirects you to the next step.

Note

You can edit the already provided information (until the order is submitted) by clicking on the left side of the page.

The billing information step at the checkout (with consents)

Step 2: Shipping Information

If the Ship to this address box has been checked at the Billing Information step, the provided address is automatically selected at the Shipping Information step.

To edit shipping information, clear the Use billing address box and provide a different shipping address for the order.

../../../../../../_images/UseBillingAddressBox.png

Step 3: Shipping Method

Provide a shipping method by selecting one from the list of the available methods.

The shipping method step at the checkout

Step 4: Payment

Choose a suitable payment method by selecting it from the list of all available methods.

The payment method step at the checkout

Step 5: Order Review

Once all the necessary information has been provided, you can review the order at the Order Review step:

  • View Options for the order:
    • Do not ship later than
    • PO Number
    • Notes
    • Delete the shopping list
  • Check quantity, price, subtotal, shipping and total cost
  • Edit the Order
  • Edit the already provided information by clicking on the left side of the page

To submit the order, click Submit Order at the bottom of the page.

The order review step at the checkout

Once submitted, the order will be received and dealt with by the sales team.

The page of the order in the back-office, once the order is submitted