Custom Data Fields

Many of Shipwell's objects—including Users, Customers, Locations, Carriers, Purchase Orders, Shipments, Loads, and Products —can create and attach custom fields. You can use this structure to connect key-value data, enriching the underlying objects.

Custom data is useful for storing additional, structured information on an object. As an example, you could save a custom customer reference and a corresponding unique identifier from your system on a Shipment object. You can also ingest custom data for use with search and analytics infrastructures. Custom data is searchable in the global search toolbar to quickly find the key-values. Custom data can also be used in the analytics infrastructure to create custom reports. Lastly, custom data fields will not be seen by your users unless you choose to show it to them.

Example custom_data for a mock object:

{
	"name": "My Shipment",
	"stops": [{
		"location": {
			"address": {
				"city": "Austin",
				"state_province": "TX",
				"country": "US"
			},
			"location_name": "Loc 1",
			"location_type": {
				"id": 1,
				"name": "Business (with dock or forklift)"
			}
		},
		"ordinal_index": 0,
		"carrier_specified_eta": {
			"running_window_start": "2020-02-13T14:49:40.902847Z"
		}
	}, {
		"location": {
			"address": {
				"city": "Bloomington",
				"state_province": "IN",
				"country": "US"
			},
			"location_name": "Loc 2"
		},
		"ordinal_index": 1
	}],
	"line_items": [{}],
	"est_trip_miles": 500,
	"final_trip_miles": 505,
	"weight_lbs": 1000,
	"description": "Acorns",
	"temperature_upper_limit": 100.5,
	"temperature_lower_limit": -32,
	"equipment_type": {
		"id": 2
	},
	"mode": {
		"id": 1
	},
	"service_level": {
		"id": 1
	},
	"accessorials": [{
		"id": 1
	}],
	"total_declared_value": "3.00",
	"custom_data": {
		"custom_field1": "custom_value1",
		"custom_field2": "custom_value2"
	}
}

Restrictions on custom data

You can specify up to 50 keys, with key names up to 40 characters long and values up to 500 characters long.

It is best practice not to store any sensitive information (personally identifiable information, sensitive customers) in the custom_data field. No field validation on the custom data is performed at this time.

Copyright © Shipwell 2020. All right reserved.