Custom Data Fields provide an avenue for you as an organization to define additional data that is not present within Shipwell. Shipwell supports the following custom field types:
Reference Fields: A custom reference is a field that will be displayed in the ‘References’ card on shipments and quotes. Custom reference data can be entered and updated via the Shipwell web, API, and the order and shipment importers.
Customer Fields: A custom customer field is a field that will display on customer profile pages. They can be used to display any customer information about a customer. Custom customer data can be entered and updated via the Shipwell web and API.
Line Item Fields: A custom line item field will display on each item when creating a new quote, shipment, or order. Custom line item data can be entered and updated via the Shipwell web, API, and the order (v3) and shipment importers.
Charge Line Item Fields: A custom charge line item field will display on each charge line item when creating a new shipment. Custom charge line item data can be entered and updated via the Shipwell web, API, and the order and shipment importers.
Stop Fields: A custom stop field is a field that will be displayed under each pickup and delivery stop for orders, shipments, and quotes. Custom stop data can be entered and updated via the Shipwell web, API, and the order and shipment importers.
When creating a new custom line item enter the title of the field and input the data when creating orders, shipments, and quotes.
Manage Custom Fields
Users with the appropriate permission can manage custom data by selecting ‘Manage’ → ‘Company’ → ‘Custom Data’. Your current custom data for each of the five custom data field types are displayed in their own component. Any existing custom data will be displayed.
For example, to add custom reference data, select ‘+ Add Reference Field’ and a modal will be displayed.
Enter the name of the data field in ‘Reference Field’. Choose if the ‘Field Type’ is a ‘Text Field’ or ‘Single Select List’. In this example we are creating an ‘Installer Code’ that has three options and we select ‘Single Select List’ in which the user will have a dropdown of options, namely ‘Neighborhood Install', ‘Northside Quick Installer’, and You Make We Install'. We enter the three options separated by a semicolon ‘;'. We don’t want the carrier to view or edit this data, so we leave ‘Carrier view’ and ‘Carrier edit’ unchecked. We have checked ‘Required’ because we want to require our customers to fill out this data. It is important to note that the ‘Required’ option limits users in Shipwell’s web interface to save or update an order, shipment, or quote without this field entered but it will not prevent this same data restriction via the API.
Once you press ‘Save’ then this new reference field will exist including on all prior orders, shipments, and quotes but the data is blank on all orders, shipments, and quotes until the information and saves it.
Custom Fields Configurations: Different custom field types have different configuration options. Here are what each configuration provides:
Field Type: Identifies the type of data that can be supported in a field. The current options include ‘Text’ which is a standard alphanumeric text field. The other option is ‘Single Select List’ which is a list of alphanumeric text fields to make a single choice. The ‘Single Select List’ provides a list of list items separated by a semicolon ‘;'. The 'Single Select List’ option is only available for custom Reference and Charge Line Item fields.
Required: Identifies if the field is required when a user creates or updates the item (e.g. shipment) that the required field exists. This is only available for custom reference, line item, and stop fields.
Carrier View: Identifies if the carrier can view the field. By default custom data fields are not viewable by parties other than the party creating the custom data fields. This is only available for custom Reference field.
Carrier Edit: Identifies if the carrier can edit the field. This is only available for custom Reference field.
Visible: Identifies if the item is visible in the Shipwell web interface even for customer users. The purpose when not visible is providing a place for an API to store and access data related to an existing item. This is only available for custom Charge Line Item fields
Disclaimers:
Do not name ‘Custom Data’ the same as other Shipwell data fields. Doing this may cause user confusion but also if leveraging products like our importer will cause items to not work as expected.
If you ‘Delete’ a custom data field then this data is gone. Further, if you have an integration that is sending in data within a custom data field then this will break the API integration if field is renamed or deleted without updating the API integration.
Note that custom data fields that are selected as viewable/editable by the carrier will be viewable/editable from the Shipment detail page. These fields are not viewable via the carrier's Dashboard.
Modify and View Custom Data
Once custom fields exist then users can modify custom data where it exists within Shipwell assuming they have the appropriate permissions (e.g. user’s must have ‘Shipments’ or ‘My Shipments’ ‘Update’ access to update shipment data). Here are screenshots of common custom data creation and update within new shipment and shipment details' pages. Many of the custom data fields are also available for orders and quotes also.
Custom Reference Fields - New Shipment Page
Custom Reference Fields - Shipment Details Pag
Custom Customer Fields - Shipment Details Page
Custom Line Items Fields - Shipment Details Page
Custom Charge Line Item Field - Shipment Details Page
Custom Stop Field - New Shipment Page
Custom Stop Field - Shipment Details Page