Skip to main content
POST
Add Order Timeline Note
V2 Preview — This endpoint is part of the V2 API preview. Breaking changes may occur.

Overview

Add a note to the timeline of a specific order. This creates a timestamped entry visible to both the vendor and the merchant.

Use Cases

  • Internal notes — Record shipping updates, special handling instructions, or delays
  • Communication trail — Leave a message for the merchant about the order
  • Status updates — Document progress on custom or made-to-order items

Headers

string
required
A valid vendor JWT. Requires orders:write scope.

Path Parameters

string
required
The _id of the order.

Request Body

string
required
The note text to add to the timeline.

Response

200

Error Responses

400
401
404

Example