orderEditUpdateDiscount

Updates a manual line level discount on the current order edit. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Use it in a workflow

Add a step and choose the Shopify connector.
Pick the orderEditUpdateDiscount action (under Order).
Fill in the fields below, then reference the result from later steps as {{ordereditupdatediscount.response.data}}.

Query

This is the mutation the action sends by default. Edit it in the step's Query field to change which fields come back.

graphql

mutation OrderEditUpdateDiscount($id: ID!, $discount: OrderEditAppliedDiscountInput!, $discountApplicationId: ID!) {
  orderEditUpdateDiscount(
    id: $id
    discount: $discount
    discountApplicationId: $discountApplicationId
  ) {
    calculatedOrder {
      cartDiscountAmountSet {
        presentmentMoney
        shopMoney
      }
      committed
      id
      notificationPreviewHtml
      notificationPreviewTitle
      originalOrder {
        additionalFees
        alerts
        app
        attribution
        billingAddress
        billingAddressMatchesShippingAddress
        canMarkAsPaid
        canNotifyCustomer
        cancelReason
        cancellation
        cancelledAt
        capturable
        cartDiscountAmount
        cartDiscountAmountSet
        cartToken
        channel
        channelInformation
        checkoutToken
        clientIp
        closed
        closedAt
        confirmationNumber
        confirmed
        createdAt
        currencyCode
        currentCartDiscountAmountSet
        currentShippingPriceSet
        currentSubtotalLineItemsQuantity
        currentSubtotalPriceSet
        currentTaxLines
        currentTotalAdditionalFeesSet
        currentTotalDiscountsSet
        currentTotalDutiesSet
        currentTotalPriceSet
        currentTotalTaxSet
        currentTotalWeight
        customAttributes
        customer
        customerAcceptsMarketing
        customerJourney
        customerJourneySummary
        customerLocale
        discountCode
        discountCodes
        displayAddress
        displayFinancialStatus
        displayFulfillmentStatus
        disputes
        dutiesIncluded
        edited
        email
        estimatedTaxes
        fulfillable
        fulfillmentsCount
        fullyPaid
        hasTimelineComment
        id
        landingPageDisplayText
        landingPageUrl
        legacyResourceId
        merchantBusinessEntity
        merchantEditable
        merchantEditableErrors
        merchantOfRecordApp
        name
        netPayment
        netPaymentSet
        note
        number
        originalTotalAdditionalFeesSet
        originalTotalDutiesSet
        originalTotalPriceSet
        paymentCollectionDetails
        paymentGatewayNames
        paymentTerms
        phone
        physicalLocation
        poNumber
        presentmentCurrencyCode
        processedAt
        productNetwork
        publication
        purchasingEntity
        referralCode
        referrerDisplayText
        referrerUrl
        refundDiscrepancySet
        refundable
        registeredSourceUrl
        requiresShipping
        restockable
        retailLocation
        returnStatus
        risk
        riskLevel
        shippingAddress
        shippingLine
        shopifyProtect
        sourceIdentifier
        sourceName
        staffMember
        subtotalLineItemsQuantity
        subtotalPrice
        subtotalPriceSet
        tags
        taxExempt
        taxLines
        taxesIncluded
        test
        totalCapturable
        totalCapturableSet
        totalCashRoundingAdjustment
        totalDiscounts
        totalDiscountsSet
        totalOutstandingSet
        totalPrice
        totalPriceSet
        totalReceived
        totalReceivedSet
        totalRefunded
        totalRefundedSet
        totalRefundedShippingSet
        totalShippingPrice
        totalShippingPriceSet
        totalTax
        totalTaxSet
        totalTipReceived
        totalTipReceivedSet
        totalWeight
        transactionsCount
        unpaid
        updatedAt
      }
      shippingLines {
        id
        price
        stagedStatus
        title
      }
      subtotalLineItemsQuantity
      subtotalPriceSet {
        presentmentMoney
        shopMoney
      }
      taxLines {
        channelLiable
        price
        priceSet
        rate
        ratePercentage
        source
        title
      }
      totalOutstandingSet {
        presentmentMoney
        shopMoney
      }
      totalPriceSet {
        presentmentMoney
        shopMoney
      }
    }
    orderEditSession {
      id
    }
    userErrors {
      code
      field
      message
    }
  }
}

Variables

Pass these as a JSON object in the step's Variables field.

idstringrequired

The ID of the [calculated order](https://shopify.dev/api/admin-graphql/latest/objects/calculatedorder) or the order edit session to edit. This is the edit used to update the discount.

discountobjectrequired

The updated discount.

descriptionstring

fixedValueobject2 fields

percentValuenumber

discountApplicationIdstringrequired

The ID of the [calculated discount application](https://shopify.dev/api/admin-graphql/latest/interfaces/calculateddiscountapplication) to update.

json

{
  "id": "string",
  "discount": {
    "description": "string",
    "fixedValue": {
      "amount": "string",
      "currencyCode": "USD"
    },
    "percentValue": 0
  },
  "discountApplicationId": "string"
}

Response

Read the result with {{ordereditupdatediscount.response.data.data.orderEditUpdateDiscount}}. If the API returns errors, the step fails and they are at {{ordereditupdatediscount.response.data.errors}}.

calculatedOrderobject

cartDiscountAmountSetobject2 fields

committedboolean

idstring

notificationPreviewHtmlstring

notificationPreviewTitlestring

originalOrderobject40 fields

shippingLinesarray<object>

subtotalLineItemsQuantitynumber

subtotalPriceSetobject2 fields

taxLinesarray<object>

totalOutstandingSetobject2 fields

totalPriceSetobject2 fields

orderEditSessionobject

idstring

userErrorsarray<object>

codeobject

fieldobject

messageobject

Need more? See the Shopify guide for connection setup and behaviour shared by every action.

Was this page helpful?