Inventory > Transfers > transferNotesModify
Commerce APIInventoryTransferstransferNotesModify
transferNotesModify
POST:transfer_notes.json

Description

Modify one or multiple transfer notes.

Permission bit: "transfer_notes.modify"

Topic: Transfers

Arguments

data: [NoteModify!]!

Main argument for mutations.


ids: [String!]!

List of transfer note ids. See also: Unique Identifiers

Example: ["nt_EQzGqWoY"]


shop_id: String!

Unique shop identifier. See also: Unique Identifiers

Example: "sh_EQzGqWoY"


transfer_id: String!

Unique transfer identifier. See also: Unique Identifiers

Example: "tx_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