orderEditUpdateDiscount
mutation

Choose a version:

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. For more information on how to use the GraphQL Admin API to edit an existing order, refer to Edit existing orders.

Anchor to section titled 'Arguments'

Arguments

Anchor to discount discount OrderEditAppliedDiscountInput! required: The updated discount.
Anchor to discountApplicationId discountApplicationId ID! required: The ID of the calculated discount application to update.
Anchor to id id ID! required: The ID of the calculated order from which to update the discount.

Was this section helpful?

Anchor to section titled 'OrderEditUpdateDiscountPayload returns'

OrderEditUpdateDiscountPayload returns

Anchor to OrderEditUpdateDiscountPayload.calculatedOrder calculatedOrder CalculatedOrder: An order with the edits applied but not saved.
Anchor to OrderEditUpdateDiscountPayload.userErrors userErrors [OrderEditUpdateDiscountUserError!]! non-null: The list of errors that occurred from executing the mutation.

Was this section helpful?

Code examples for MUTATION: orderEditUpdateDiscount

Query Reference for MUTATION: orderEditUpdateDiscount

"mutation orderEditUpdateDiscount($discount: OrderEditAppliedDiscountInput!, $discountApplicationId: ID!, $id: ID!) {\n  orderEditUpdateDiscount(discount: $discount, discountApplicationId: $discountApplicationId, id: $id) {\n    calculatedOrder {\n      # CalculatedOrder fields\n    }\n    userErrors {\n      field\n      message\n    }\n  }\n}"

Input Reference for MUTATION: orderEditUpdateDiscount

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

Schema Reference for MUTATION: orderEditUpdateDiscount

"input OrderEditAppliedDiscountInput {\n  description: String\n  fixedValue: MoneyInput\n  percentValue: Float\n}\n\ninput MoneyInput {\n  amount: Decimal!\n  currencyCode: CurrencyCode!\n}\n"

Display Examples for MUTATION: orderEditUpdateDiscount

[]

orderEditUpdateDiscountmutation

Arguments

OrderEditUpdateDiscountPayload returns

orderEditUpdateDiscount
mutation