latestOpenAPI 3.1.0MIT2026-08-221643491.4 MB

d3d8c21cd227

account6

addresses1

batches10

carriers7

checkout_rates9

connections4

documents9

downloads1

freight9

fulfillments2

inventory12

labels13

mailing3

manifests4

package_pickups4

package_types5

products5

purchase_orders9

rate_shoppers2

rates4

service_points2

shipments12

suppliers4

tags5

tokens1

totes6

tracking3

users1

warehouses6

webhooks5

shipments

Update internal notes for a shipment

<aside class="access" aria-label="Endpoint access"> <table class="access__table"> <thead> <tr> <th class="access__table-header">Products</th> <th class="access__table-header">Plans</th> </tr> </thead> <tbody> <tr> <td class="access__table-cell access__product"> <img class="access__logo" src="/static/logos/shipstation-api-logo.svg" alt="ShipStation API Logo" loading="lazy" decoding="async"/> <div class="access__sub">Formerly ShipEngine</div> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-free.md" class="access__plan">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Advanced</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-api-advanced-enterprise.md" class="access__plan">Enterprise</a> </td> </tr> <tr> <td class="access__table-cell"> <img class="access__logo" src="/static/logos/shipstation-logo.svg" alt="ShipStation Logo" loading="lazy" decoding="async"/> </td> <td class="access__table-cell access__plans"> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Free</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-free-starter.md" class="access__plan access__plan--off">Starter</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Standard</a> <a href="/apis/@shipstation-v2/docs/getting-started/plans/shipstation-standard-premium.md" class="access__plan">Premium</a> </td> </tr> </tbody> </table> <footer class="access__footer"> <a class="access__help" href="/apis/@shipstation-v2/docs/getting-started/products-and-plans.md"> Learn about products and plans <img src="/static/icons/external-link.svg" alt="External Link Icon" style="width: 16px;" loading="lazy" decoding="async"/> </a> </footer> </aside>

Update the internal notes on a shipment. You can either overwrite the existing notes entirely or append new text to the current notes.

Mode	note value	Result
overwrite	"new note"	Replaces existing notes
overwrite	"" or " "	Clears the note
append	"new note"	Appends text to existing notes

post/v2/shipments/{shipment_id}/internal_notes

Request body

notestring required

The note text to set or append.

mode'append' | 'overwrite' required

Controls how the note is applied.

append adds the text to the end of any existing notes.
overwrite replaces the existing notes entirely (use an empty string to clear).

Example request

{
  "note": "Customer called — prefers delivery after 5 PM",
  "mode": "append"
}

Response

The internal notes were updated successfully.

internal_notesstring

The resulting internal notes after the update.

Example response

{
  "internal_notes": "Original note\nCustomer called — prefers delivery after 5 PM"
}