Choose a version:

orderEditAddShippingLine

mutation

Requires write_order_edits access scope.

Adds a custom shipping line to an Order during an edit session. Specify the shipping title and price to create a new ShippingLine.

Returns a CalculatedOrder showing the order with edits applied but not yet saved. To save your changes, use the orderEditCommit mutation.

Learn more about editing existing orders.

Anchor to Arguments

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?

Examples

Add a shipping line to an order edit

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

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/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"
      }
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Ruby

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)

Node.js

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"
            }
        }
    },
  },
});

Response

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

orderEditAddShippingLine reference

Examples

Open in GraphiQL

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {

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

const response = await admin.graphql(

`#graphql

mutation addShippingLine($id: ID!, $shippingLine: OrderEditAddShippingLineInput!) {

orderEditAddShippingLine(id: $id, shippingLine: $shippingLine) {

calculatedOrder {

totalOutstandingSet {

presentmentMoney {

amount

currencyCode

}

totalPriceSet {

presentmentMoney {

amount

currencyCode

}

calculatedShippingLine {

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 json = await response.json();

return json.data;

}

GQL

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

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2025-01/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"
      }
    }
  }
}'

React Router

import { authenticate } from "../shopify.server";

export const loader = async ({request}) => {
  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 json = await response.json();
  return json.data;
}

Node.js

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"
            }
        }
    },
  },
});

Ruby

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

{

"id": "gid://shopify/CalculatedOrder/607673083",

"shippingLine": {

"title": "2-Day Shipping",

"price": {

"amount": 19.99,

"currencyCode": "USD"

}

Response

JSON

{

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

}