Get WooCommerceOrderNote

Get-WooCommerceOrderNote

SYNOPSIS

Retrieve WooCommerce order notes

SYNTAX

Get-WooCommerceOrderNote [-id] <String> [[-NoteId] <String>] 
 [<CommonParameters>]

DESCRIPTION

This API lets you retrieve and view a list of all notes added to an order, or retrieve a single order note. Order notes are private internal notes or customer messages attached to an order.

EXAMPLES

EXAMPLE 1

Get-WooCommerceOrderNote -id 123

Retrieves all notes associated with order ID 123.

EXAMPLE 2

Get-WooCommerceOrderNote -OrderId 123 -NoteId 456

Retrieves the specific note with ID 456 from order 123. Note that 'OrderId' is an alias for the -id parameter.

EXAMPLE 3

Get-WooCommerceOrderNote -id 123 | Select-Object -Property author, note

Retrieves all notes for order 123 and displays the author and note content for each.

PARAMETERS

-id

Unique identifier for the order. This parameter is mandatory and specifies which order's notes to retrieve. Accepts 'OrderId' as an alias.

Type: String
Parameter Sets: (All)
Aliases: OrderId

Required: True
Position: 2
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

-NoteId

Unique identifier for a specific order note. If provided, only that particular note will be retrieved. If omitted, all notes for the order are retrieved.

Type: String
Parameter Sets: (All)
Aliases:

Required: False
Position: 3
Default value: None
Accept pipeline input: False
Accept wildcard characters: False

CommonParameters

This cmdlet supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable. For more information, see about_CommonParameters.

INPUTS

OUTPUTS

System.Management.Automation.PSObject[]

NOTES

Requires valid WooCommerce credentials set via Set-WooCommerceCredential. Order notes can include customer-facing notes or internal-only notes depending on the note type.

RELATED LINKS

https://woocommerce.github.io/woocommerce-rest-api-docs/#list-all-order-notes