orderEditCommit
mutation

Choose a version:

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.

Anchor to section titled 'Arguments'

Arguments

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

Was this section helpful?

Anchor to section titled 'OrderEditCommitPayload returns'

OrderEditCommitPayload returns

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

Was this section helpful?

Code examples for MUTATION: orderEditCommit

Query Reference for MUTATION: orderEditCommit

"mutation orderEditCommit($id: ID!) {\n  orderEditCommit(id: $id) {\n    order {\n      # Order fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: orderEditCommit

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

Schema Reference for MUTATION: orderEditCommit

""

Display Examples for MUTATION: orderEditCommit

[]

orderEditCommitmutation

Arguments

OrderEditCommitPayload returns

orderEditCommit
mutation