Umbraco Commerce v15.1.0-rc release notes

mattbrailsford · web-flow · commit b928ed7fa218 · 2025-02-06T14:03:30.000Z
diff --git a/15/umbraco-commerce/SUMMARY.md b/15/umbraco-commerce/SUMMARY.md
@@ -36,6 +36,7 @@
 * [Update Cart](how-to-guides/update-cart.md)
 * [Delete item from Cart](how-to-guides/delete-item.md)
 * [Customizing Templates](how-to-guides/customizing-templates.md)
+* [Configuring Store Cleanup](how-to-guides/configuring-cart-cleanup.md)
 
 ## Key Concepts
 
@@ -71,6 +72,7 @@
 * [UI Extensions](key-concepts/ui-extensions/README.md)
   * [Analytics Widgets](key-concepts/ui-extensions/analytics-widgets.md)
   * [Entity Quick Actions](key-concepts/ui-extensions/entity-quick-actions.md)
+  * [Order Line Actions](key-concepts/ui-extensions/order-line-actions.md)
   * [Order Properties](key-concepts/ui-extensions/order-properties.md)
   * [Order Collection Properties](key-concepts/ui-extensions/order-collection-properties.md)
   * [Order Line Properties](key-concepts/ui-extensions/order-line-properties.md)
diff --git a/15/umbraco-commerce/how-to-guides/configuring-cart-cleanup.md b/15/umbraco-commerce/how-to-guides/configuring-cart-cleanup.md
@@ -0,0 +1,44 @@
+---
+description: Learn how to configure a cart cleanup routine.
+---
+
+# Configuring Cart Cleanup
+
+{% hint style="info" %}
+Available from Umbraco Commerce 15.1.0
+{% endhint %}
+
+By default Umbraco Commerce will keep all created carts indefinately. Over time this can obviously become an issue. To assist with this is it possible to configure a cart cleanup routine to delete carts older than a pre-configured time interval.
+
+This service can be enabled and configured in the `appSettings.json`
+
+```json
+{
+    "Umbraco" : {
+        "Commerce": {
+            "CartCleanupPolicy": {
+                "EnableCleanup": true,
+                "KeepCartsForDays": 800,
+                // Below settings are optional
+                "FirstRunTime": string; the time to first run the scheduled cleanup task, in crontab format
+                "Period": string; how often to run the task, in timespan format
+                // Configure diffrent policies per store
+                "PerStorePolicies": {
+                    "StoreAlias": {
+                        "KeepCartsForDays": 800,
+                    }
+                }
+            }
+        }
+    }
+}
+```
+
+## Cart Conversion Rates Widget
+
+When enabling the cart cleanup service, it's important to know that this can affect the cart conversion rates widget in the analytics section. If the widget is configured to show a time period that exceeds the cleanup policies time frame then a warning will be displayed.
+
+![Cart Conversion Rate date range exceeds the cart cleanup policy configuration warning](../media/v14/cart-conversion-rates-warning.png)
+
+
+
diff --git a/15/umbraco-commerce/key-concepts/ui-extensions/order-line-actions.md b/15/umbraco-commerce/key-concepts/ui-extensions/order-line-actions.md
@@ -0,0 +1,82 @@
+---
+description: Order Line Actions UI Extension for Umbraco Commerce
+---
+
+# Order Line Actions
+
+{% hint style="info" %}
+Available from Umbraco Commerce 15.1.0
+{% endhint %}
+
+Order Line Actions allow you to display buttons against each order line of a cart / order allowing you to perform custom actions per order line.
+
+![Custom Order Line Action](../../media/v14/order-line-action.png)
+
+## Registering an Order Line Action
+
+```typescript
+import { UcManifestOrderLineAction } from "@umbraco-commerce/backoffice";
+
+export const manifests : UcManifestOrderLineAction[] = [
+    {
+        type: 'ucOrderLineAction',
+        kind: 'default',
+        alias: 'My.OrderLineAction.MyOrderLineAction',
+        name: 'My Order Line Action',
+        weight: 300,
+        forEntityTypes: [ 'uc:cart', 'uc:order' ],
+        api: () => import('./my-order-line-action.api.js'),
+        meta: {
+            label: "#orderLineActions_myOrderLineAction",
+            icon: 'icon-star'
+        }
+    }
+];
+
+extensionRegistry.register(manifests);
+```
+
+Each entry must have a type of `ucOrderLineAction` along with a unique `alias` and `name`. Unless you wish to override the button, the `kind` key should be set to `default`. An `api` key should be defined that imports the implementation of the `UcOrderLineActionApi` interface.
+
+A `meta` entry provides configuration options for order line actions:
+
+| Name | Description |  
+| -- | -- |
+| `label` | A label for this action (supports the `#` prefix localization string syntax) |
+| `icon` | In icon to display for the action |
+
+## The Order Line Action API
+
+In order to define the logic to perform when an order line action button is clicked, you'll need to implement the `UcOrderLineActionApi` interface. This interface is defined as
+
+```typescript
+export interface UcOrderLineActionApi extends UmbApi {
+    manifest: UcManifestOrderLineAction;
+    storeId: string;
+    orderId: string;
+    orderLineId: string;
+    execute(): Promise<void>;
+}
+```
+
+This provides order line action implementations with access to the defined `manifest` and contextual information via the `storeId`, `orderId` and `orderLineId` properties and expects the implementation of an `execute` method to act.
+
+An example implementation would be
+
+```typescript
+// my-order-line-action.api.js
+
+import { UcOrderLineActionApi, UcManifestOrderLineAction } from "@umbraco-commerce/backoffice";
+import { UmbControllerBase } from "@umbraco-cms/backoffice/class-api";
+
+export default class MyOrderLineActionApi extends UmbControllerBase implements UcOrderLineActionApi {
+    manifest!: UcManifestOrderLineAction;
+    storeId!: string;
+    orderId!: string;
+    orderLineId!: string;
+    async execute() {
+        console.log(`You clicked ${this.manifest!.meta.label} for order line ${this.orderLineId}`);
+        return Promise.resolve();
+    }
+}
+```
diff --git a/15/umbraco-commerce/media/v14/cart-conversion-rates-warning.png b/15/umbraco-commerce/media/v14/cart-conversion-rates-warning.png
diff --git a/15/umbraco-commerce/media/v14/order-line-action.png b/15/umbraco-commerce/media/v14/order-line-action.png
diff --git a/15/umbraco-commerce/release-notes/README.md b/15/umbraco-commerce/release-notes/README.md
@@ -17,6 +17,13 @@ If you are upgrading to a new major version, check the breaking changes in the [
 
 This section contains the release notes for Umbraco Commerce 14 including all changes for this version.
 
+#### 15.1.0-rc1 (TBD)
+
+Read the [v15.1.0-rc release post](./v15.1.0-rc.md) for further background on this release.
+
+* Added cart cleanup service
+* Added order line actions UI extension point
+
 #### 15.0.1 (5th Feb 2025)
 
 * Fixed `TranslatedValue` erroring if the language key was `null`, instead of falling back to the default value.
diff --git a/15/umbraco-commerce/release-notes/v15.1.0-rc.md b/15/umbraco-commerce/release-notes/v15.1.0-rc.md
@@ -0,0 +1,43 @@
+---
+description: Umbraco Commerce v15.1.0-RC release notes.
+---
+
+# v15.1.0-RC
+
+## Key Takeaways
+
+* [Cart Cleanup Service](v15.1.0-rc.md#cart-cleanup-service).
+* [Order Line Actions](v15.1.0-rc.md#order-line-actions)
+
+## Cart Cleanup Service
+
+The cart cleanup service is a new background service that periodically cleans up old abandoned carts. This service is off by default, but can be enabled via app settings.
+
+```json
+{
+    "Umbraco" : {
+        "Commerce": {
+            "CartCleanupPolicy": {
+                "EnableCleanup": true,
+                "KeepCartsForDays": 800
+            }
+        }
+    }
+}
+```
+
+See the [Configuring Cart Cleanup guide](../how-to-guides/configuring-cart-cleanup.md) for more details.
+
+## Order Line Actions
+
+Order line actions are a new UI extension point that lets you register custom buttons to display against each order line of a cart / order. 
+
+![Custom Order Line Action](../media/v14/order-line-action.png)
+
+See the [Order Line Actions docs](../key-concepts/ui-extensions/order-line-actions.md) for more details.
+
+## What to Test and How to Give Feedback
+
+We welcome any feedback on installation or upgrade issues, as well as any bugs found in the sections mentioned above.
+
+Issues can be raised on the Umbraco Commerce issue tracker at [https://github.com/umbraco/Umbraco.Commerce.Issues/issues](https://github.com/umbraco/Umbraco.Commerce.Issues/issues).
