orderEditRemoveShippingLine
mutation

Choose a version:

Requires write_order_edits access scope.

Removes a shipping line from an existing order. 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

Anchor to id id ID! required: The ID of the calculated order to edit.
Anchor to shippingLineId shippingLineId ID! required: The ID of the calculated shipping line to remove.

Was this section helpful?

Anchor to section titled 'OrderEditRemoveShippingLinePayload returns'

OrderEditRemoveShippingLinePayload returns

Anchor to OrderEditRemoveShippingLinePayload.calculatedOrder calculatedOrder CalculatedOrder: The calculated order with the edits applied but not saved.
Anchor to OrderEditRemoveShippingLinePayload.userErrors userErrors [OrderEditRemoveShippingLineUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: orderEditRemoveShippingLine

Query Reference for MUTATION: orderEditRemoveShippingLine

"mutation orderEditRemoveShippingLine($id: ID!, $shippingLineId: ID!) {\n  orderEditRemoveShippingLine(id: $id, shippingLineId: $shippingLineId) {\n    calculatedOrder {\n      # CalculatedOrder fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: orderEditRemoveShippingLine

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\",\n  \"shippingLineId\": \"gid://shopify/<objectName>/10079785100\"\n}"

Schema Reference for MUTATION: orderEditRemoveShippingLine

""

Display Examples for MUTATION: orderEditRemoveShippingLine

[
  {
    "example": {
      "type_name": "ordereditremoveshippingline",
      "title": "Remove a staged shipping line from an order edit",
      "query_string": "mutation removeShippingLine($id: ID!, $shippingLineId: ID!) {\n  orderEditRemoveShippingLine(id: $id, 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/607673085",
        "shippingLineId": "gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607"
      },
      "response": {
        "data": {
          "orderEditRemoveShippingLine": {
            "calculatedOrder": {
              "id": "gid://shopify/CalculatedOrder/607673085",
              "totalOutstandingSet": {
                "presentmentMoney": {
                  "amount": "231.95",
                  "currencyCode": "USD"
                }
              },
              "totalPriceSet": {
                "presentmentMoney": {
                  "amount": "231.95",
                  "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_remove_shipping_line_test.rb",
      "curl_example": "curl -X POST \\\nhttps://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \\\n-H 'Content-Type: application/json' \\\n-H 'X-Shopify-Access-Token: {access_token}' \\\n-d '{\n\"query\": \"mutation removeShippingLine($id: ID!, $shippingLineId: ID!) { orderEditRemoveShippingLine(id: $id, shippingLineId: $shippingLineId) { calculatedOrder { id totalOutstandingSet { presentmentMoney { amount currencyCode } } totalPriceSet { presentmentMoney { amount currencyCode } } } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/CalculatedOrder/607673085\",\n    \"shippingLineId\": \"gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607\"\n  }\n}'\n",
      "remix_example": "const { admin } = await authenticate.admin(request);\n\nconst response = await admin.graphql(\n  `#graphql\n  mutation removeShippingLine($id: ID!, $shippingLineId: ID!) {\n    orderEditRemoveShippingLine(id: $id, 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/607673085\",\n      \"shippingLineId\": \"gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607\"\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 removeShippingLine($id: ID!, $shippingLineId: ID!) {\n    orderEditRemoveShippingLine(id: $id, 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/607673085\",\n  \"shippingLineId\": \"gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607\"\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 removeShippingLine($id: ID!, $shippingLineId: ID!) {\n      orderEditRemoveShippingLine(id: $id, 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/607673085\",\n      \"shippingLineId\": \"gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607\"\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 removeShippingLine($id: ID!, $shippingLineId: ID!) {\n    orderEditRemoveShippingLine(id: $id, 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/607673085\",\n  \"shippingLineId\" => \"gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607\",\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)\nto edit.",
          "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/607673085\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "shippingLineId",
          "description": "The ID of the calculated shipping line to remove.",
          "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/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607\"",
        "typeKind": "MUTATION"
      }
    ]
  }
]

orderEditRemoveShippingLinemutation

Arguments

OrderEditRemoveShippingLinePayload returns

orderEditRemoveShippingLine
mutation