Update Shipment By Reference

PATCH /api/v1/shipments/reference/:shipment_reference

Update a shipment's properties including tracking information, custom fields, tags, and sharing settings.

Errors

Code	`TRACKING_NUMBER_REQUIRED`
Message	The tracking_number field cannot be empty.
Suggested Fix	Please provide a valid tracking number for this shipment.
Target	`tracking_number`

Code	`CARRIER_SCAC_REQUIRED`
Message	Carrier SCAC is required for bill_of_lading.
Suggested Fix	Please provide a valid carrier SCAC code.
Target	`carrier_scac`

Code	`TRACKING_TYPE_REQUIRED`
Message	Tracking type is required for this shipment.
Suggested Fix	Please provide a valid tracking type for this shipment.
Target	`tracking_type`

Code	`CARRIER_INVALID_FORMAT`
Message	The carrier 'invalid' has an invalid format. Expected a string.
Suggested Fix	A SCAC must be exactly 4 alphanumeric characters (e.g., 'MSCU'). Use 'AUTO' for automatic carrier detection.
Target	`carrier`

Code	`CARRIER_NOT_SUPPORTED`
Message	The carrier with SCAC 'INVALID' is not currently supported.
Suggested Fix	Please check our list of supported carriers. If you'd like us to support this carrier, please contact our team.
Target	`carrier_scac`

Code	`TRACKING_NUMBER_INVALID`
Message	The tracking number 'invalid_number' is invalid.
Suggested Fix	Please provide a valid tracking number for this shipment.
Target	`tracking_number`

Code	`NAME_TOO_LONG`
Message	The name field for this shipment is too long. The maximum allowed length is 255 characters.
Suggested Fix	Please shorten the shipment name to 255 characters or fewer.
Target	`name`

Code	`CUSTOM_FIELDS_UNKNOWN`
Message	The following custom fields are not defined in your workspace: 'unknown_field'.
Suggested Fix	Please ensure all custom field names match the slugs defined in your workspace settings.
Target	`custom_fields`

Code	`CUSTOM_FIELD_INVALID_TYPE`
Message	The value for the custom field 'field_slug' has the wrong type. Expected a 'string'
Suggested Fix	Please ensure the value matches the data type defined for this custom field (e.g., Number, Date, Text).
Target	`custom_fields`

Code	`CUSTOM_FIELD_TOO_LONG`
Message	The value for the custom field 'field_slug' is too long.
Suggested Fix	Please shorten the value for the custom field '{field_slug}'.
Target	`custom_fields`

Code	`INVALID_EMAIL`
Message	The email 'invalid@email' is invalid.
Suggested Fix	Please provide a valid email address.
Target	`assignees`

Code	`INVALID_EMAIL`
Message	The email '[email protected]' is not a member of the workspace.
Suggested Fix	Please provide a valid email address.
Target	`assignees`

Code	`INVALID_EMAIL`
Message	The email '[email protected]' is already a non-viewer member of system.
Suggested Fix	Please provide a valid email address.
Target	`viewers`

/api/v1/shipments/reference/:shipment_reference