orderEditAddShippingLine - admin-graphql - MUTATION

Version: 2024-10

Description:

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](https://shopify.dev/apps/fulfillment/order-management-apps/order-editing).

Access Scopes

`write_order_edits` access scope.

Arguments

• id: ID! - The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder) to edit.
• shippingLine: OrderEditAddShippingLineInput! - The shipping line to be added.

Returns

• calculatedOrder: CalculatedOrder The [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder) with the edits applied but not saved.
• calculatedShippingLine: CalculatedShippingLine The [calculated shipping line](https://shopify.dev/api/admin-graphql/latest/objects/calculatedshippingline) that's added during this order edit.
• userErrors: OrderEditAddShippingLineUserError! The list of errors that occurred from executing the mutation.

Examples

• Add a shipping line to an order edit

          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"
          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"
          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"
          PHP example: "use Shopify\\Clients\\Graphql;\n\n$client = new Graphql(\"your-development-store.myshopify.com\", $accessToken);\n$query = << \"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"
          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"
          Graphql 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}"
        

  input: {
    "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": []
      }
    }
  }