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>"
}
'
import requests

url = "https://staging-api.puppetvendors.com/orders/{orderId}/timeline"

payload = { "message": "<string>" }
headers = {
    "x-access-token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {'x-access-token': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({message: '<string>'})
};

fetch('https://staging-api.puppetvendors.com/orders/{orderId}/timeline', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://staging-api.puppetvendors.com/orders/{orderId}/timeline",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'message' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-access-token: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://staging-api.puppetvendors.com/orders/{orderId}/timeline"

	payload := strings.NewReader("{\n  \"message\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("x-access-token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://staging-api.puppetvendors.com/orders/{orderId}/timeline")
  .header("x-access-token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"message\": \"<string>\"\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://staging-api.puppetvendors.com/orders/{orderId}/timeline")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["x-access-token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"message\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body
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"
  }'