orderEditAddManualOrderDiscount

mutation

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

Adds a manual order-level discount during an order edit session.

The discount is allocated across all line items. The changes remain staged until committed with the orderEditCommit mutation.

If the edit already has a staged manual order-level discount, this replaces it. If the order already has an active manual order-level discount, remove it with orderEditRemoveDiscount first.

To change or remove the discount later in the edit, use orderEditUpdateDiscount or orderEditRemoveDiscount.

Anchor to Arguments

Arguments

Anchor to discountdiscount

•OrderEditAppliedDiscountInput!

required

The manual order-level discount to add.

Show input fields

Anchor to idid

•ID!

required

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

Was this section helpful?

Anchor to OrderEditAddManualOrderDiscountPayload returnsOrderEditAddManualOrderDiscountPayload returns

Anchor to addedManualDiscountStagedChangeaddedManualDiscountStagedChange •OrderStagedChangeAddManualDiscount: The staged change recording the manual order-level discount.

Show fields
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 •[UserError!]! non-null: The list of errors that occurred from executing the mutation.

Show fields

Was this section helpful?

Examples

orderEditAddManualOrderDiscount reference

Mutation Reference

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

orderEditAddManualOrderDiscount(discount: $discount, id: $id) {

addedManualDiscountStagedChange {

# OrderStagedChangeAddManualDiscount fields

}

calculatedOrder {

# CalculatedOrder fields

}

orderEditSession {

# OrderEditSession fields

}

userErrors {

field

message

}

Input

{

"discount": {

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

"fixedValue": {

"amount": "29.99",

"currencyCode": "AED"

"percentValue": 1.1

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

}

Variables

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

Schema

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

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