Skip to main content
Anchor to orderEditRemoveDiscount

orderEditRemoveDiscount

mutation

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

Removes a 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 Arguments

Arguments

Anchor to discountApplicationIddiscountApplicationId
•ID!
required

The ID of the calculated discount application to remove.

Anchor to idid
•ID!
required

The ID of the calculated order from which to remove the discount.

Was this section helpful?

Anchor to OrderEditRemoveDiscountPayload returnsOrderEditRemoveDiscountPayload returns

Anchor to calculatedOrdercalculatedOrder
•CalculatedOrder

An order with the edits applied but not saved.

Anchor to userErrorsuserErrors
•[OrderEditRemoveDiscountUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?