# orderEditUpdateShippingLine - admin-graphql - MUTATION Version: 2024-04 ## Description 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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing). ### Access Scopes `write_order_edits` access scope. ## Arguments * [id](/docs/api/admin-graphql/2024-04/scalars/ID): ID! - The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder) from which to update the shipping line. * [shippingLine](/docs/api/admin-graphql/2024-04/input-objects/OrderEditUpdateShippingLineInput): OrderEditUpdateShippingLineInput! - The updated shipping line. * [shippingLineId](/docs/api/admin-graphql/2024-04/scalars/ID): ID! - The ID of the calculated shipping line to update. ## Returns * [calculatedOrder](/docs/api/admin-graphql/2024-04/objects/CalculatedOrder): CalculatedOrder An order with the edits applied but not saved. * [userErrors](/docs/api/admin-graphql/2024-04/objects/OrderEditUpdateShippingLineUserError): OrderEditUpdateShippingLineUserError! The list of errors that occurred from executing the mutation. ## Examples ### Get a user error when updating a committed shipping line Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/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" 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" 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" 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" Graphql 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}" #### Graphql Input { "id": "gid://shopify/CalculatedOrder/607673082", "shippingLineId": "gid://shopify/ShippingLine/1072813969", "shippingLine": { "title": "2-Day Shipping", "price": { "amount": 19.99, "currencyCode": "USD" } } } #### Graphql Response { "errors": [ { "message": "invalid id", "locations": [ { "line": 4, "column": 17 } ], "path": [ "orderEditUpdateShippingLine" ] } ], "data": { "orderEditUpdateShippingLine": null } } ### Update a staged shipping line on an order edit Curl example: "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-04/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" 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" 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" 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" Graphql 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}" #### Graphql Input { "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" } } } #### Graphql Response { "data": { "orderEditUpdateShippingLine": { "calculatedOrder": { "id": "gid://shopify/CalculatedOrder/607673080", "totalOutstandingSet": { "presentmentMoney": { "amount": "251.94", "currencyCode": "USD" } }, "totalPriceSet": { "presentmentMoney": { "amount": "251.94", "currencyCode": "USD" } } }, "userErrors": [] } } }