Set Up User Definable Fields

Article • 5/21/2026 • 3 min read

You may define an unlimited number of User Definable fields of various formats. User Definable field names must be unique. Click the Modify button next to the User Definable field section you want to customize or the Add button to add User Definable fields. If you’re just starting out with Aptean Ship, no User Definable fields are defined by default - you’ll need to add them.

Field ID

This value is a unique identifier for the User Definable field. The Field ID cannot be left blank.

Modifying Field IDs Although you can change a Field ID that you originally created, keep in mind that changing the ID is the same as deleting the existing ID and replacing it with a new one. This means any field mappings, freight rules, or conditions, as well as the data in shipments, will be removed. If you change the Field ID and then want to recover any lost information, you can create a new User Definable field with the original ID.

Field Level

This value defines whether the User Definable field is at the Item, Package, Pallet, Order, or Shipment level.

Item level fields are available for both Inventory Items (Maintain > Inventory) and for line items in the shipment.

Field Name

The Field Name defines how the field label appears in Aptean Ship.

Field Type

This value defines the data type of the field. Use the Field Testing area to view how field data will display in Aptean Ship. Choices are:

Value Types

For String or Integer field types, you can select “Any Value” (with the value being limited by the field type), or you can add values.

To add a list of values, select “One of a list of values” in the Value Types field.

aptean-ship-udef-1

Define values by typing them in the Allowed Values field and clicking Add.

aptean-ship-udef-2

When values are specified, the User Definable field will display as a list of selectable values in Aptean Ship. The field will default to the first value in the list.

aptean-ship-udef-3