orderEditCommit

mutation

Requires write_order_edits access scope.

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.

Arguments

Anchor to idid • ID!required: The ID of the calculated order that will have its changes applied to the order.
Anchor to notifyCustomernotifyCustomer • Boolean: Whether to notify the customer or not.
Anchor to staffNotestaffNote • String: Note for staff members.

Was this section helpful?

Anchor to OrderEditCommitPayload returnsOrderEditCommitPayload returns

Anchor to orderorder • Order: The order with changes applied.
Anchor to userErrorsuserErrors • [UserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Mutation Reference

1mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean, $staffNote: String) {
2  orderEditCommit(id: $id, notifyCustomer: $notifyCustomer, staffNote: $staffNote) {
3    order {
4      # Order fields
5    }
6    userErrors {
7      field
8      message
9    }
10  }
11}

Input

1{
2  "id": "gid://shopify/<objectName>/10079785100",
3  "notifyCustomer": true,
4  "staffNote": "<your-staffNote>"
5}

{
  "id": "gid://shopify/<objectName>/10079785100",
  "notifyCustomer": true,
  "staffNote": "<your-staffNote>"
}