Add and manage custom order fields

Custom order fields let you add extra information to orders when the standard OptimoRoute fields do not cover what they need. This article explains how to create and use custom order fields.

Who can use this feature
	All plans
	Users that have administrator privileges
	All regions

What are custom order fields?

Custom order fields let you add information to orders that is not included in the standard OptimoRoute order fields. 

You can customize these fields to store and share information that is useful for planning, dispatching, or completing an order.

Creating custom fields

To add custom fields to an account:

1. Go to Administration→Settings in the top right menu
2. Choose “Orders” in the left menu
3. Choose “Custom fields” from the submenu
4. Click "Add"
5. Input the name of the field
6. Choose the custom field type 
7. Choose the formatting for the field type 
8. Add an optional description of the field 
9. Click "Submit"

Your browser will refresh once finished in order to apply these changes. 

Custom field types

There are three types of custom fields: text, number, and single-select. 

Updating custom field values on an order

You can update custom order field values in two ways:

• Import them from a spreadsheet.
• Edit the order in OptimoRoute.

Importing custom field values

Before you can import custom order field values, you must first create the custom fields in OptimoRoute.

When you import orders, the custom fields will appear as mapping options.

To import custom field values:

1. Add a column to your spreadsheet for each custom field you want to update.
2. Enter the values in the matching column.
3. During import, map the column to the custom field under the “Custom” section.
4. Complete the import.

Editing custom fields on orders

To change the custom fields of a specific order:

1. Go to "Plan and Optimize"
2. Double-click on the order you want to edit
3. Select "Details" from the left menu in the window
4. Add or edit the values of the custom fields
5. Click "Save"

Deleting and disabling custom fields

Disabling and deleting a custom field have different effects.

• Disable a custom field when you want to hide it without losing its data. You can enable it again later.
• Delete a custom field when you no longer need it. Deleting the field permanently removes it and all its data from orders.

Disabling custom fields

Disabling a custom field hides it from orders. Existing data is not deleted, and you can enable the field again later.

To disable a custom field:

1. Go to Administration→Settings in the top right menu
2. Choose “Orders” in the left menu
3. Choose “Custom fields” from the submenu
4. Toggle the switch next to the custom field you want to disable to "off"

Deleting custom fields

Deleting custom fields will permanently remove the custom field and the data from the orders. 

To delete custom fields:

1. Go to Administration→Settings in the top right menu
2. Choose “Orders” in the left menu
3. Choose “Custom fields” from the submenu
4. Choose the custom field you want to delete
5. Click "Delete"
6. Confirm that you want to delete the field. 

Managing custom fields across an organization

Admins who manage multiple accounts in an organization can share custom field groups across accounts.

This helps you use the same set of custom fields in multiple accounts without creating them again.

To share a custom field group:

1. Go to “Administration → Settings.”
2. Select “Orders” from the menu on the left.
3. Select “Custom fields.”
4. Open the “Account Access” tab.
5. Select the custom field group you want to share.
6. Select the accounts that should have access.

The custom field group and the fields inside it will be available in the selected accounts.

To remove access, deselect the accounts.

Legacy and Default groups cannot be shared across accounts.

Legacy custom fields

Legacy custom fields are the five text-only custom fields that were available in previous versions of OptimoRoute.

These fields are still supported, but newer custom fields offer more options. New custom fields can:

• Use their own keys in the API.
• Use different field types, including text, number, and single-select.
• Support longer text values.

If you already use legacy custom fields, you can continue using them. For new custom fields, use the newer custom field options. If your account does not have the new fields activated, please reach out to support. 

Creating legacy custom fields

These instructions are for anyone still using the legacy custom fields interface. 

To add custom fields to an account:

1. Go to Administration→Settings in the top right menu
2. Choose “Orders” in the left menu
3. Choose “Custom fields” from the submenu
4. Add custom field names
5. Check box to activate the field for use in your account
6. Click “Save” in the top right corner

Deleting legacy custom fields

To delete custom fields:

1. Go to Administration→Settings in the top right menu
2. Choose “Orders” in the left menu
3. Choose “Custom fields” from the submenu
4. Go to the custom field you want to delete
5. Erase the name

Data from deleted custom fields remain in the past/history of the account and past orders.