younifyd
Menu

List All Order Notes

This API helps you to view all notes for an order.

GET/orders/{orderId}/notes

Use it in a workflow

  1. Add a step and choose the WooCommerce connector.
  2. Pick the List All Order Notes action (under Orders).
  3. Fill in the fields below, then reference the result from later steps as {{listAllOrderNotes.response.data}}.

Request

Path parameters

orderIdintegerrequired

ID of order for notes to return

Query parameters

contextstring

Scope under which the request is made; determines fields present in response. Options: view and edit. Default is view.

One ofvieweditDefault "view"

pageinteger

Current page of the collection. Default is 1.

Default 1

per_pageinteger

Maximum number of items to be returned in result set. Default is 10.

Default 10

Response

Returns 200 with a array<object>. Read it in later steps with {{listAllOrderNotes.response.data.<field>}}.

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