orderEditUpdateShippingLine

mutation

Requires write_order_edits 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.

Arguments

Anchor to idid • ID!required: The ID of the calculated order from which to update the shipping line.
Anchor to shippingLineshippingLine • OrderEditUpdateShippingLineInput!required: The updated shipping line.
Anchor to shippingLineIdshippingLineId • ID!required: The ID of the calculated shipping line to update.

Was this section helpful?

Anchor to OrderEditUpdateShippingLinePayload returnsOrderEditUpdateShippingLinePayload returns

Anchor to calculatedOrdercalculatedOrder • CalculatedOrder: An order with the edits applied but not saved.
Anchor to userErrorsuserErrors • [OrderEditUpdateShippingLineUserError!]!non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Get a user error when updating a committed shipping line
Update a staged shipping line on an order edit
orderEditUpdateShippingLine reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation updateShippingLine($id: ID!, $shippingLine: OrderEditUpdateShippingLineInput!, $shippingLineId: ID!) {
6    orderEditUpdateShippingLine(id: $id, shippingLine: $shippingLine, shippingLineId: $shippingLineId) {
7      calculatedOrder {
8        id
9        totalOutstandingSet {
10          presentmentMoney {
11            amount
12            currencyCode
13          }
14        }
15        totalPriceSet {
16          presentmentMoney {
17            amount
18            currencyCode
19          }
20        }
21      }
22      userErrors {
23        field
24        message
25      }
26    }
27  }`,
28  {
29    variables: {
30      "id": "gid://shopify/CalculatedOrder/607673082",
31      "shippingLineId": "gid://shopify/ShippingLine/1072813969",
32      "shippingLine": {
33        "title": "2-Day Shipping",
34        "price": {
35          "amount": 19.99,
36          "currencyCode": "USD"
37        }
38      }
39    },
40  },
41);
42
43const data = await response.json();
44

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
    }
  }
}

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2024-10/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"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 } } }",
 "variables": {
    "id": "gid://shopify/CalculatedOrder/607673082",
    "shippingLineId": "gid://shopify/ShippingLine/1072813969",
    "shippingLine": {
      "title": "2-Day Shipping",
      "price": {
        "amount": 19.99,
        "currencyCode": "USD"
      }
    }
  }
}'

const { admin } = await authenticate.admin(request);

const response = await admin.graphql(
  `#graphql
  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
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/CalculatedOrder/607673082",
      "shippingLineId": "gid://shopify/ShippingLine/1072813969",
      "shippingLine": {
        "title": "2-Day Shipping",
        "price": {
          "amount": 19.99,
          "currencyCode": "USD"
        }
      }
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "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
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/CalculatedOrder/607673082",
      "shippingLineId": "gid://shopify/ShippingLine/1072813969",
      "shippingLine": {
        "title": "2-Day Shipping",
        "price": {
          "amount": 19.99,
          "currencyCode": "USD"
        }
      }
    },
  },
});

session = ShopifyAPI::Auth::Session.new(
  shop: "your-development-store.myshopify.com",
  access_token: access_token
)
client = ShopifyAPI::Clients::Graphql::Admin.new(
  session: session
)

query = <<~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
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CalculatedOrder/607673082",
  "shippingLineId": "gid://shopify/ShippingLine/1072813969",
  "shippingLine": {
    "title": "2-Day Shipping",
    "price": {
      "amount": 19.99,
      "currencyCode": "USD"
    }
  }
}

response = client.query(query: query, variables: variables)

Input variables

JSON

1{
2  "id": "gid://shopify/CalculatedOrder/607673082",
3  "shippingLineId": "gid://shopify/ShippingLine/1072813969",
4  "shippingLine": {
5    "title": "2-Day Shipping",
6    "price": {
7      "amount": 19.99,
8      "currencyCode": "USD"
9    }
10  }
11}

Response

JSON

1{
2  "orderEditUpdateShippingLine": null
3}