Skip to content

Installation beta

Beta Release - This plugin is currently in beta. APIs, database schema, and behaviour may change between releases. It is not recommended for production use without thorough testing in your environment. If you encounter a bug or unexpected behaviour, please open an issue - feedback at this stage directly shapes the stable release.

Requirements

  • Craft CMS 5.0 or later
  • Craft Commerce 5.0 or later
  • PHP 8.2 or later

Install using Composer

# go to the project directory
cd /path/to/my-project

# tell Composer to load the plugin
composer require johnhenry/craft-order-lifecycle

# tell Craft to install the plugin
./craft plugin/install order-lifecycle

Install using DDEV

ddev composer require "johnhenry/craft-order-lifecycle:^1.0.0-beta.1" -w && ddev craft plugin/install order-lifecycle

Install from the Plugin Store

Go to the Plugin Store in your project’s Control Panel and search for “Order Lifecycle”. Then press “Install”.

Post-Installation

After installation, event tracking starts automatically. No additional configuration is required for basic functionality.

Add the Timeline Field

The timeline view is a custom field type that must be added to your order field layout before it appears on order edit pages:

  1. Go to CommerceSystem SettingsOrder Field Layout
  2. Drag the Order Lifecycle field type into your layout
  3. Save the layout

Verify Installation

  1. Go to CommerceOrders
  2. Open any order
  3. You should see the Order Lifecycle field with a timeline (may be empty for orders created before installation)

What's Next?