Order Properties
- Perry Tew
- Jonathan Tew
About
Order Properties have existing in the UltraCart system for a decade or more. Recently (March 2025) UltraCart brought these properties into several screens allowing merchants to control and edit them easily.
Screens that Interact with Order Properties
Order Properties Configuration: Home → Configuration → Order Management → Order Properties
Order Editing Billing Screen: Order Review → Click on Order → Edit → Billing
Manual Order Entry: Home → Order Management → Manually Add Order
The UltraCart REST API and BigQuery interface have long supported Order Properties, however, this screen does not affect those interfaces. The BigQuery is read-only, and the REST API is not constrains against any settings created on this screen. This screen was created to control and guide customer service reps while adding or editing orders.
Configuring the Order Properties Set
Navigation
Main Menu → Configuration → (middle menu) Order Management → Order Properties
Adding The Values Sets
You may add order properties to the Billing Editor or BEOE (Backend Order Entry) screens by adding them here. Here is a detailed list of the fields and options for an order property.
Name: Can be letters, numbers, underscores, or dashes. 50 characters max.
Field Type: Text box or Select Box
Display on Internal Order View: If checked, these properties will display on the Order Review screen. If unchecked, they will only be visible on the editor screens, rest api, and BigQuery.
Include Empty Option: Applicable only to a Select Box property. If true, the select box will contain a blank value as its first option. This will allow a service rep to leave it empty if desired. A Text Field property has this feature by default. There is no way to make a text field mandatory.
Keep When Cloning: By default, all configured order properties are cleared when an order is cloned. Non-configured order properties are retained. If you wish for one of the configured order properties on this screen to retain its value from the original order to the clone order, check
Keep When Cloning.Value List: Applicable only to a Select Box property. The option values for the select box.
After saving properties, the configuration screen will contain buttons for deleting properties or values.
Editing the Order Properties in the Order Editor
When editing the order properties of an existing order, navigate to the ‘Billing’ tab in the order editor:
In the ‘Billing’ tab of the order editor scroll down to the Order Properties at the bottom of the screen:
You may then select or provide values. Click Save to persist your changes.
Editing the Order Properties when Adding an order manually
On the Backend Order Entry screen, the Order Properties are located below Custom Fields and above the Miscellaneous section. They will be hidden if none are configured.
Location of properties in BigQuery
In BigQuery, Order properties are a repeated record on the uc_orders table. The fields available on the property object are:
name - name of the property
value - value of the property
display - true if this property is displayed
expiration_dts - expiration date of the property (typically for system collected properties)
created_by - the user that set this property
created_dts - the date/time that the user set this property
