Back to Woocommerce

wc order_note

docs/wc-cli/wc-cli-commands/wc-order-note.md

11.0.0-dev1.5 KB
Original Source

Manage WooCommerce order note resources.

wc order_note list <order_id>

List all order notes.

  • --context - Scope under which the request is made; determines fields present in response.

  • --type - Limit result to customers or internal notes.

  • --fields - Limit response to specific fields. Defaults to all fields.

  • --field - Get the value of an individual field.

  • --format - Render response in a particular format.

    Default: table

    Options: table, json, csv, ids, yaml, count, headers, body, envelope

wc order_note create <order_id>

Create a new order note.

  • --note - Order note content. (Required)
  • --customer_note - If true, the note will be shown to customers and they will be notified. If false, the note will be for admin reference only.
  • --porcelain - Output just the id when the operation is successful.

wc order_note get <order_id> <id>

Get a single order note.

  • --context - Scope under which the request is made; determines fields present in response.

  • --fields - Limit response to specific fields. Defaults to all fields.

  • --field - Get the value of an individual field.

  • --format - Render response in a particular format.

    Default: table

    Options: table, json, csv, yaml, headers, body, envelope

wc order_note delete <order_id> <id>

Delete an existing order note.

  • --force - Required to be true, as resource does not support trashing.
  • --porcelain - Output just the id when the operation is successful.