Choose a version:

orderEditAddLineItemDiscount

mutation

Requires write_order_edits access scope. Also: The user must have apply_discounts_to_orders permission.

Applies a discount to a LineItem during an order edit session. The discount can be either a fixed amount or percentage value.

To modify pricing on specific line items, use this mutation after starting an order edit with the orderEditBegin mutation. The changes remain staged until you commit them with the orderEditCommit mutation.

Learn more about editing existing orders.

Anchor to Arguments

Arguments

Anchor to discountdiscount

•OrderEditAppliedDiscountInput!

required

The discount to add to the line item.

Anchor to idid

•ID!

required

The ID of the calculated order or the order edit session to edit.

Anchor to lineItemIdlineItemId

•ID!

required

The ID of the calculated line item to add the discount to.

Was this section helpful?

Anchor to OrderEditAddLineItemDiscountPayload returnsOrderEditAddLineItemDiscountPayload returns

Anchor to addedDiscountStagedChangeaddedDiscountStagedChange •OrderStagedChangeAddLineItemDiscount: The discount applied to a line item during this order edit.
Anchor to calculatedLineItemcalculatedLineItem •CalculatedLineItem: The line item with the edits applied but not saved.
Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: An order with the edits applied but not saved.
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.
Anchor to userErrorsuserErrors •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Examples

Add a 50% discount to a line item in an order edit

Query

