WooCommerce · JSON Structure

Woocommerce Rest Api Order Note Structure

A note attached to an order.

Type: object Properties: 5
eCommerceOpen SourceOrdersProductsWordPress

OrderNote is a JSON Structure definition published by WooCommerce, describing 5 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id date_created note customer_note added_by_user

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑ 
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/woocommerce/refs/heads/main/json-structure/woocommerce-rest-api-order-note-structure.json",
  "name": "OrderNote",
  "description": "A note attached to an order.",
  "type": "object",
  "properties": {
    "id": {
      "type": "int32",
      "description": "Note unique identifier.",
      "example": 1
    },
    "date_created": {
      "type": "datetime",
      "description": "Date the note was created.",
      "example": "2026-05-03T14:30:00Z"
    },
    "note": {
      "type": "string",
      "description": "Note text content.",
      "example": "string-value"
    },
    "customer_note": {
      "type": "boolean",
      "description": "Whether this note is visible to the customer.",
      "example": true
    },
    "added_by_user": {
      "type": "boolean",
      "description": "Whether the note was added by a store user (vs system).",
      "example": true
    }
  }
}