Choose a version:

orderEditUpdateDiscount

mutation

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

Updates a manual line level discount on the current order edit. If the order has an existing write-off, mutations such as this one, which reduce the order total, can reduce the written-off amount automatically when the edit is committed and the order total before write-offs falls below the remaining written-off amount. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Anchor to Arguments

Arguments

Anchor to discountdiscount

•OrderEditAppliedDiscountInput!

required

The updated discount.

Show input fields

Anchor to discountApplicationIddiscountApplicationId

•ID!

required

The ID of the calculated discount application to update.

Anchor to idid

•ID!

required

The ID of the calculated order or the order edit session to edit. This is the edit used to update the discount.

Was this section helpful?

Anchor to OrderEditUpdateDiscountPayload returnsOrderEditUpdateDiscountPayload returns

Anchor to calculatedOrdercalculatedOrder •CalculatedOrder: An order with the edits applied but not saved.

Show fields
Anchor to orderEditSessionorderEditSession •OrderEditSession: The order edit session with the edits applied but not saved.

Show fields
Anchor to userErrorsuserErrors •[OrderEditUpdateDiscountUserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

orderEditUpdateDiscount reference

Mutation Reference

mutation orderEditUpdateDiscount($discount: OrderEditAppliedDiscountInput!, $discountApplicationId: ID!, $id: ID!) {

orderEditUpdateDiscount(discount: $discount, discountApplicationId: $discountApplicationId, id: $id) {

calculatedOrder {

# CalculatedOrder fields

}

orderEditSession {

# OrderEditSession fields

}

userErrors {

field

message

}

Input

{

"discount": {

"description": "<your-description>",

"fixedValue": {

"amount": "29.99",

"currencyCode": "AED"

"percentValue": 1.1

"discountApplicationId": "gid://shopify/<objectName>/10079785100",

"id": "gid://shopify/CalculatedOrder/10079785100"

}

Variables

{
  "discount": {
    "description": "<your-description>",
    "fixedValue": {
      "amount": "29.99",
      "currencyCode": "AED"
    },
    "percentValue": 1.1
  },
  "discountApplicationId": "gid://shopify/<objectName>/10079785100",
  "id": "gid://shopify/CalculatedOrder/10079785100"
}

Schema

input OrderEditAppliedDiscountInput {
  description: String
  fixedValue: MoneyInput
  percentValue: Float
}

input MoneyInput {
  amount: Decimal!
  currencyCode: CurrencyCode!
}