orderEditCommit - admin-graphql - MUTATION

Version: unstable

Description:

Applies and saves staged changes to an order. Mutations are operating on `OrderEdit`. All order edits start with `orderEditBegin`, have any number of `orderEdit`* mutations made, and end with `orderEditCommit`.

Access Scopes

`write_order_edits` access scope.

Arguments

  • id: ID! - The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder) or the order edit session that will have its changes applied to the order.
  • notifyCustomer: Boolean - Whether to notify the customer or not.
  • staffNote: String - Note for staff members.

Returns

  • order: Order The order with changes applied.
  • successMessages: String Messages to display to the user after the staged changes are commmitted.
  • userErrors: UserError! The list of errors that occurred from executing the mutation.

Examples