Anchor to section titled 'undefined'

orderEditRemoveDiscount
mutation

Requires write_order_edits access scope.

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 section titled 'Arguments'

Arguments

Anchor to discountApplicationId
discountApplicationId
ID!
required

The ID of the calculated discount application to remove.

Anchor to id
id
ID!
required

The ID of the calculated order or the order edit session to edit. This is the edit from which the discount is removed.

Was this section helpful?
Anchor to section titled 'OrderEditRemoveDiscountPayload returns'

OrderEditRemoveDiscountPayload returns

Anchor to OrderEditRemoveDiscountPayload.calculatedOrder
calculatedOrder
CalculatedOrder

An order with the edits applied but not saved.

Anchor to OrderEditRemoveDiscountPayload.orderEditSession
orderEditSession
OrderEditSession

The order edit session with the edits applied but not saved.

Anchor to OrderEditRemoveDiscountPayload.userErrors
userErrors
[OrderEditRemoveDiscountUserError!]!
non-null

The list of errors that occurred from executing the mutation.

Was this section helpful?