Skip to content

Custom Fields

The Custom Fields section on shipment records captures logistics-specific data beyond standard fields, with definitions managed in Site Settings › Shipping › Custom Fields. Configured fields appear on each shipment and in Search › Shipping for filters and columns. You can group fields into sections, and values stay synchronised wherever shipments are shown or searched.

Quick Check - Before You Start
  • Ensure custom fields are created and enabled in Site Settings > Shipping > Custom Fields
  • Open a shipment you can edit on the Details tab so you can save values after updating

Using Custom Fields on Shipments

Viewing the Custom Fields Section

The Custom Fields section appears on each shipment record, typically within the Details tab. Fields are displayed according to the section and configuration defined in Site Settings. Only fields that have been created and enabled in Site Settings › Shipping › Custom Fields will appear on shipment records.

Entering and Editing Values

  1. Open a shipment record and navigate to the Details tab.
  2. Locate the Custom Fields section.
  3. Enter or update values in the displayed fields according to the field type.
  4. Save your changes to persist the data.

Understanding Field Types

Custom fields support a range of input types. The behaviour of each field depends on how it was configured in Site Settings:

Field Type Description Example
Text Free-form text entry for short or long responses. Special handling instructions, Reference numbers
Date Date picker for time-sensitive data such as expected arrival or clearance dates. ETA, Customs clearance date
Dropdown Single selection from a predefined list. Ensures consistent values for reporting and filtering. Priority, Carrier
Multiselect Dropdown Multiple selections from a predefined list. Useful for tags or multi-value attributes. Documentation types, Customs codes

Configuration in Site Settings

Field labels, types, dropdown options, and section groupings are configured in Site Settings › Shipping › Custom Fields. Users with the appropriate permissions can add, edit, or remove field definitions there; changes are reflected on all shipment records.

Where Custom Fields Are Used

Custom fields entered on shipment records are available across the system for searching, filtering, and reporting. The following areas consume custom field data:

Area Description Documentation
Shipping › Details Custom fields appear as part of the shipment Details tab. Users can view and edit values directly on each shipment to capture logistics-specific information. Shipping › Details
Search › Shipping Custom fields are available as filter criteria and can be displayed as columns in the Search › Shipping view. Changes made in Site Settings are synchronised automatically. Search › Manage Data

Configuration Required

Custom fields must be created and managed from Site Settings › Shipping › Custom Fields. Administrators define the field label, type, and available options (where applicable). Once saved, definitions are synchronised across all shipment records and the Search view.

Helpful Tips

  • Use section names to group related fields (e.g. Logistics Notes, Customs Information) for clearer organisation on the form.
  • Ensure dropdown and multiselect options in Site Settings align with your business terminology to improve data consistency.
  • Document the purpose of each custom field to help team members understand when and how to use it.
  • Regularly update custom field values to maintain accurate reporting and search results.
  • Use consistent formats for text fields (e.g. reference number patterns) to support reliable filtering in Search.
  • Review custom field usage in Search to identify fields that could be standardised or optimised.

Troubleshooting

Why are custom fields not appearing on my shipment?

Custom fields must be created and enabled in Site Settings > Shipping > Custom Fields before they appear on shipment records.

Steps to resolve:

  1. Navigate to Site Settings > Shipping > Custom Fields
  2. Verify the fields are created with the correct type (Text, Dropdown, etc.)
  3. Ensure the fields are enabled and not disabled
Why are dropdown options missing from a custom field?

Dropdown and multiselect options are configured in Site Settings. If options are missing, they may not have been added or may have been disabled.

Steps to resolve:

  1. Open Site Settings > Shipping > Custom Fields
  2. Edit the relevant dropdown field and review its options
  3. Add any missing values and ensure they are active