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 scope to assign events to another staff member.

Updates the fields of an order.

Arguments

Anchor to inputinput • OrderInput!required: The input for the mutation.

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?

Create a new metafield and update another on an existing order
Update an order
orderUpdate reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation updateOrderMetafields($input: OrderInput!) {
6    orderUpdate(input: $input) {
7      order {
8        id
9        metafields(first: 3) {
10          edges {
11            node {
12              id
13              namespace
14              key
15              value
16            }
17          }
18        }
19      }
20      userErrors {
21        message
22        field
23      }
24    }
25  }`,
26  {
27    variables: {
28      "input": {
29        "metafields": [
30          {
31            "namespace": "my_field",
32            "key": "delivery_instructions",
33            "type": "single_line_text_field",
34            "value": "leave on back porch"
35          },
36          {
37            "id": "gid://shopify/Metafield/1069228968",
38            "value": "123"
39          }
40        ],
41        "id": "gid://shopify/Order/148977776"
42      }
43    },
44  },
45);
46
47const data = await response.json();
48

mutation updateOrderMetafields($input: OrderInput!) {
  orderUpdate(input: $input) {
    order {
      id
      metafields(first: 3) {
        edges {
          node {
            id
            namespace
            key
            value
          }
        }
      }
    }
    userErrors {
      message
      field
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation updateOrderMetafields($input: OrderInput!) { orderUpdate(input: $input) { order { id metafields(first: 3) { edges { node { id namespace key value } } } } userErrors { message field } } }",
 "variables": {
    "input": {
      "metafields": [
        {
          "namespace": "my_field",
          "key": "delivery_instructions",
          "type": "single_line_text_field",
          "value": "leave on back porch"
        },
        {
          "id": "gid://shopify/Metafield/1069228968",
          "value": "123"
        }
      ],
      "id": "gid://shopify/Order/148977776"
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation updateOrderMetafields($input: OrderInput!) {
    orderUpdate(input: $input) {
      order {
        id
        metafields(first: 3) {
          edges {
            node {
              id
              namespace
              key
              value
            }
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }`,
  {
    variables: {
      "input": {
        "metafields": [
          {
            "namespace": "my_field",
            "key": "delivery_instructions",
            "type": "single_line_text_field",
            "value": "leave on back porch"
          },
          {
            "id": "gid://shopify/Metafield/1069228968",
            "value": "123"
          }
        ],
        "id": "gid://shopify/Order/148977776"
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation updateOrderMetafields($input: OrderInput!) {
      orderUpdate(input: $input) {
        order {
          id
          metafields(first: 3) {
            edges {
              node {
                id
                namespace
                key
                value
              }
            }
          }
        }
        userErrors {
          message
          field
        }
      }
    }`,
    "variables": {
      "input": {
        "metafields": [
          {
            "namespace": "my_field",
            "key": "delivery_instructions",
            "type": "single_line_text_field",
            "value": "leave on back porch"
          },
          {
            "id": "gid://shopify/Metafield/1069228968",
            "value": "123"
          }
        ],
        "id": "gid://shopify/Order/148977776"
      }
    },
  },
});

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 updateOrderMetafields($input: OrderInput!) {
    orderUpdate(input: $input) {
      order {
        id
        metafields(first: 3) {
          edges {
            node {
              id
              namespace
              key
              value
            }
          }
        }
      }
      userErrors {
        message
        field
      }
    }
  }
QUERY

variables = {
  "input": {
    "metafields": [{"namespace"=>"my_field", "key"=>"delivery_instructions", "type"=>"single_line_text_field", "value"=>"leave on back porch"}, {"id"=>"gid://shopify/Metafield/1069228968", "value"=>"123"}],
    "id": "gid://shopify/Order/148977776"
  }
}

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

Input variables

JSON

1{
2  "input": {
3    "metafields": [
4      {
5        "namespace": "my_field",
6        "key": "delivery_instructions",
7        "type": "single_line_text_field",
8        "value": "leave on back porch"
9      },
10      {
11        "id": "gid://shopify/Metafield/1069228968",
12        "value": "123"
13      }
14    ],
15    "id": "gid://shopify/Order/148977776"
16  }
17}

Response

JSON

1{
2  "orderUpdate": {
3    "order": {
4      "id": "gid://shopify/Order/148977776",
5      "metafields": {
6        "edges": [
7          {
8            "node": {
9              "id": "gid://shopify/Metafield/1069228968",
10              "namespace": "my_fields",
11              "key": "purchase_order",
12              "value": "123"
13            }
14          },
15          {
16            "node": {
17              "id": "gid://shopify/Metafield/1069228969",
18              "namespace": "my_field",
19              "key": "delivery_instructions",
20              "value": "leave on back porch"
21            }
22          }
23        ]
24      }
25    },
26    "userErrors": []
27  }
28}