Choose a version:

orderEditCommit

mutation

Requires Requires write_order_edits access scope.

Applies staged changes from an order editing session to the original order. This finalizes all modifications made during the edit session, including changes to line items, quantities, discounts, and shipping lines.

Order editing follows a three-step workflow: start with orderEditBegin to create an editing session, apply changes using various orderEdit mutations, and then save the changes with the orderEditCommit mutation. The mutation can optionally notify the customer of changes and add staff notes for internal tracking.

You can only edit unfulfilled line items. If an edit changes the total order value, then the customer might need to pay a balance or receive a refund.

If the order has an existing write-off, committing an edit which reduces the order total can reduce the written-off amount automatically when the order total before write-offs falls below the remaining written-off amount.

Learn more about editing existing orders.

Anchor to Arguments

Arguments

Anchor to idid •ID! required: The ID of the calculated order or the order edit session 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.

Show fields
Anchor to successMessagessuccessMessages •[String!]: Messages to display to the user after the staged changes are committed.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

Commit an order edit and notify the customer

Description

Apply staged changes that remove an item, and email the customer about the updated order. When an edit leaves a balance for the customer to pay, `notifyCustomer: true` sends an invoice instead, and `successMessages` includes `Invoice sent`.

Query

mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
  orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
    order {
      id
      name
    }
    successMessages
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/CalculatedOrder/950617823",
  "notifyCustomer": true
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) { orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) { order { id name } successMessages userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/CalculatedOrder/950617823",
    "notifyCustomer": true
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
    orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
      order {
        id
        name
      }
      successMessages
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/CalculatedOrder/950617823",
        "notifyCustomer": true
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
    orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
      order {
        id
        name
      }
      successMessages
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CalculatedOrder/950617823",
  "notifyCustomer": true
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
      orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
        order {
          id
          name
        }
        successMessages
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/CalculatedOrder/950617823",
        "notifyCustomer": true
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
  orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
    order {
      id
      name
    }
    successMessages
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/CalculatedOrder/950617823",
  "notifyCustomer": true
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-10/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
        orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
          order {
            id
            name
          }
          successMessages
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/CalculatedOrder/950617823",
        "notifyCustomer": true
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "orderEditCommit": {
    "order": {
      "id": "gid://shopify/Order/623575240",
      "name": "#1005"
    },
    "successMessages": [
      "Order updated",
      "Notification sent"
    ],
    "userErrors": []
  }
}

Commit an order edit with a staff note

Description

Apply the changes staged on a calculated order, here one more unit of an existing line item, to the original order. The `staffNote` is saved with the edit for staff members, and `notifyCustomer: false` commits the edit without emailing the customer.

Query

mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean, $staffNote: String) {
  orderEditCommit(id: $id, notifyCustomer: $notifyCustomer, staffNote: $staffNote) {
    order {
      id
      name
      totalPriceSet {
        presentmentMoney {
          amount
          currencyCode
        }
      }
    }
    successMessages
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/CalculatedOrder/950617822",
  "notifyCustomer": false,
  "staffNote": "Customer asked for one more"
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean, $staffNote: String) { orderEditCommit(id: $id, notifyCustomer: $notifyCustomer, staffNote: $staffNote) { order { id name totalPriceSet { presentmentMoney { amount currencyCode } } } successMessages userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/CalculatedOrder/950617822",
    "notifyCustomer": false,
    "staffNote": "Customer asked for one more"
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean, $staffNote: String) {
    orderEditCommit(id: $id, notifyCustomer: $notifyCustomer, staffNote: $staffNote) {
      order {
        id
        name
        totalPriceSet {
          presentmentMoney {
            amount
            currencyCode
          }
        }
      }
      successMessages
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/CalculatedOrder/950617822",
        "notifyCustomer": false,
        "staffNote": "Customer asked for one more"
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean, $staffNote: String) {
    orderEditCommit(id: $id, notifyCustomer: $notifyCustomer, staffNote: $staffNote) {
      order {
        id
        name
        totalPriceSet {
          presentmentMoney {
            amount
            currencyCode
          }
        }
      }
      successMessages
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CalculatedOrder/950617822",
  "notifyCustomer": false,
  "staffNote": "Customer asked for one more"
}

response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean, $staffNote: String) {
      orderEditCommit(id: $id, notifyCustomer: $notifyCustomer, staffNote: $staffNote) {
        order {
          id
          name
          totalPriceSet {
            presentmentMoney {
              amount
              currencyCode
            }
          }
        }
        successMessages
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/CalculatedOrder/950617822",
        "notifyCustomer": false,
        "staffNote": "Customer asked for one more"
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean, $staffNote: String) {
  orderEditCommit(id: $id, notifyCustomer: $notifyCustomer, staffNote: $staffNote) {
    order {
      id
      name
      totalPriceSet {
        presentmentMoney {
          amount
          currencyCode
        }
      }
    }
    successMessages
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/CalculatedOrder/950617822",
  "notifyCustomer": false,
  "staffNote": "Customer asked for one more"
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-10/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean, $staffNote: String) {
        orderEditCommit(id: $id, notifyCustomer: $notifyCustomer, staffNote: $staffNote) {
          order {
            id
            name
            totalPriceSet {
              presentmentMoney {
                amount
                currencyCode
              }
            }
          }
          successMessages
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/CalculatedOrder/950617822",
        "notifyCustomer": false,
        "staffNote": "Customer asked for one more"
    },
  }),
});

const { data } = await response.json();
console.log(data);

Response

{
  "orderEditCommit": {
    "order": {
      "id": "gid://shopify/Order/623575240",
      "name": "#1005",
      "totalPriceSet": {
        "presentmentMoney": {
          "amount": "184.0",
          "currencyCode": "USD"
        }
      }
    },
    "successMessages": [
      "Order updated"
    ],
    "userErrors": []
  }
}

orderEditCommit reference

Examples

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(

`#graphql

mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {

orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {

order {

name

}

successMessages

userErrors {

field

message

}

}`,

{

variables: {

"id": "gid://shopify/CalculatedOrder/950617823",

"notifyCustomer": true

);

const json = await response.json();

return json.data;

}

GQL

mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
  orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
    order {
      id
      name
    }
    successMessages
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) { orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) { order { id name } successMessages userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/CalculatedOrder/950617823",
    "notifyCustomer": true
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  const { admin } = await authenticate.admin(request);
  const response = await admin.graphql(
    `#graphql
  mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
    orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
      order {
        id
        name
      }
      successMessages
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/CalculatedOrder/950617823",
        "notifyCustomer": true
    },
  },
  );
  const json = await response.json();
  return json.data;
}

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
      orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
        order {
          id
          name
        }
        successMessages
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/CalculatedOrder/950617823",
        "notifyCustomer": true
    },
  },
});

Ruby

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~QUERY
  mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
    orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
      order {
        id
        name
      }
      successMessages
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CalculatedOrder/950617823",
  "notifyCustomer": true
}

response = client.query(query: query, variables: variables)

Shopify CLI

shopify app execute \
--query \
'mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
  orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
    order {
      id
      name
    }
    successMessages
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/CalculatedOrder/950617823",
  "notifyCustomer": true
}'

Direct API Access

const response = await fetch('shopify:admin/api/2026-10/graphql.json', {
  method: 'POST',
  body: JSON.stringify({
    query: `
      mutation orderEditCommit($id: ID!, $notifyCustomer: Boolean) {
        orderEditCommit(id: $id, notifyCustomer: $notifyCustomer) {
          order {
            id
            name
          }
          successMessages
          userErrors {
            field
            message
          }
        }
      }
    `,
    variables: {
        "id": "gid://shopify/CalculatedOrder/950617823",
        "notifyCustomer": true
    },
  }),
});

const { data } = await response.json();
console.log(data);

Input variables

JSON

{

"id": "gid://shopify/CalculatedOrder/950617823",

"notifyCustomer": true

}

Response

JSON

{

"orderEditCommit": {

"order": {

"id": "gid://shopify/Order/623575240",

"name": "#1005"

"successMessages": [

"Order updated",

"Notification sent"

"userErrors": []

}