WooCommerce · JSON Structure

Woocommerce Rest Api Order Note Input Structure

Input for creating an order note.

Type: object Properties: 3 Required: 1
eCommerceOpen SourceOrdersProductsWordPress

OrderNoteInput is a JSON Structure definition published by WooCommerce, describing 3 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

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-input-structure.json",
  "name": "OrderNoteInput",
  "description": "Input for creating an order note.",
  "type": "object",
  "properties": {
    "note": {
      "type": "string",
      "description": "Note content.",
      "example": "string-value"
    },
    "customer_note": {
      "type": "boolean",
      "description": "Whether to display this note to the customer.",
      "default": false,
      "example": true
    },
    "added_by_user": {
      "type": "boolean",
      "description": "Whether to mark note as added by a user.",
      "default": false,
      "example": true
    }
  },
  "required": [
    "note"
  ]
}