Orders > Orders > orderNotesModify
Commerce APIOrdersOrdersorderNotesModify
orderNotesModify
POST:order_notes.json

Description

Modify one or multiple order notes.

Permission bit: "order_notes.modify"

Topic: Orders

Arguments

data: [NoteModify!]!

Main argument for mutations.


ids: [String!]!

List of order note ids. See also: Unique Identifiers

Example: ["no_EQzGqWoY"]


order_id: String!

Unique order identifier. See also: Unique Identifiers

Example: "or_EQzGqWoY"


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


Data Argument Fields

text: String

Note text

Example: "Hello, my name is Bob."

Valid when: text is not empty

Valid when: text's length doesn't exceed 4096 characters


Result

[Note!]

Preview (typescript)

Loading module