Create Order Note

This API helps you to create a new order note.

POST/orders/{orderId}/notes

Use it in a workflow

Add a step and choose the WooCommerce connector.
Pick the Create Order Note action (under Orders).
Fill in the fields below, then reference the result from later steps as {{createOrderNote.response.data}}.

Request

Path parameters

orderIdintegerrequired

ID of order for note to create

Request body

Enter the body as JSON in the step's Body field.

idinteger

Unique identifier for the resource. read-only

authorstring

Note author. Displays as "system" for WooCommerce-generated notes, otherwise the author name. read-only

date_createdstring (date-time)

The date the note was created, in the site's timezone. read-only

date_created_gmtstring (date-time)

The date the note was created, as GMT. read-only

notestring

Note content. mandatory

customer_noteboolean

If true, the note will be visible to customers. mandatory

json

{
  "id": 0,
  "author": "string",
  "date_created": "2025-01-01T00:00:00Z",
  "date_created_gmt": "2025-01-01T00:00:00Z",
  "note": "string",
  "customer_note": false
}

Response

Returns 201 with an object. Read it in later steps with {{createOrderNote.response.data.<field>}}.