Skip to main content
POST
Create Shipment Note

Authorizations

Authorization
string
header
required

Your API key, sent in the Authorization header: Authorization: YOUR_API_KEY. A Bearer prefix is also accepted (Authorization: Bearer YOUR_API_KEY). Keys are created in the Upwell dashboard (Account → API keys) and are scoped to one organization.

Path Parameters

shipmentId
string
required

"shipmentId" is required (enter it either in parameters or request body)

Query Parameters

content
string

"content" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

content
string
required
shipmentId
string

Response

Responses for POST /api/rest/shipments/{shipmentId}/notes

createShipmentNote
Notes · object | null

columns and relationships of "notes"