mutation orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
  orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
    calculatedOrder {
      id
    }
    calculatedLineItem {
      id
      calculatedDiscountAllocations {
        discountApplication {
          id
        }
      }
    }
    addedDiscountStagedChange {
      id
      description
      value {
        __typename
        ... on PricingPercentageValue {
          percentage
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}

Variables

{
  "id": "gid://shopify/CalculatedOrder/607673109",
  "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
  "discount": {
    "description": "50% off promotion",
    "percentValue": 50
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) { orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) { calculatedOrder { id } calculatedLineItem { id calculatedDiscountAllocations { discountApplication { id } } } addedDiscountStagedChange { id description value { __typename ... on PricingPercentageValue { percentage } } } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/CalculatedOrder/607673109",
    "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
    "discount": {
      "description": "50% off promotion",
      "percentValue": 50
    }
  }
}'

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 orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
    orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
      calculatedOrder {
        id
      }
      calculatedLineItem {
        id
        calculatedDiscountAllocations {
          discountApplication {
            id
          }
        }
      }
      addedDiscountStagedChange {
        id
        description
        value {
          __typename
          ... on PricingPercentageValue {
            percentage
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/CalculatedOrder/607673109",
        "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
        "discount": {
            "description": "50% off promotion",
            "percentValue": 50
        }
    },
  },
  );
  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 orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
    orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
      calculatedOrder {
        id
      }
      calculatedLineItem {
        id
        calculatedDiscountAllocations {
          discountApplication {
            id
          }
        }
      }
      addedDiscountStagedChange {
        id
        description
        value {
          __typename
          ... on PricingPercentageValue {
            percentage
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CalculatedOrder/607673109",
  "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
  "discount": {
    "description": "50% off promotion",
    "percentValue": 50
  }
}

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

Node.js

const client = new shopify.clients.Graphql({session});
const data = await client.query({
  data: {
    "query": `mutation orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
      orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
        calculatedOrder {
          id
        }
        calculatedLineItem {
          id
          calculatedDiscountAllocations {
            discountApplication {
              id
            }
          }
        }
        addedDiscountStagedChange {
          id
          description
          value {
            __typename
            ... on PricingPercentageValue {
              percentage
            }
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/CalculatedOrder/607673109",
        "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
        "discount": {
            "description": "50% off promotion",
            "percentValue": 50
        }
    },
  },
});

Shopify CLI

shopify app execute \
--query \
'mutation orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
  orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
    calculatedOrder {
      id
    }
    calculatedLineItem {
      id
      calculatedDiscountAllocations {
        discountApplication {
          id
        }
      }
    }
    addedDiscountStagedChange {
      id
      description
      value {
        __typename
        ... on PricingPercentageValue {
          percentage
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/CalculatedOrder/607673109",
  "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
  "discount": {
    "description": "50% off promotion",
    "percentValue": 50
  }
}'

Response

{
  "orderEditAddLineItemDiscount": {
    "calculatedOrder": {
      "id": "gid://shopify/CalculatedOrder/607673109"
    },
    "calculatedLineItem": {
      "id": "gid://shopify/CalculatedLineItem/510711879",
      "calculatedDiscountAllocations": [
        {
          "discountApplication": {
            "id": "gid://shopify/CalculatedManualDiscountApplication/68bd25c3-b74e-4250-814f-9fec0549c043"
          }
        }
      ]
    },
    "addedDiscountStagedChange": {
      "id": "gid://shopify/OrderStagedChangeAddLineItemDiscount/925898897",
      "description": "50% off promotion",
      "value": {
        "__typename": "PricingPercentageValue",
        "percentage": 50
      }
    },
    "userErrors": []
  }
}

orderEditAddLineItemDiscount 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 orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {

orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {

calculatedOrder {

}

calculatedLineItem {

calculatedDiscountAllocations {

discountApplication {

}

addedDiscountStagedChange {

description

value {

__typename

... on PricingPercentageValue {

percentage

}

userErrors {

field

message

}

}`,

{

variables: {

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

"lineItemId": "gid://shopify/CalculatedLineItem/510711879",

"discount": {

"description": "50% off promotion",

"percentValue": 50

}

);

const json = await response.json();

return json.data;

}

GQL

mutation orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
  orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
    calculatedOrder {
      id
    }
    calculatedLineItem {
      id
      calculatedDiscountAllocations {
        discountApplication {
          id
        }
      }
    }
    addedDiscountStagedChange {
      id
      description
      value {
        __typename
        ... on PricingPercentageValue {
          percentage
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}

cURL

curl -X POST \
https://your-development-store.myshopify.com/admin/api/2026-01/graphql.json \
-H 'Content-Type: application/json' \
-H 'X-Shopify-Access-Token: {access_token}' \
-d '{
"query": "mutation orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) { orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) { calculatedOrder { id } calculatedLineItem { id calculatedDiscountAllocations { discountApplication { id } } } addedDiscountStagedChange { id description value { __typename ... on PricingPercentageValue { percentage } } } userErrors { field message } } }",
 "variables": {
    "id": "gid://shopify/CalculatedOrder/607673109",
    "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
    "discount": {
      "description": "50% off promotion",
      "percentValue": 50
    }
  }
}'

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 orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
    orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
      calculatedOrder {
        id
      }
      calculatedLineItem {
        id
        calculatedDiscountAllocations {
          discountApplication {
            id
          }
        }
      }
      addedDiscountStagedChange {
        id
        description
        value {
          __typename
          ... on PricingPercentageValue {
            percentage
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }`,
  {
    variables: {
        "id": "gid://shopify/CalculatedOrder/607673109",
        "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
        "discount": {
            "description": "50% off promotion",
            "percentValue": 50
        }
    },
  },
  );
  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 orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
      orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
        calculatedOrder {
          id
        }
        calculatedLineItem {
          id
          calculatedDiscountAllocations {
            discountApplication {
              id
            }
          }
        }
        addedDiscountStagedChange {
          id
          description
          value {
            __typename
            ... on PricingPercentageValue {
              percentage
            }
          }
        }
        userErrors {
          field
          message
        }
      }
    }`,
    "variables": {
        "id": "gid://shopify/CalculatedOrder/607673109",
        "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
        "discount": {
            "description": "50% off promotion",
            "percentValue": 50
        }
    },
  },
});

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 orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
    orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
      calculatedOrder {
        id
      }
      calculatedLineItem {
        id
        calculatedDiscountAllocations {
          discountApplication {
            id
          }
        }
      }
      addedDiscountStagedChange {
        id
        description
        value {
          __typename
          ... on PricingPercentageValue {
            percentage
          }
        }
      }
      userErrors {
        field
        message
      }
    }
  }
QUERY

variables = {
  "id": "gid://shopify/CalculatedOrder/607673109",
  "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
  "discount": {
    "description": "50% off promotion",
    "percentValue": 50
  }
}

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

Shopify CLI

shopify app execute \
--query \
'mutation orderEditAddLineItemDiscount($id: ID!, $lineItemId: ID!, $discount: OrderEditAppliedDiscountInput!) {
  orderEditAddLineItemDiscount(id: $id, lineItemId: $lineItemId, discount: $discount) {
    calculatedOrder {
      id
    }
    calculatedLineItem {
      id
      calculatedDiscountAllocations {
        discountApplication {
          id
        }
      }
    }
    addedDiscountStagedChange {
      id
      description
      value {
        __typename
        ... on PricingPercentageValue {
          percentage
        }
      }
    }
    userErrors {
      field
      message
    }
  }
}' \
--variables \
'{
  "id": "gid://shopify/CalculatedOrder/607673109",
  "lineItemId": "gid://shopify/CalculatedLineItem/510711879",
  "discount": {
    "description": "50% off promotion",
    "percentValue": 50
  }
}'

Input variables

JSON

{

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

"lineItemId": "gid://shopify/CalculatedLineItem/510711879",

"discount": {

"description": "50% off promotion",

"percentValue": 50

}

Response

JSON

{

"orderEditAddLineItemDiscount": {

"calculatedOrder": {

"id": "gid://shopify/CalculatedOrder/607673109"

"calculatedLineItem": {

"id": "gid://shopify/CalculatedLineItem/510711879",

"calculatedDiscountAllocations": [

{

"discountApplication": {

"id": "gid://shopify/CalculatedManualDiscountApplication/68bd25c3-b74e-4250-814f-9fec0549c043"

}

]

"addedDiscountStagedChange": {

"id": "gid://shopify/OrderStagedChangeAddLineItemDiscount/925898897",

"description": "50% off promotion",

"value": {

"__typename": "PricingPercentageValue",

"percentage": 50

}

"userErrors": []

}