orderEditAddShippingLine

mutation

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.

Arguments

Anchor to idid • ID!required: The ID of the calculated order to edit.
Anchor to shippingLineshippingLine • OrderEditAddShippingLineInput!required: The shipping line to be added.

Was this section helpful?

Anchor to OrderEditAddShippingLinePayload returnsOrderEditAddShippingLinePayload returns

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

Was this section helpful?

Add a shipping line to an order edit
orderEditAddShippingLine reference

Examples

1const { admin } = await authenticate.admin(request);
2
3const response = await admin.graphql(
4  `#graphql
5  mutation addShippingLine($id: ID!, $shippingLine: OrderEditAddShippingLineInput!) {
6    orderEditAddShippingLine(id: $id, shippingLine: $shippingLine) {
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      calculatedShippingLine {
23        id
24        title
25        price {
26          presentmentMoney {
27            amount
28            currencyCode
29          }
30        }
31        stagedStatus
32      }
33      userErrors {
34        field
35        message
36      }
37    }
38  }`,
39  {
40    variables: {
41      "id": "gid://shopify/CalculatedOrder/607673083",
42      "shippingLine": {
43        "title": "2-Day Shipping",
44        "price": {
45          "amount": 19.99,
46          "currencyCode": "USD"
47        }
48      }
49    },
50  },
51);
52
53const data = await response.json();
54

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

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 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 } } }",
 "variables": {
    "id": "gid://shopify/CalculatedOrder/607673083",
    "shippingLine": {
      "title": "2-Day Shipping",
      "price": {
        "amount": 19.99,
        "currencyCode": "USD"
      }
    }
  }
}'

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

const response = await admin.graphql(
  `#graphql
  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
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/CalculatedOrder/607673083",
      "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 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
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/CalculatedOrder/607673083",
      "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 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
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CalculatedOrder/607673083",
  "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/607673083",
3  "shippingLine": {
4    "title": "2-Day Shipping",
5    "price": {
6      "amount": 19.99,
7      "currencyCode": "USD"
8    }
9  }
10}

Response

JSON

1{
2  "orderEditAddShippingLine": {
3    "calculatedOrder": {
4      "id": "gid://shopify/CalculatedOrder/607673083",
5      "totalOutstandingSet": {
6        "presentmentMoney": {
7          "amount": "19.99",
8          "currencyCode": "USD"
9        }
10      },
11      "totalPriceSet": {
12        "presentmentMoney": {
13          "amount": "31.49",
14          "currencyCode": "USD"
15        }
16      }
17    },
18    "calculatedShippingLine": {
19      "id": "gid://shopify/CalculatedShippingLine/52c5ee83-d24a-4a4d-a048-b00ad90aa19f",
20      "title": "2-Day Shipping",
21      "price": {
22        "presentmentMoney": {
23          "amount": "19.99",
24          "currencyCode": "USD"
25        }
26      },
27      "stagedStatus": "ADDED"
28    },
29    "userErrors": []
30  }
31}