Choose a version:

orderEditRemoveShippingLine

mutation

Requires write_order_edits access scope.

Removes a shipping line from 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 shippingLineIdshippingLineId •ID!required: The ID of the calculated shipping line to remove.

Was this section helpful?

Anchor to OrderEditRemoveShippingLinePayload returnsOrderEditRemoveShippingLinePayload returns

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

Was this section helpful?

Remove a staged shipping line from an order edit
orderEditRemoveShippingLine reference

Examples

Open in GraphiQL

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

const response = await admin.graphql(

`#graphql

mutation removeShippingLine($id: ID!, $shippingLineId: ID!) {

orderEditRemoveShippingLine(id: $id, shippingLineId: $shippingLineId) {

calculatedOrder {

totalOutstandingSet {

presentmentMoney {

amount

currencyCode

}

totalPriceSet {

presentmentMoney {

amount

currencyCode

}

userErrors {

field

message

}

}`,

{

variables: {

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

"shippingLineId": "gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607"

);

const data = await response.json();

mutation removeShippingLine($id: ID!, $shippingLineId: ID!) {
  orderEditRemoveShippingLine(id: $id, 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 removeShippingLine($id: ID!, $shippingLineId: ID!) { orderEditRemoveShippingLine(id: $id, shippingLineId: $shippingLineId) { calculatedOrder { id totalOutstandingSet { presentmentMoney { amount currencyCode } } totalPriceSet { presentmentMoney { amount currencyCode } } } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/CalculatedOrder/607673085",
    "shippingLineId": "gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607"
  }
}'

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

const response = await admin.graphql(
  `#graphql
  mutation removeShippingLine($id: ID!, $shippingLineId: ID!) {
    orderEditRemoveShippingLine(id: $id, shippingLineId: $shippingLineId) {
      calculatedOrder {
        id
        totalOutstandingSet {
          presentmentMoney {
            amount
            currencyCode
          }
        }
        totalPriceSet {
          presentmentMoney {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
      "id": "gid://shopify/CalculatedOrder/607673085",
      "shippingLineId": "gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607"
    },
  },
);

const data = await response.json();

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation removeShippingLine($id: ID!, $shippingLineId: ID!) {
      orderEditRemoveShippingLine(id: $id, shippingLineId: $shippingLineId) {
        calculatedOrder {
          id
          totalOutstandingSet {
            presentmentMoney {
              amount
              currencyCode
            }
          }
          totalPriceSet {
            presentmentMoney {
              amount
              currencyCode
            }
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
      "id": "gid://shopify/CalculatedOrder/607673085",
      "shippingLineId": "gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607"
    },
  },
});

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 removeShippingLine($id: ID!, $shippingLineId: ID!) {
    orderEditRemoveShippingLine(id: $id, shippingLineId: $shippingLineId) {
      calculatedOrder {
        id
        totalOutstandingSet {
          presentmentMoney {
            amount
            currencyCode
          }
        }
        totalPriceSet {
          presentmentMoney {
            amount
            currencyCode
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CalculatedOrder/607673085",
  "shippingLineId": "gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607"
}

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

Input variables

JSON

{

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

"shippingLineId": "gid://shopify/CalculatedShippingLine/6ffda6d8-c0cf-44d6-8aa4-e89cea4a6607"

}

Response

JSON

{

"orderEditRemoveShippingLine": {

"calculatedOrder": {

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

"totalOutstandingSet": {

"presentmentMoney": {

"amount": "231.95",

"currencyCode": "USD"

}

"totalPriceSet": {

"presentmentMoney": {

"amount": "231.95",

"currencyCode": "USD"

}

"userErrors": []

}