Choose a version:

orderUpdate

mutation

Requires write_orders access scope or write_marketplace_orders access scope. Also: The app must have the write_pos_staff_member_event_attribution_overrides access scope to assign events to another staff member.

Updates the attributes of an order, such as the customer's email, the shipping address for the order, tags, and metafields associated with the order.

If you need to make significant updates to an order, such as adding or removing line items, changing quantities, or modifying discounts, then use the orderEditBegin mutation instead. The orderEditBegin mutation initiates an order editing session, allowing you to make multiple changes before finalizing them. Learn more about using the orderEditBegin mutation to edit existing orders.

If you need to remove a customer from an order, then use the orderCustomerRemove mutation instead.

Learn how to build apps that integrate with order management and fulfillment processes.

Anchor to Arguments

Arguments

Anchor to inputinput •OrderInput! required: The attributes of the updated order.

Was this section helpful?

Anchor to OrderUpdatePayload returnsOrderUpdatePayload returns

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

Was this section helpful?

Examples

Update an order's shipping address and note

Description

This mutation updates the shipping address and note of an existing order, identified by its ID. The response includes the order's updated shipping address and note.

Query

mutation OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } }

Variables

{ "input": { "id": "gid://shopify/Order/148977776", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" }, "note": "Please gift wrap the snowboard." } }

cURL

curl -X POST \ https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "mutation OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } }", "variables": { "input": { "id": "gid://shopify/Order/148977776", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" }, "note": "Please gift wrap the snowboard." } } }'

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 OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } }`, { variables: { "input": { "id": "gid://shopify/Order/148977776", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" }, "note": "Please gift wrap the snowboard." } }, }, ); 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 OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } } QUERY variables = { "input": { "id": "gid://shopify/Order/148977776", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" }, "note": "Please gift wrap the snowboard." } } response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } }`, "variables": { "input": { "id": "gid://shopify/Order/148977776", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" }, "note": "Please gift wrap the snowboard." } }, }, });

Response

{ "orderUpdate": { "order": { "id": "gid://shopify/Order/148977776", "note": "Please gift wrap the snowboard.", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" } }, "userErrors": [] } }

Update an order's tags and customer email address

Description

This mutation updates an existing order by its ID, adding new tags and changing the customer's email address. The response includes details about the order's payment status, cancellation status, customer information, and applied discount codes.

Query

mutation OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { canMarkAsPaid cancelReason cancelledAt clientIp confirmed customer { displayName email } discountCodes } userErrors { field message } } }

Variables

{ "input": { "id": "gid://shopify/Order/148977776", "email": "bob@example.com", "tags": [ "foo", "bar" ] } }

cURL

curl -X POST \ https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "mutation OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { canMarkAsPaid cancelReason cancelledAt clientIp confirmed customer { displayName email } discountCodes } userErrors { field message } } }", "variables": { "input": { "id": "gid://shopify/Order/148977776", "email": "bob@example.com", "tags": [ "foo", "bar" ] } } }'

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 OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { canMarkAsPaid cancelReason cancelledAt clientIp confirmed customer { displayName email } discountCodes } userErrors { field message } } }`, { variables: { "input": { "id": "gid://shopify/Order/148977776", "email": "bob@example.com", "tags": [ "foo", "bar" ] } }, }, ); 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 OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { canMarkAsPaid cancelReason cancelledAt clientIp confirmed customer { displayName email } discountCodes } userErrors { field message } } } QUERY variables = { "input": { "id": "gid://shopify/Order/148977776", "email": "bob@example.com", "tags": [ "foo", "bar" ] } } response = client.query(query: query, variables: variables)

Node.js

const client = new shopify.clients.Graphql({session}); const data = await client.query({ data: { "query": `mutation OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { canMarkAsPaid cancelReason cancelledAt clientIp confirmed customer { displayName email } discountCodes } userErrors { field message } } }`, "variables": { "input": { "id": "gid://shopify/Order/148977776", "email": "bob@example.com", "tags": [ "foo", "bar" ] } }, }, });

Response

{ "orderUpdate": { "order": { "canMarkAsPaid": false, "cancelReason": null, "cancelledAt": null, "clientIp": "216.191.105.144", "confirmed": true, "customer": { "displayName": "Bob Bobsen", "email": "bob@example.com" }, "discountCodes": [] }, "userErrors": [] } }

orderUpdate reference

Examples

Open in GraphiQL

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

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

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

const response = await admin.graphql(

`#graphql

mutation OrderUpdate($input: OrderInput!) {

orderUpdate(input: $input) {

order {

note

shippingAddress {

address1

city

province

zip

country

}

userErrors {

field

message

}

}`,

{

variables: {

"input": {

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

"shippingAddress": {

"address1": "190 MacLaren",

"city": "Sudbury",

"province": "Ontario",

"zip": "K2P0V6",

"country": "Canada"

"note": "Please gift wrap the snowboard."

}

);

const json = await response.json();

return json.data;

}

GQL

mutation OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } }

cURL

curl -X POST \ https://your-development-store.myshopify.com/admin/api/unstable/graphql.json \ -H 'Content-Type: application/json' \ -H 'X-Shopify-Access-Token: {access_token}' \ -d '{ "query": "mutation OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } }", "variables": { "input": { "id": "gid://shopify/Order/148977776", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" }, "note": "Please gift wrap the snowboard." } } }'

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 OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } }`, { variables: { "input": { "id": "gid://shopify/Order/148977776", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" }, "note": "Please gift wrap the snowboard." } }, }, ); 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 OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } }`, "variables": { "input": { "id": "gid://shopify/Order/148977776", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" }, "note": "Please gift wrap the snowboard." } }, }, });

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 OrderUpdate($input: OrderInput!) { orderUpdate(input: $input) { order { id note shippingAddress { address1 city province zip country } } userErrors { field message } } } QUERY variables = { "input": { "id": "gid://shopify/Order/148977776", "shippingAddress": { "address1": "190 MacLaren", "city": "Sudbury", "province": "Ontario", "zip": "K2P0V6", "country": "Canada" }, "note": "Please gift wrap the snowboard." } } response = client.query(query: query, variables: variables)

Input variables

JSON

{

"input": {

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

"shippingAddress": {

"address1": "190 MacLaren",

"city": "Sudbury",

"province": "Ontario",

"zip": "K2P0V6",

"country": "Canada"

"note": "Please gift wrap the snowboard."

}

Response

JSON

{

"orderUpdate": {

"order": {

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

"note": "Please gift wrap the snowboard.",

"shippingAddress": {

"address1": "190 MacLaren",

"city": "Sudbury",

"province": "Ontario",

"zip": "K2P0V6",

"country": "Canada"

}

"userErrors": []

}