Skip to main content
POST
/
orders
/
{orderId}
/
timeline
Add Order Timeline Note
curl --request POST \
  --url https://staging-api.puppetvendors.com/orders/{orderId}/timeline \
  --header 'Content-Type: application/json' \
  --header 'x-access-token: <api-key>' \
  --data '
{
  "message": "<string>"
}
'
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

​
x-access-token
string
required
A valid vendor JWT. Requires orders:write scope.

​
Path Parameters

​
orderId
string
required
The _id of the order.

​
Request Body

​
message
string
required
The note text to add to the timeline.

​
Response

200
{
  "success": true,
  "data": {
    "_id": "664a1b2c3d4e5f6a7b8c9d10",
    "message": "Customer requested gift wrapping — added to package",
    "type": "note",
    "createdBy": "vendor@example.com",
    "createdAt": "2026-05-17T09:15:00Z"
  }
}

​
Error Responses

400
{ "success": false, "error": { "message": "\"message\" is required", "code": "VALIDATION_ERROR" } }
401
{ "success": false, "error": { "message": "Invalid or expired token" } }
404
{ "success": false, "error": { "message": "Order not found", "code": "NOT_FOUND" } }

​
Example

curl -X POST "https://staging-api.puppetvendors.com/orders/507f1f77bcf86cd799439011/timeline" \
  -H "Content-Type: application/json" \
  -H "x-access-token: YOUR_VENDOR_JWT" \
  -d '{
    "message": "Customer requested gift wrapping — added to package"
  }'