Anchor to section titled 'undefined'order
order
mutation
2024-07
Requires write access scope.
Updates a shipping line on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.
Anchor to section titled 'Arguments'
Arguments
The ID of the calculated order from which to update the shipping line.
The updated shipping line.
The ID of the calculated shipping line to update.
Was this section helpful?
Anchor to section titled 'OrderEditUpdateShippingLinePayload returns'
OrderEditUpdateShippingLinePayload returns
An order with the edits applied but not saved.
The list of errors that occurred from executing the mutation.
Was this section helpful?
Code examples for MUTATION: orderEditUpdateShippingLine
Query Reference for MUTATION: orderEditUpdateShippingLine
"mutation orderEditUpdateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n # CalculatedOrder fields\n }\n userErrors {\n field\n message\n }\n }\n}"Input Reference for MUTATION: orderEditUpdateShippingLine
"{\n \"id\": \"gid://shopify/<objectName>/10079785100\",\n \"shippingLine\": {\n \"price\": {\n \"amount\": \"29.99\",\n \"currencyCode\": \"AED\"\n },\n \"title\": \"<your-title>\"\n },\n \"shippingLineId\": \"gid://shopify/<objectName>/10079785100\"\n}"Schema Reference for MUTATION: orderEditUpdateShippingLine
"input OrderEditUpdateShippingLineInput {\n price: MoneyInput\n title: String\n}\n\ninput MoneyInput {\n amount: Decimal!\n currencyCode: CurrencyCode!\n}\n"Display Examples for MUTATION: orderEditUpdateShippingLine
[
{
"example": {
"type_name": "ordereditupdateshippingline",
"title": "Get a user error when updating a committed shipping line",
"description": "This mutation returns a user error when updating a committed shipping line. Only staged shipping lines can be updated, whereas committed shipping lines may only be removed.",
"query_string": "mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/CalculatedOrder/607673082",
"shippingLineId": "gid://shopify/ShippingLine/1072813969",
"shippingLine": {
"title": "2-Day Shipping",
"price": {
"amount": 19.99,
"currencyCode": "USD"
}
}
},
"response": {
"errors": [
{
"message": "invalid id",
"locations": [
{
"line": 4,
"column": 17
}
],
"path": [
"orderEditUpdateShippingLine"
]
}
],
"data": {
"orderEditUpdateShippingLine": null
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/sales/test/unit/graph_api/admin/mutations/order_edit_update_shipping_line_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) { orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) { calculatedOrder { id totalOutstandingSet { presentmentMoney { amount currencyCode } } totalPriceSet { presentmentMoney { amount currencyCode } } } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/CalculatedOrder/607673082\",\n \"shippingLineId\": \"gid://shopify/ShippingLine/1072813969\",\n \"shippingLine\": {\n \"title\": \"2-Day Shipping\",\n \"price\": {\n \"amount\": 19.99,\n \"currencyCode\": \"USD\"\n }\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/CalculatedOrder/607673082\",\n \"shippingLineId\": \"gid://shopify/ShippingLine/1072813969\",\n \"shippingLine\": {\n \"title\": \"2-Day Shipping\",\n \"price\": {\n \"amount\": 19.99,\n \"currencyCode\": \"USD\"\n }\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 updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/CalculatedOrder/607673082\",\n \"shippingLineId\": \"gid://shopify/ShippingLine/1072813969\",\n \"shippingLine\": {\n \"title\": \"2-Day Shipping\",\n \"price\": {\n \"amount\": 19.99,\n \"currencyCode\": \"USD\"\n }\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 updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/CalculatedOrder/607673082\",\n \"shippingLineId\": \"gid://shopify/ShippingLine/1072813969\",\n \"shippingLine\": {\n \"title\": \"2-Day Shipping\",\n \"price\": {\n \"amount\": 19.99,\n \"currencyCode\": \"USD\"\n }\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 updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/CalculatedOrder/607673082\",\n \"shippingLineId\" => \"gid://shopify/ShippingLine/1072813969\",\n \"shippingLine\" => [\n \"title\" => \"2-Day Shipping\",\n \"price\" => [\n \"amount\" => 19.99,\n \"currencyCode\" => \"USD\",\n ],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nfrom which to update the shipping line.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/CalculatedOrder/607673082\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "shippingLineId",
"description": "The ID of the calculated shipping line to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "shippingLineId",
"argValue": " \"gid://shopify/ShippingLine/1072813969\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "shippingLine",
"description": "The updated shipping line.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderEditUpdateShippingLineInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "OrderEditUpdateShippingLineInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "shippingLine",
"argValue": " {\"title\":\"2-Day Shipping\",\"price\":{\"amount\":19.99,\"currencyCode\":\"USD\"}}",
"typeKind": "MUTATION"
}
]
},
{
"example": {
"type_name": "ordereditupdateshippingline",
"title": "Update a staged shipping line on an order edit",
"description": "This mutation updates a staged shipping line on an order edit.",
"query_string": "mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n}",
"variables": {
"id": "gid://shopify/CalculatedOrder/607673080",
"shippingLineId": "gid://shopify/CalculatedShippingLine/52ccb02a-dbb1-4b10-ac24-3e7861a641ec",
"shippingLine": {
"title": "2-Day Shipping",
"price": {
"amount": 19.99,
"currencyCode": "USD"
}
}
},
"response": {
"data": {
"orderEditUpdateShippingLine": {
"calculatedOrder": {
"id": "gid://shopify/CalculatedOrder/607673080",
"totalOutstandingSet": {
"presentmentMoney": {
"amount": "251.94",
"currencyCode": "USD"
}
},
"totalPriceSet": {
"presentmentMoney": {
"amount": "251.94",
"currencyCode": "USD"
}
}
},
"userErrors": []
}
}
},
"api_name": "admin",
"minimum_api_version": "2024-04",
"maximum_api_version": "unstable",
"location": "/components/sales/test/unit/graph_api/admin/mutations/order_edit_update_shipping_line_test.rb",
"curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-07/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) { orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) { calculatedOrder { id totalOutstandingSet { presentmentMoney { amount currencyCode } } totalPriceSet { presentmentMoney { amount currencyCode } } } userErrors { field message } } }\",\n \"variables\": {\n \"id\": \"gid://shopify/CalculatedOrder/607673080\",\n \"shippingLineId\": \"gid://shopify/CalculatedShippingLine/52ccb02a-dbb1-4b10-ac24-3e7861a641ec\",\n \"shippingLine\": {\n \"title\": \"2-Day Shipping\",\n \"price\": {\n \"amount\": 19.99,\n \"currencyCode\": \"USD\"\n }\n }\n }\n}'\n",
"remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n `#graphql\n mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n {\n variables: {\n \"id\": \"gid://shopify/CalculatedOrder/607673080\",\n \"shippingLineId\": \"gid://shopify/CalculatedShippingLine/52ccb02a-dbb1-4b10-ac24-3e7861a641ec\",\n \"shippingLine\": {\n \"title\": \"2-Day Shipping\",\n \"price\": {\n \"amount\": 19.99,\n \"currencyCode\": \"USD\"\n }\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 updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY\n\nvariables = {\n \"id\": \"gid://shopify/CalculatedOrder/607673080\",\n \"shippingLineId\": \"gid://shopify/CalculatedShippingLine/52ccb02a-dbb1-4b10-ac24-3e7861a641ec\",\n \"shippingLine\": {\n \"title\": \"2-Day Shipping\",\n \"price\": {\n \"amount\": 19.99,\n \"currencyCode\": \"USD\"\n }\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 updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }`,\n \"variables\": {\n \"id\": \"gid://shopify/CalculatedOrder/607673080\",\n \"shippingLineId\": \"gid://shopify/CalculatedShippingLine/52ccb02a-dbb1-4b10-ac24-3e7861a641ec\",\n \"shippingLine\": {\n \"title\": \"2-Day Shipping\",\n \"price\": {\n \"amount\": 19.99,\n \"currencyCode\": \"USD\"\n }\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 updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {\n orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {\n calculatedOrder {\n id\n totalOutstandingSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n totalPriceSet {\n presentmentMoney {\n amount\n currencyCode\n }\n }\n }\n userErrors {\n field\n message\n }\n }\n }\nQUERY;\n\n$variables = [\n \"id\" => \"gid://shopify/CalculatedOrder/607673080\",\n \"shippingLineId\" => \"gid://shopify/CalculatedShippingLine/52ccb02a-dbb1-4b10-ac24-3e7861a641ec\",\n \"shippingLine\" => [\n \"title\" => \"2-Day Shipping\",\n \"price\" => [\n \"amount\" => 19.99,\n \"currencyCode\" => \"USD\",\n ],\n ],\n];\n\n$response = $client->query([\"query\" => $query, \"variables\" => $variables]);\n"
},
"titleStringKey": "variables",
"inputVariableEntries": [
{
"arg": {
"name": "id",
"description": "The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder)\nfrom which to update the shipping line.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "id",
"argValue": " \"gid://shopify/CalculatedOrder/607673080\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "shippingLineId",
"description": "The ID of the calculated shipping line to update.",
"type": {
"kind": "SCALAR",
"name": "ID",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "ID!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "shippingLineId",
"argValue": " \"gid://shopify/CalculatedShippingLine/52ccb02a-dbb1-4b10-ac24-3e7861a641ec\"",
"typeKind": "MUTATION"
},
{
"arg": {
"name": "shippingLine",
"description": "The updated shipping line.",
"type": {
"kind": "INPUT_OBJECT",
"name": "OrderEditUpdateShippingLineInput",
"list": false,
"non_null": true
},
"defaultValue": null,
"typeSignature": "OrderEditUpdateShippingLineInput!",
"isDeprecated": false,
"deprecationReason": null,
"kind": "ARGUMENT"
},
"key": "shippingLine",
"argValue": " {\"title\":\"2-Day Shipping\",\"price\":{\"amount\":19.99,\"currencyCode\":\"USD\"}}",
"typeKind": "MUTATION"
}
]
}
]