Skip to main content
POST
Add an order note

Authorizations

Authorization
string
header
required

API token created in the dashboard under Integrations > API. Tokens start with gci_.

Path Parameters

orderId
string
required

Body

application/json
content
string
required
Maximum string length: 1000
Pattern: \S
Example:

"Delivered by hand after a support ticket."

Response

The note.

Internal note on an order. Only the seller sees notes.

author
object

Omitted on notes written before authorship was recorded.

content
string
Example:

"Delivered by hand after a support ticket."

createdAt
string<date-time>
Example:

"2026-09-25T14:10:00.000Z"

id
integer<int64>
Example:

812