Anchor to section titled 'undefined'order
order
mutation
Unstable
Requires write access scope or write 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.
Anchor to section titled 'Arguments'
Arguments
The input for the mutation.
Was this section helpful?
Anchor to section titled 'OrderUpdatePayload returns'
OrderUpdatePayload returns
The updated order.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: orderUpdate
Query Reference for MUTATION: orderUpdate
"mutation orderUpdate($input: OrderInput!) {\n orderUpdate(input: $input) {\n order {\n # Order fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: orderUpdate
"{\n \"input\": {\n \"customAttributes\": [\n {\n \"key\": \"<your-key>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"email\": \"<your-email>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"localizationExtensions\": [\n {\n \"key\": \"SHIPPING_CREDENTIAL_BR\",\n \"value\": \"<your-value>\"\n }\n ],\n \"metafields\": [\n {\n \"description\": \"<your-description>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"key\": \"<your-key>\",\n \"namespace\": \"<your-namespace>\",\n \"type\": \"<your-type>\",\n \"value\": \"<your-value>\"\n }\n ],\n \"note\": \"<your-note>\",\n \"poNumber\": \"<your-poNumber>\",\n \"shippingAddress\": {\n \"address1\": \"<your-address1>\",\n \"address2\": \"<your-address2>\",\n \"city\": \"<your-city>\",\n \"company\": \"<your-company>\",\n \"country\": \"<your-country>\",\n \"countryCode\": \"AC\",\n \"firstName\": \"<your-firstName>\",\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"lastName\": \"<your-lastName>\",\n \"phone\": \"<your-phone>\",\n \"province\": \"<your-province>\",\n \"provinceCode\": \"<your-provinceCode>\",\n \"zip\": \"<your-zip>\"\n },\n \"tags\": [\n \"<your-tags>\"\n ]\n }\n}"Schema Reference for MUTATION: orderUpdate
"input OrderInput {\n customAttributes: [AttributeInput!]\n email: String\n id: ID!\n localizationExtensions: [LocalizationExtensionInput!]\n metafields: [MetafieldInput!]\n note: String\n poNumber: String\n privateMetafields: [PrivateMetafieldInput!]\n shippingAddress: MailingAddressInput\n tags: [String!]\n}\n\ninput AttributeInput {\n key: String!\n value: String!\n}\n\ninput LocalizationExtensionInput {\n key: LocalizationExtensionKey!\n value: String!\n}\n\ninput MetafieldInput {\n description: String\n id: ID\n key: String\n namespace: String\n type: String\n value: String\n}\n\ninput PrivateMetafieldInput {\n key: String!\n namespace: String!\n owner: ID\n valueInput: PrivateMetafieldValueInput!\n}\n\ninput MailingAddressInput {\n address1: String\n address2: String\n city: String\n company: String\n country: String\n countryCode: CountryCode\n firstName: String\n id: ID\n lastName: String\n phone: String\n province: String\n provinceCode: String\n zip: String\n}\n"Display Examples for MUTATION: orderUpdate
[
{
"example": {
"type_name": "orderupdate",
"title": "Create a new metafield and update another on an existing order",
"description": "Create a new metafield `my_field.delivery_instructions` and update an\nexisting metafield `my_fields.purchase_order` on a specific\norder.\n\n\nAlternatively, refer to the\n[metafieldsSet](https://shopify.dev/api/admin-graphql/latest/mutations/metafieldsset) mutation\nto create and/or update metafields on order resources.\n",
"query_string": "mutation updateOrderMetafields($input: OrderInput!) {\n orderUpdate(input: $input) {\n order {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n}",
"variables": {
"input": {
"metafields": [
{
"namespace": "my_field",
"key": "delivery_instructions",
"type": "single_line_text_field",
"value": "leave on back porch"
},
{
"id": "gid://shopify/Metafield/1069229021",
"value": "123"
}
],
"id": "gid://shopify/Order/148977776"
}
},
"response": {
"data": {
"orderUpdate": {
"order": {
"id": "gid://shopify/Order/148977776",
"metafields": {
"edges": [
{
"node": {
"id": "gid://shopify/Metafield/1069229021",
"namespace": "my_fields",
"key": "purchase_order",
"value": "123"
}
},
{
"node": {
"id": "gid://shopify/Metafield/1069229022",
"namespace": "my_field",
"key": "delivery_instructions",
"value": "leave on back porch"
}
}
]
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"location": "/components/sales/test/unit/graph_api/admin/mutations/order_update_test.rb",
"minimum_api_version": null,
"maximum_api_version": null,
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/unstable/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation updateOrderMetafields($input: OrderInput!) { orderUpdate(input: $input) { order { id metafields(first: 3) { edges { node { id namespace key value } } } } userErrors { message field } } }\",\n \"variables\": {\n \"input\": {\n \"metafields\": [\n {\n \"namespace\": \"my_field\",\n \"key\": \"delivery_instructions\",\n \"type\": \"single_line_text_field\",\n \"value\": \"leave on back porch\"\n },\n {\n \"id\": \"gid://shopify/Metafield/1069229021\",\n \"value\": \"123\"\n }\n ],\n \"id\": \"gid://shopify/Order/148977776\"\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation updateOrderMetafields($input: OrderInput!) {\n orderUpdate(input: $input) {\n order {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }`,\n {\n variables: {\n \"input\": {\n \"metafields\": [\n {\n \"namespace\": \"my_field\",\n \"key\": \"delivery_instructions\",\n \"type\": \"single_line_text_field\",\n \"value\": \"leave on back porch\"\n },\n {\n \"id\": \"gid://shopify/Metafield/1069229021\",\n \"value\": \"123\"\n }\n ],\n \"id\": \"gid://shopify/Order/148977776\"\n }\n },\n },\n);\n\nconst data = await response.json();\n",
"ruby_example": "session = ShopifyAPI::Auth::Session.new(\n shop: \"your-development-store.myshopify.com\",\n access_token: access_token\n)\nclient = ShopifyAPI::Clients::Graphql::Admin.new(\n session: session\n)\n\nquery = <<~QUERY\n mutation updateOrderMetafields($input: OrderInput!) {\n orderUpdate(input: $input) {\n order {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY\n\nvariables = {\n \"input\": {\n \"metafields\": [{\"namespace\"=>\"my_field\", \"key\"=>\"delivery_instructions\", \"type\"=>\"single_line_text_field\", \"value\"=>\"leave on back porch\"}, {\"id\"=>\"gid://shopify/Metafield/1069229021\", \"value\"=>\"123\"}],\n \"id\": \"gid://shopify/Order/148977776\"\n }\n}\n\nresponse = client.query(query: query, variables: variables)\n",
"node_example": "const client = new shopify.clients.Graphql({session});\nconst data = await client.query({\n data: {\n \"query\": `mutation updateOrderMetafields($input: OrderInput!) {\n orderUpdate(input: $input) {\n order {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }`,\n \"variables\": {\n \"input\": {\n \"metafields\": [\n {\n \"namespace\": \"my_field\",\n \"key\": \"delivery_instructions\",\n \"type\": \"single_line_text_field\",\n \"value\": \"leave on back porch\"\n },\n {\n \"id\": \"gid://shopify/Metafield/1069229021\",\n \"value\": \"123\"\n }\n ],\n \"id\": \"gid://shopify/Order/148977776\"\n }\n },\n },\n});\n",
"php_example": "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = <<<QUERY\n mutation updateOrderMetafields($input: OrderInput!) {\n orderUpdate(input: $input) {\n order {\n id\n metafields(first: 3) {\n edges {\n node {\n id\n namespace\n key\n value\n }\n }\n }\n }\n userErrors {\n message\n field\n }\n }\n }\nQUERY;\n\n$variables = [\n \"input\" => [\n \"metafields\" => [{\"namespace\"=>\"my_field\", \"key\"=>\"delivery_instructions\", \"type\"=>\"single_line_text_field\", \"value\"=>\"leave on back porch\"}, {\"id\"=>\"gid://shopify/Metafield/1069229021\", \"value\"=>\"123\"}],\n \"id\" => \"gid://shopify/Order/148977776\",\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "input",
"description": "The input for the mutation.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "OrderInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "input",
"argValue": " {\"metafields\":[{\"namespace\":\"my_field\",\"key\":\"delivery_instructions\",\"type\":\"single_line_text_field\",\"value\":\"leave on back porch\"},{\"id\":\"gid://shopify/Metafield/1069229021\",\"value\":\"123\"}],\"id\":\"gid://shopify/Order/148977776\"}",
"typeKind": "MUTATION"
}
]
}
]