Getting Started
Interface Basics
Printers and Scales
Shipping
Order Processing
Order Allocation
Order Processing Loop
Packing Solutions
Backorders
Ready to Ship
"Unable to Process" Order status
Address Validation and Classification
Packaging Features
Orders
Custom Fields for Orders
Reference Numbers
Other Shipping Options
Packing Instructions
Shipping Accounts
External Shipping Methods
Third Party Billing
Manifest Couriers
Packing Slip Design
Service Levels and Target Ship Dates
Outbound SSCC Barcodes
International Shipping
Tracking Numbers for Offline Shipments
Serial Number Tracking
Receiving
Catalog
Bill of Materials/Work Orders
Bill of Materials
Bill of Materials - Quantity-types
Work Orders
Import Bill of Materials
Virtual Inventory
Regulations
Products
Product Attributes
Lots/Expirations Tracking
Product Velocity
Import Products
Operations
Warehouse
Picking Classes
Picking Batches
Bulk Fulfill Orders
Put-Aways
Manifests (Loading)
License Plates
Time Tracking for Administrators
Time Tracking for Staff
Relocations
Import Locations, Lots and Inventory
Rating
Rate Shopping
Rating Maps
Rate Groups and Plans
Fee Schedules and Adjustments
Virtual Shipping Methods
System
Configuration
Merchants and Brands
Warehouses
User Management
User Roles
User Groups
Login via Badge
Protected Customer Data
Enumerations
Technical Contact
Integrations
Shopify
Integrations Overview
Amazon Merchant Fulfillment
Amazon Selling Partner
CartRover
EasyPost
eHub
External Shipping Method API
Freight Club
Magento 1 / OpenMage
Merchant API Users and Roles
SPS Commerce
ShipStream Plugin Fostering Program
Webhooks
WooCommerce
UPS
Scripting
Scripting Basics
Before Create Order Scripts
Preprocess Packing Solution Scripts
Ready to Ship Time Scripts
Picking Class Shipment Matching Scripts
FAQ
How-To: FedEx Production Key Certification
How-To: Brand-Specific Shipping Account
Pattern and Replacement RegEx
ShipStream's Subprocessors
ISO Alpha-2 Country Codes
Printer Troubleshooting
ShipStream Flow
Release Notes
ShipStream Releases
Version 2025.0
Revamped Delivery Processing
Version 2024.6
Version 2024.5
Version 2024.4
Version 2024.3
Version 2024.2
Version 2024.1
Version 2024.0
Version 2023.2
Version 2023.1
Version 2023.0
Package Tracking API Migration Guide (2023.0)
Version 2022.2
Version 2022.1
Version 2022.0
Version 2021.6
Version 2021.5
Version 2021.4
Version 2021.3
Version 2021.2
Version 2021.1
Version 2021.0
Version 2020.2
Version 2020.1
Version 2020.0
Version 2019.9
Version 2019.8.1
Version 2019.8
Version 2019.7
Version 2019.6
Version 2019.5
Device Hub Client Updates
Version 2025.1
Table of Contents
- All Categories
- Shipping
- Custom Fields for Orders
Custom Fields for Orders
Custom Fields can be added to an order as a versatile way to organize and control your order information. Users can use this field for sorting/filtering in the grids, exporting and reports, or manipulating with the API or Scripts.
Here is an example of four custom fields added to an order for setting its Original Purchase Date, Claim Reason, Main Item SKU, or Order Details, all of which are not included in the default ShipStream Create Order form.

These fields can also be enabled for the Order Grid for sorting as seen in the following example:

Create Order Custom Fields
- Navigate to System > Order Custom Fields.
- Click Add Order Custom Field in the top right.
- Fill out the Order Custom Field Information form. An explanation of each field is located here.
- Click Save.
This field will now appear in the Additional Information section when creating or editing orders. The following example shows a custom field labeled Claim Reason with a Selectable value.

Order Custom Fields Form

Name
A short, descriptive display name.
Code
The internal code used for referencing with Order Imports, API requests, or Script operations.
Active
Set this value to Yes to immediately enable its use, or no to effectively disable it.
Allow for Merchants
Select one or more merchants to limit visibility of this Order Custom Field to only those selected.
Input Type
Select the input field type from any of these options: Text, Multiline Text, Number, Currency, Select, Multiselect, Yes/No (Boolean), Date, Admin User, Client User, Email, URL.
Values Required
Determine whether or not this field will be required before submitting the order.
Internal Note
A comment or hint that appears below the custom field on the form page, and is only visible to admin account users.
Client Note
A comment or hint that appears below the custom field on the form page, and is only visible to client account users.
Admin Permissions
Sets the allowed permissions for admin account users. Options are:
- Unrestricted - Field will be visible and editable for all admin users
- Restricted - Field is only editable if the Role Resource "Restricted Custom Fields" has the "Edit" permission checked for the admin user.
- Read-Only - Field is visible but can not be edited.
- Hidden - Field is not visible.
Display in Admin Form
Choose whether to show the field in the order form for admin users.
Display in Admin Grid
Choose whether to show the custom field as a column in the order grid for admin users.
Client Permissions
Sets the allowed permissions for client account users. Options are:
- Unrestricted - Field will be visible and editable for all admin users
- Restricted - Field is only editable if the Role Resource "Restricted Custom Fields" has the "Edit" permission checked for the admin user.
- Read-Only - Field is visible but can not be edited.
- Hidden - Field is not visible.
Display in Client Form
Choose whether to show the field in the order form for client users.
Display in Client Grid
Choose whether to show the custom field as a column in the order grid for admin users.
Display Sort Order
Choose the order in which this custom field will appear in the form.
Enumerated Order Custom Field Options
Order Custom Fields using Select or Multiselect will store references to each value option using a unique id to allow option labels to be updated at any time without breaking the data references. These unique ids may be found in System > Enumerations > Order > Order Custom Field Options.
Each option has a "code" which is the Order Custom Field' "Code" value joined with the internal option ID so that options from different custom fields can be easily distinguished from one another.
