Order Properties

With the use of Properties, Umbraco Commerce allows a lot of flexibility to capture whatever data you need to record against an Order. To complement that functionality, it is also possible to configure those properties to be editable within the backoffice UI.

Order Properties are defined as manifest entries in your umbraco-package.manifest.

"extensions": [
    {
        "type": "ucOrderProperty",
        "alias": "Uc.OrderProperty.FirstName",
        "name": "Customer FirstName",
        "weight": 400,
        "meta": {
            "propertyAlias": "firstName",
            "group": "Uc.OrderPropertyGroup.Customer",
            "editorUiAlias": "Umb.PropertyEditorUi.TextBox",
            "labelUiAlias": "Umb.PropertyEditorUi.Label"
        }
    }
]

Each entry must have a type of ucOrderProperty along with a unique alias and name. An optional forEntityTypes key can also be defined to control whether the property is visible on the Cart editor, or the Order editor, or both. The forEntityTypes is an array and can accept either or both of uc:cart or uc:order values.

A meta entry provides configuration options for the property

Order Property Groups

Order properties can be defined as one of the following to control where the property is displayed.

Localization

When displaying your properties in the backoffice UI it is necessary to provide localizable labels. This is controlled by Umbraco's UI Localization feature.

Umbraco Commerce will automatically look for the following entries:

Here {alias} is the property alias of a property.