JDBC Driver for ShipStation

Build 26.0.9770

UpdateShipmentInternalNotes

Updates the internal notes for a shipment.

Procedure Specific Information

Updates the internal notes for a shipment. ShipmentId, Note, and Mode are required. Use Mode='append' to add to existing notes or Mode='overwrite' to replace them entirely. The procedure is executed as below:
EXEC UpdateShipmentInternalNotes ShipmentId = 'se-28529731', Note = 'Handle with care', Mode = 'append'

EXEC UpdateShipmentInternalNotes ShipmentId = 'se-28529731', Note = 'Priority order', Mode = 'overwrite'

Input

Name Type Description
ShipmentId String The Id of the shipment.
Note String The internal notes to set on the shipment.
Mode String Controls how the note is applied.

The allowed values are append, overwrite.

Result Set Columns

Name Type Description
Status String The status of the operation.
InternalNotes String The resulting internal notes after the update.

Copyright (c) 2026 CData Software, Inc. - All rights reserved.
Build 26.0.9770