Delete Order Note By Id

This API helps you delete an order note.

DELETE/orders/{orderId}/notes/{noteId}

Use it in a workflow

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

Request

Path parameters

orderIdintegerrequired

ID of order for note to delete

noteIdintegerrequired

ID of note to delete

Query parameters

forcebooleanrequired

Required to be true, as resource does not support trashing.

Default true

Response

Returns 200 with an object. Read it in later steps with {{deleteOrderNoteById.response.data.<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
}

Need more? See the WooCommerce guide for connection setup and behaviour shared by every action.

Was this page helpful?