orderEditAddShippingLine
mutation

Choose a version:

Requires write_order_edits access scope.

Adds a shipping line to 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 shippingLine shippingLine OrderEditAddShippingLineInput! required: The shipping line to be added.

Was this section helpful?

Anchor to section titled 'OrderEditAddShippingLinePayload returns'

OrderEditAddShippingLinePayload returns

Anchor to OrderEditAddShippingLinePayload.calculatedOrder calculatedOrder CalculatedOrder: The calculated order with the edits applied but not saved.
Anchor to OrderEditAddShippingLinePayload.calculatedShippingLine calculatedShippingLine CalculatedShippingLine: The calculated shipping line that's added during this order edit.
Anchor to OrderEditAddShippingLinePayload.userErrors userErrors [OrderEditAddShippingLineUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: orderEditAddShippingLine

Query Reference for MUTATION: orderEditAddShippingLine

"mutation orderEditAddShippingLine($id: ID!, $shippingLine: OrderEditAddShippingLineInput!) {\n  orderEditAddShippingLine(id: $id, shippingLine: $shippingLine) {\n    calculatedOrder {\n      # CalculatedOrder fields\n    }\n    calculatedShippingLine {\n      # CalculatedShippingLine fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: orderEditAddShippingLine

"{\n  \"id\": \"gid://shopify/<objectName>/10079785100\",\n  \"shippingLine\": {\n    \"price\": {\n      \"amount\": \"29.99\",\n      \"currencyCode\": \"AED\"\n    },\n    \"title\": \"<your-title>\"\n  }\n}"

Schema Reference for MUTATION: orderEditAddShippingLine

"input OrderEditAddShippingLineInput {\n  price: MoneyInput!\n  title: String!\n}\n\ninput MoneyInput {\n  amount: Decimal!\n  currencyCode: CurrencyCode!\n}\n"

Display Examples for MUTATION: orderEditAddShippingLine

[
  {
    "example": {
      "type_name": "ordereditaddshippingline",
      "title": "Add a shipping line to an order edit",
      "query_string": "mutation addShippingLine($id: ID!, $shippingLine: OrderEditAddShippingLineInput!) {\n  orderEditAddShippingLine(id: $id, shippingLine: $shippingLine) {\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    calculatedShippingLine {\n      id\n      title\n      price {\n        presentmentMoney {\n          amount\n          currencyCode\n        }\n      }\n      stagedStatus\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}",
      "variables": {
        "id": "gid://shopify/CalculatedOrder/607673083",
        "shippingLine": {
          "title": "2-Day Shipping",
          "price": {
            "amount": 19.99,
            "currencyCode": "USD"
          }
        }
      },
      "response": {
        "data": {
          "orderEditAddShippingLine": {
            "calculatedOrder": {
              "id": "gid://shopify/CalculatedOrder/607673083",
              "totalOutstandingSet": {
                "presentmentMoney": {
                  "amount": "19.99",
                  "currencyCode": "USD"
                }
              },
              "totalPriceSet": {
                "presentmentMoney": {
                  "amount": "31.49",
                  "currencyCode": "USD"
                }
              }
            },
            "calculatedShippingLine": {
              "id": "gid://shopify/CalculatedShippingLine/52c5ee83-d24a-4a4d-a048-b00ad90aa19f",
              "title": "2-Day Shipping",
              "price": {
                "presentmentMoney": {
                  "amount": "19.99",
                  "currencyCode": "USD"
                }
              },
              "stagedStatus": "ADDED"
            },
            "userErrors": []
          }
        }
      },
      "api_name": "admin",
      "minimum_api_version": "2024-04",
      "maximum_api_version": "unstable",
      "location": "/components/sales/test/unit/graph_api/admin/mutations/order_edit_add_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 addShippingLine($id: ID!, $shippingLine: OrderEditAddShippingLineInput!) { orderEditAddShippingLine(id: $id, shippingLine: $shippingLine) { calculatedOrder { id totalOutstandingSet { presentmentMoney { amount currencyCode } } totalPriceSet { presentmentMoney { amount currencyCode } } } calculatedShippingLine { id title price { presentmentMoney { amount currencyCode } } stagedStatus } userErrors { field message } } }\",\n \"variables\": {\n    \"id\": \"gid://shopify/CalculatedOrder/607673083\",\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 addShippingLine($id: ID!, $shippingLine: OrderEditAddShippingLineInput!) {\n    orderEditAddShippingLine(id: $id, shippingLine: $shippingLine) {\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      calculatedShippingLine {\n        id\n        title\n        price {\n          presentmentMoney {\n            amount\n            currencyCode\n          }\n        }\n        stagedStatus\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }`,\n  {\n    variables: {\n      \"id\": \"gid://shopify/CalculatedOrder/607673083\",\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 addShippingLine($id: ID!, $shippingLine: OrderEditAddShippingLineInput!) {\n    orderEditAddShippingLine(id: $id, shippingLine: $shippingLine) {\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      calculatedShippingLine {\n        id\n        title\n        price {\n          presentmentMoney {\n            amount\n            currencyCode\n          }\n        }\n        stagedStatus\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY\n\nvariables = {\n  \"id\": \"gid://shopify/CalculatedOrder/607673083\",\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 addShippingLine($id: ID!, $shippingLine: OrderEditAddShippingLineInput!) {\n      orderEditAddShippingLine(id: $id, shippingLine: $shippingLine) {\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        calculatedShippingLine {\n          id\n          title\n          price {\n            presentmentMoney {\n              amount\n              currencyCode\n            }\n          }\n          stagedStatus\n        }\n        userErrors {\n          field\n          message\n        }\n      }\n    }`,\n    \"variables\": {\n      \"id\": \"gid://shopify/CalculatedOrder/607673083\",\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 addShippingLine($id: ID!, $shippingLine: OrderEditAddShippingLineInput!) {\n    orderEditAddShippingLine(id: $id, shippingLine: $shippingLine) {\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      calculatedShippingLine {\n        id\n        title\n        price {\n          presentmentMoney {\n            amount\n            currencyCode\n          }\n        }\n        stagedStatus\n      }\n      userErrors {\n        field\n        message\n      }\n    }\n  }\nQUERY;\n\n$variables = [\n  \"id\" => \"gid://shopify/CalculatedOrder/607673083\",\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)\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/607673083\"",
        "typeKind": "MUTATION"
      },
      {
        "arg": {
          "name": "shippingLine",
          "description": "The shipping line to be added.",
          "type": {
            "kind": "INPUT_OBJECT",
            "name": "OrderEditAddShippingLineInput",
            "list": false,
            "non_null": true
          },
          "defaultValue": null,
          "typeSignature": "OrderEditAddShippingLineInput!",
          "isDeprecated": false,
          "deprecationReason": null,
          "kind": "ARGUMENT"
        },
        "key": "shippingLine",
        "argValue": " {\"title\":\"2-Day Shipping\",\"price\":{\"amount\":19.99,\"currencyCode\":\"USD\"}}",
        "typeKind": "MUTATION"
      }
    ]
  }
]

orderEditAddShippingLinemutation

Arguments

OrderEditAddShippingLinePayload returns

orderEditAddShippingLine
mutation