order.note.add

Append a merchant note to an order's timeline.

• scope: orders:write
• storefront-visible (bumps the catalog generation): no
• destructive: no

Payload

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "type": "object",
  "properties": {
    "orderId": {
      "type": "string",
      "pattern": "^ord_[a-zA-Z0-9]{1,32}$"
    },
    "noteId": {
      "type": "string",
      "pattern": "^ont_[a-zA-Z0-9]{1,32}$"
    },
    "body": {
      "type": "string",
      "minLength": 1,
      "maxLength": 2000
    }
  },
  "required": [
    "orderId",
    "noteId",
    "body"
  ],
  "additionalProperties": false
}